AGSLineSegment Class Reference
Description
A line segment.
Instances of this class represents a line segment. A line segment is a pair of start and end points.
- Since
- 100
Inheritance diagram for AGSLineSegment:
Instance Methods | |
| (instancetype) | - initWithStartPoint:angle:length: |
| (instancetype) | - initWithStartPoint:endPoint: |
| (instancetype) | - initWithStartPoint:endPoint:spatialReference: |
| (instancetype) | - initWithXStart:yStart:xEnd:yEnd: |
| (instancetype) | - initWithXStart:yStart:xEnd:yEnd:spatialReference: |
| (instancetype) | - initWithXStart:yStart:zStart:xEnd:yEnd:zEnd: |
| (instancetype) | - initWithXStart:yStart:zStart:xEnd:yEnd:zEnd:spatialReference: |
| (BOOL) | - isEqualToSegment: |
Class Methods | |
| (instancetype) | + lineSegmentWithStartPoint:angle:length: |
| (instancetype) | + lineSegmentWithStartPoint:endPoint: |
| (instancetype) | + lineSegmentWithStartPoint:endPoint:spatialReference: |
| (instancetype) | + lineSegmentWithXStart:yStart:xEnd:yEnd: |
| (instancetype) | + lineSegmentWithXStart:yStart:xEnd:yEnd:spatialReference: |
| (instancetype) | + lineSegmentWithXStart:yStart:zStart:xEnd:yEnd:zEnd: |
| (instancetype) | + lineSegmentWithXStart:yStart:zStart:xEnd:yEnd:zEnd:spatialReference: |
Properties | |
| BOOL | closed |
| AGSPoint * | endPoint |
| AGSSpatialReference * | spatialReference |
| AGSPoint * | startPoint |
Method Documentation
§ initWithStartPoint:angle:length:()
| - (instancetype) initWithStartPoint: | (AGSPoint *) | startPoint | |
| angle: | (double) | angle | |
| length: | (double) | length | |
Initializes a line segment with the provided start point, angle and length.
- Parameters
-
startPoint The start coordinate along x-axis angle The angle in radians length The length in the unit of start point's spatial reference
- Since
- 100
§ initWithStartPoint:endPoint:()
Initializes a line segment with the provided start and end points.
- Parameters
-
startPoint The start point endPoint The end point
- Since
- 100
§ initWithStartPoint:endPoint:spatialReference:()
| - (instancetype) initWithStartPoint: | (AGSPoint *) | startPoint | |
| endPoint: | (AGSPoint *) | endPoint | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided spatial reference, start and end points.
- Parameters
-
startPoint The start point endPoint The end point spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
§ initWithXStart:yStart:xEnd:yEnd:()
| - (instancetype) initWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
Initializes a line segment with the provided coordinate values.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis
- Since
- 100
§ initWithXStart:yStart:xEnd:yEnd:spatialReference:()
| - (instancetype) initWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided coordinate values and spatial reference.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
§ initWithXStart:yStart:zStart:xEnd:yEnd:zEnd:()
| - (instancetype) initWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| zStart: | (double) | zStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| zEnd: | (double) | zEnd | |
Initializes a line segment with the provided coordinate values.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis zStart The start coordinate along z-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis zEnd The end coordinate along z-axis
- Since
- 100
§ initWithXStart:yStart:zStart:xEnd:yEnd:zEnd:spatialReference:()
| - (instancetype) initWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| zStart: | (double) | zStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| zEnd: | (double) | zEnd | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided coordinate values and spatial reference.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis zStart The start coordinate along z-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis zEnd The end coordinate along z-axis spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
§ isEqualToSegment:()
| - (BOOL) isEqualToSegment: | (AGSSegment *) | other |
Determines whether or not two time segments are equal.
- Parameters
-
other The segment to compare the current segment with.
- Since
- 100
§ lineSegmentWithStartPoint:angle:length:()
| + (instancetype) lineSegmentWithStartPoint: | (AGSPoint *) | startPoint | |
| angle: | (double) | angle | |
| length: | (double) | length | |
Initializes a line segment with the provided start point, angle and length.
- Parameters
-
startPoint The start coordinate along x-axis angle The angle in radians length The length in the unit of start point's spatial reference
- Since
- 100
§ lineSegmentWithStartPoint:endPoint:()
Initializes a line segment with the provided start and end points.
- Parameters
-
startPoint The start point endPoint The end point
- Since
- 100
§ lineSegmentWithStartPoint:endPoint:spatialReference:()
| + (instancetype) lineSegmentWithStartPoint: | (AGSPoint *) | startPoint | |
| endPoint: | (AGSPoint *) | endPoint | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided spatial reference, start and end points.
- Parameters
-
startPoint The start point endPoint The end point spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
§ lineSegmentWithXStart:yStart:xEnd:yEnd:()
| + (instancetype) lineSegmentWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
Initializes a line segment with the provided coordinate values.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis
- Since
- 100
§ lineSegmentWithXStart:yStart:xEnd:yEnd:spatialReference:()
| + (instancetype) lineSegmentWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided coordinate values.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
§ lineSegmentWithXStart:yStart:zStart:xEnd:yEnd:zEnd:()
| + (instancetype) lineSegmentWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| zStart: | (double) | zStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| zEnd: | (double) | zEnd | |
Initializes a line segment with the provided coordinate values.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis zStart The start coordinate along z-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis zEnd The end coordinate along z-axis
- Since
- 100
§ lineSegmentWithXStart:yStart:zStart:xEnd:yEnd:zEnd:spatialReference:()
| + (instancetype) lineSegmentWithXStart: | (double) | xStart | |
| yStart: | (double) | yStart | |
| zStart: | (double) | zStart | |
| xEnd: | (double) | xEnd | |
| yEnd: | (double) | yEnd | |
| zEnd: | (double) | zEnd | |
| spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes a line segment with the provided coordinate values and spatial reference.
- Parameters
-
xStart The start coordinate along x-axis yStart The start coordinate along y-axis zStart The start coordinate along z-axis xEnd The end coordinate along x-axis yEnd The end coordinate along y-axis zEnd The end coordinate along z-axis spatialReference The spatial reference for the line segment to be constructed
- Since
- 100
Property Documentation
§ closed
|
readnonatomicassigninherited |
Determines whether the segment is closed or not.
- Since
- 100
§ endPoint
|
readnonatomicstronginherited |
The end point of the segment.
- Since
- 100
§ spatialReference
|
readnonatomicstronginherited |
The spatial reference of the segment.
- Since
- 100
§ startPoint
|
readnonatomicstronginherited |
The start point of the segment.
- Since
- 100
