ArcGISLineSegment

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISLineSegment
Since: 1.0.0
Inheritance: ArcGISSegment->ArcGISLineSegment

Summary

A line segment represents a straight line from its start to end point. It is derived from a segment object.

Constructors

ArcGISLineSegment(double, double, double, double)

Creates a line segment based on coordinates.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xStart`	`double`	`No`	The X coordinate of start point.
`yStart`	`double`	`No`	The Y coordinate of start point.
`xEnd`	`double`	`No`	The X coordinate of end point.
`yEnd`	`double`	`No`	The Y coordinate of end point.

ArcGISLineSegment(double, double, double, double, double, double)

Creates a line segment based on 3D coordinates.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xStart`	`double`	`No`	The X coordinate of start point.
`yStart`	`double`	`No`	The Y coordinate of start point.
`zStart`	`double`	`No`	The Z coordinate of start point.
`xEnd`	`double`	`No`	The X coordinate of end point.
`yEnd`	`double`	`No`	The Y coordinate of end point.
`zEnd`	`double`	`No`	The Z coordinate of end point.

ArcGISLineSegment(double, double, double, double, double, double, const ArcGISSpatialReference&)

Creates a line segment based on 3D coordinates and a spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xStart`	`double`	`No`	The X coordinate of start point.
`yStart`	`double`	`No`	The Y coordinate of start point.
`zStart`	`double`	`No`	The Z coordinate of start point.
`xEnd`	`double`	`No`	The X coordinate of end point.
`yEnd`	`double`	`No`	The Y coordinate of end point.
`zEnd`	`double`	`No`	The Z coordinate of end point.
`spatialReference`	`ArcGISSpatialReference`	`Yes`	A spatial reference.

ArcGISLineSegment(double, double, double, double, const ArcGISSpatialReference&)

Creates a line segment based on coordinates.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`xStart`	`double`	`No`	The X coordinate of start point.
`yStart`	`double`	`No`	The Y coordinate of start point.
`xEnd`	`double`	`No`	The X coordinate of end point.
`yEnd`	`double`	`No`	The Y coordinate of end point.
`spatialReference`	`ArcGISSpatialReference`	`Yes`	A spatial reference.

ArcGISLineSegment(const ArcGISPoint&, const ArcGISPoint&)

Creates a line segment based on two points.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`startPoint`	`ArcGISPoint`	`Yes`	The start point.
`endPoint`	`ArcGISPoint`	`Yes`	The end point.

ArcGISLineSegment(const ArcGISPoint&, const ArcGISPoint&, const ArcGISSpatialReference&)

Creates a line segment based on two points and a spatial reference.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`startPoint`	`ArcGISPoint`	`Yes`	The start point.
`endPoint`	`ArcGISPoint`	`Yes`	The end point.
`spatialReference`	`ArcGISSpatialReference`	`Yes`	A spatial reference.

Methods

Signature	Return Type	Summary
CreateLineAtAngleFromStartPoint(const ArcGISPoint&, double, double)	ArcGISLineSegment	Creates a line segment of the specified length and angle from a given start point.

CreateLineAtAngleFromStartPoint

static ArcGISLineSegment CreateLineAtAngleFromStartPoint(const ArcGISPoint& startPoint, double angleRadians, double length)

Creates a line segment of the specified length and angle from a given start point.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`startPoint`	`ArcGISPoint`	`Yes`	The start point of the line segment.
`angleRadians`	`double`	`No`	The angle of the line relative to the X axis. Units are radians.
`length`	`double`	`No`	The length of the line.

Returns ArcGISLineSegment

An ArcGISLineSegment.