Represents a straight line between a start and end point. More...
| Header: | #include <LineSegment.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::Segment |
Public Functions
| LineSegment() | |
| LineSegment(const Esri::ArcGISRuntime::Point &startPoint, const Esri::ArcGISRuntime::Point &endPoint) | |
| LineSegment(const Esri::ArcGISRuntime::Point &startPoint, const Esri::ArcGISRuntime::Point &endPoint, const Esri::ArcGISRuntime::SpatialReference &spatialReference) | |
| LineSegment(double xStart, double yStart, double xEnd, double yEnd) | |
| LineSegment(double xStart, double yStart, double xEnd, double yEnd, const Esri::ArcGISRuntime::SpatialReference &spatialReference) | |
| LineSegment(double xStart, double yStart, double zStart, double xEnd, double yEnd, double zEnd) | |
| LineSegment(double xStart, double yStart, double zStart, double xEnd, double yEnd, double zEnd, const Esri::ArcGISRuntime::SpatialReference &spatialReference) | |
| LineSegment(const Esri::ArcGISRuntime::LineSegment &other) | |
| LineSegment(const Esri::ArcGISRuntime::Segment &other) | |
| LineSegment(Esri::ArcGISRuntime::LineSegment &&other) | |
| ~LineSegment() | |
| Esri::ArcGISRuntime::LineSegment & | operator=(const Esri::ArcGISRuntime::LineSegment &other) |
| Esri::ArcGISRuntime::LineSegment & | operator=(Esri::ArcGISRuntime::LineSegment &&other) |
Static Public Members
| Esri::ArcGISRuntime::LineSegment | createLineAtAngleFromStartPoint(const Esri::ArcGISRuntime::Point &startPoint, double angleRadians, double length) |
Detailed Description
Use this method to create a line segment representing a straight line between two points. LineSegments are used to represent the edges of Polygons and Polylines.
LineSegment is immutable. Create new instances by using the constructors and factory methods, instead of changing the properties of an existing LineSegment.
Member Function Documentation
LineSegment::LineSegment ()
Default constructor.
A default constructed LineSegment should not be used. This constructor is provided for convenience only.
See also isEmpty.
LineSegment::LineSegment (const Esri::ArcGISRuntime::Point &startPoint , const Esri::ArcGISRuntime::Point &endPoint )
Creates a line segment based on two points.
- startPoint - The start point.
- endPoint - The end point.
Use this method to create a line segment representing a straight line between two points.
If both points have a spatial reference set, they must be equal.
Returns ErrorTypeCommonInvalidArgument if the SpatialReference of both points supplied are non-null and differ.
LineSegment::LineSegment (const Esri::ArcGISRuntime::Point &startPoint , const Esri::ArcGISRuntime::Point &endPoint , const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Creates a line segment based on two points and a spatial reference.
- startPoint - The start point.
- endPoint - The end point.
- spatialReference - A spatial reference.
Use this method to create a line segment representing a straight line between two points. The spatial reference parameter is used if the points have an empty spatial reference. If more than one spatial reference is supplied (as a parameter or as a property of a Point parameter), they must all be equal.
Returns ErrorTypeCommonInvalidArgument if the SpatialReference of both points supplied are non-null and differ.
LineSegment::LineSegment (double xStart , double yStart , double xEnd , double yEnd )
Creates a line segment based on coordinates.
- xStart - The X coordinate of start point.
- yStart - The Y coordinate of start point.
- xEnd - The X coordinate of end point.
- yEnd - The Y coordinate of end point.
Use this method to create a line segment representing a straight line between two points.
LineSegment::LineSegment (double xStart , double yStart , double xEnd , double yEnd , const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Creates a line segment based on coordinates.
- xStart - The X coordinate of start point.
- yStart - The Y coordinate of start point.
- xEnd - The X coordinate of end point.
- yEnd - The Y coordinate of end point.
- spatialReference - A spatial reference.
Use this method to create a line segment representing a straight line between two points.
LineSegment::LineSegment (double xStart , double yStart , double zStart , double xEnd , double yEnd , double zEnd )
Creates a line segment based on 3D coordinates.
- xStart - The X coordinate of start point.
- yStart - The Y coordinate of start point.
- zStart - The Z coordinate of start point.
- xEnd - The X coordinate of end point.
- yEnd - The Y coordinate of end point.
- zEnd - The Z coordinate of end point.
Use this method to create a line segment representing a straight line between two points.
LineSegment::LineSegment (double xStart , double yStart , double zStart , double xEnd , double yEnd , double zEnd , const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Creates a line segment based on 3D coordinates and a spatial reference.
- xStart - The X coordinate of start point.
- yStart - The Y coordinate of start point.
- zStart - The Z coordinate of start point.
- xEnd - The X coordinate of end point.
- yEnd - The Y coordinate of end point.
- zEnd - The Z coordinate of end point.
- spatialReference - A spatial reference.
Use this method to create a line segment representing a straight line between two points.
LineSegment::LineSegment (const Esri::ArcGISRuntime::LineSegment &other)
Copy constructor from other LineSegment.
[explicit, since Esri::ArcGISRuntime 100.12] LineSegment::LineSegment (const Esri::ArcGISRuntime::Segment &other)
Copy constructor from other Segment.
This function was introduced in Esri::ArcGISRuntime 100.12.
LineSegment::LineSegment (Esri::ArcGISRuntime::LineSegment &&other)
Move constructor from other LineSegment.
LineSegment::~LineSegment ()
Destructor.
[static] Esri::ArcGISRuntime::LineSegment LineSegment::createLineAtAngleFromStartPoint (const Esri::ArcGISRuntime::Point &startPoint , double angleRadians , double length)
Factory method to create a LineSegment from a startPoint, angleRadians, and a length.
Esri::ArcGISRuntime::LineSegment &LineSegment::operator=(const Esri::ArcGISRuntime::LineSegment &other)
Assignment operator from other LineSegment.
Esri::ArcGISRuntime::LineSegment &LineSegment::operator=(Esri::ArcGISRuntime::LineSegment &&other)
Move operator from other LineSegment.