AGSSketchVertex Class Reference

Description

A class that represents a vertex or mid-vertex in the AGSSketchEditor.

Instances of this class represent a vertex or mid-vertex in the AGSSketchEditor. If the pointIndex is greater or equal to 0, then it's a vertex. If the insertionIndex is greater or equal to 0, then it's a mid-vertex. This object cannot have both pointIndex and insertionIndex greater or equal to 0. When the associated sketch editor is modifying a point geometry, the partIndex and pointIndex will both be 0 for a valid vertex. Mid-vertices are not allowed for a single point geometry. When the associated sketch editor is modifying a multi-point geometry, the partIndex will be 0 for a valid vertex. Mid-vertices are not allowed for a multi-point geometry.

Since

100.2

Inheritance diagram for AGSSketchVertex:

Instance Methods
(instancetype)	- initWithPartIndex:insertionIndex:
(instancetype)	- initWithPartIndex:pointIndex:

Class Methods
(instancetype)	+ sketchVertexWithPartIndex:insertionIndex:
(instancetype)	+ sketchVertexWithPartIndex:pointIndex:

Properties
NSInteger	insertionIndex
NSInteger	partIndex
AGSPoint *	point
NSInteger	pointIndex

Method Documentation

initWithPartIndex:insertionIndex:

- (instancetype) initWithPartIndex:		(NSInteger)	partIndex
insertionIndex:		(NSInteger)	insertionIndex

Initializes a mid-vertex for a given part index and insertion index. When using this initializer the vertex object represents a mid-vertex which doesn't have a representation in the sketch editor's geometry.

Parameters

partIndex	The index of the part in the sketch editor's geometry to which this vertex can be found.
insertionIndex	The point index at which a vertex would be inserted if this mid-vertex were to be turned into an actual vertex.

Since

100.2

initWithPartIndex:pointIndex:

- (instancetype) initWithPartIndex:		(NSInteger)	partIndex
pointIndex:		(NSInteger)	pointIndex

Initializes a vertex for a given part index and point index in the sketch editor's geometry.

Parameters

partIndex	The index of the part in the sketch editor's geometry to which this vertex can be found.
pointIndex	The index of the point in the sketch editor's geometry to which this vertex can be found.

Since

100.2

sketchVertexWithPartIndex:insertionIndex:

+ (instancetype) sketchVertexWithPartIndex:		(NSInteger)	partIndex
insertionIndex:		(NSInteger)	insertionIndex

Initializes a mid-vertex for a given part index and insertion index. When using this initializer the vertex object represents a mid-vertex which doesn't have a representation in the sketch editor's geometry.

Parameters

partIndex	The index of the part in the sketch editor's geometry to which this vertex can be found.
insertionIndex	The point index at which a vertex would be inserted if this mid-vertex were to be turned into an actual vertex.

Since

100.2

sketchVertexWithPartIndex:pointIndex:

+ (instancetype) sketchVertexWithPartIndex:		(NSInteger)	partIndex
pointIndex:		(NSInteger)	pointIndex

Initializes a vertex for a given part index and point index in the sketch editor's geometry.

Parameters

partIndex	The index of the part in the sketch editor's geometry to which this vertex can be found.
pointIndex	The index of the point in the sketch editor's geometry to which this vertex can be found.

Since

100.2

Property Documentation

insertionIndex

- (NSInteger) insertionIndex

readnonatomicassign

The point index at which a vertex would be inserted if this mid-vertex were to be turned into an actual vertex. This will return -1 if this vertex is a real vertex and not a mid-vertex

Since

100.2

partIndex

- (NSInteger) partIndex

readnonatomicassign

The index of the part in the sketch editor's geometry to which this vertex can be found.

Since

100.2

point

- (AGSPoint*) point

readnonatomicstrong

The actual point geometry that this vertex can be found on the map. This property is null until the vertex is bound to the sketch editor via selection.

Since

100.2

pointIndex

- (NSInteger) pointIndex

readnonatomicassign

The index of the point in the sketch editor's geometry to which this vertex can be found. This will return -1 if this vertex is a mid-vertex.

Since

100.2