Description
A builder to build point geometries.
Instances of this class represent a builder that can build point geometries. Point geometries are immutable, they cannot be modified after they are created. Use builders to create new geometries either from scratch, or by using an existing geometry as a starting off point. Modifications made through the builder affect only its own internal copy of the geometry. They do not affect the original geometry.
- Since
- 100
- See also
AGSSketchEditorto construct or modify geometries interactively by sketching on a map
Instance Methods | |
| (instancetype) | - initWithPoint: |
| (instancetype) | - initWithSpatialReference: |
| (BOOL) | - isEmpty |
| (instancetype) | - offsetByX:y: |
| (instancetype) | - replaceGeometry: |
| (instancetype) | - replaceGeometry: |
| (instancetype) | - setX:y: |
| (AGSPoint *) | - toGeometry |
Class Methods | |
| (AGSGeometryBuilder *) | + builderWithGeometry: |
| (AGSGeometryBuilder *) | + builderWithGeometryType:spatialReference: |
| (instancetype) | + pointBuilderWithPoint: |
| (instancetype) | + pointBuilderWithSpatialReference: |
Properties | |
| AGSEnvelope * | extent |
| AGSGeometryType | geometryType |
| BOOL | hasCurves |
| BOOL | hasM |
| BOOL | hasZ |
| double | m |
| AGSSpatialReference * | spatialReference |
| double | x |
| double | y |
| double | z |
Method Documentation
◆ builderWithGeometry:
| + (AGSGeometryBuilder*) builderWithGeometry: | (nullable AGSGeometry *) | geometry |
Factory method to create a geometry builder from a geometry.
- Parameters
-
geometry The geometry to be used as the starting point for further modifications.
- Since
- 100
- See also
AGSGeometryBuilder::hasCurves
◆ builderWithGeometryType:spatialReference:
| + (AGSGeometryBuilder*) builderWithGeometryType: | (AGSGeometryType) | geometryType | |
| spatialReference: | (nullable AGSSpatialReference *) | sr | |
Factory method to create a geometry builder from a geometry type and spatial reference.
Prior to v100.12, only geometries without curves could be used. Passing in a geometry where AGSGeometry::hasCurves is YES would fail to replace the geometry.
From v100.12, geometries with curves are supported.
- Parameters
-
geometryType The type of geometry to be constructed. sr The spatial reference for the geometry to be constructed.
- Since
- 100
- See also
AGSGeometryBuilder::hasCurves
◆ initWithPoint:
| - (instancetype) initWithPoint: | (nullable AGSPoint *) | point |
Initializes a point builder.
- Parameters
-
point The geometry to be used as the starting point for further modifications. Can be nil.
- Since
- 100
◆ initWithSpatialReference:
| - (instancetype) initWithSpatialReference: | (nullable AGSSpatialReference *) | sr |
Initializes a builder.
- Parameters
-
sr The spatial reference for the geometry to be constructed
- Since
- 100
◆ isEmpty
| - (BOOL) isEmpty |
Indicates whether the builder's geometry is empty.
- Returns
- If the geometry is empty.
- Since
- 100
- See also
AGSGeometry::isEmpty
◆ offsetByX:y:
| - (instancetype) offsetByX: | (double) | xOffset | |
| y: | (double) | yOffset | |
Move the builder's point geometry.
- Parameters
-
xOffset offset along x-axis (negative value moves the point east) yOffset offset along y-axis (negative value moves the point south)
- Returns
- the builder so you can easily chain method calls
- Since
- 100
◆ pointBuilderWithPoint:
| + (instancetype) pointBuilderWithPoint: | (nullable AGSPoint *) | point |
Initializes a point builder.
- Parameters
-
point The geometry to be used as the starting point for further modifications. Can be nil.
- Since
- 100
◆ pointBuilderWithSpatialReference:
| + (instancetype) pointBuilderWithSpatialReference: | (nullable AGSSpatialReference *) | sr |
Initializes a builder.
- Parameters
-
sr The spatial reference for the geometry to be constructed
- Since
- 100
◆ replaceGeometry: [1/2]
| - (instancetype) replaceGeometry: | (nullable AGSGeometry *) | geometry |
Replaces the builder's geometry with the provided one.
This does not update the spatial reference of the builder. If the geometry is nil, the builder is cleared.
Prior to v100.12, only geometries without curves could be used. Passing in a geometry where AGSGeometry::hasCurves is YES would fail to replace the geometry.
From v100.12, geometries with curves are supported.
- Parameters
-
geometry The geometry object to replace with.
- Returns
- The builder so you can easily chain method calls.
- Since
- 100
◆ replaceGeometry: [2/2]
| - (instancetype) replaceGeometry: | (nullable AGSPoint *) | geometry |
Replaces the builder's geometry with the provided one.
- Parameters
-
geometry to replace with
- Returns
- the builder so you can easily chain method calls
- Since
- 100
◆ setX:y:
| - (instancetype) setX: | (double) | x | |
| y: | (double) | y | |
Update the builder's point geometry.
- Parameters
-
x The x-coordinate. y The y-coordinate.
- Returns
- The builder so you can easily chain method calls.
- Since
- 100
◆ toGeometry
| - (AGSPoint*) toGeometry |
Returns the point geometry this builder is constructing or modifying.
- Returns
- geometry
- Since
- 100
Implements AGSGeometryBuilder.
Property Documentation
◆ extent
|
readnonatomicstronginherited |
Smallest, rectangular bounding-box that covers the builder's geometry.
- Since
- 100
- See also
AGSGeometry::extent
◆ geometryType
|
readnonatomicassigninherited |
The type of geometry the builder will construct or modify.
- Since
- 100
◆ hasCurves
|
readnonatomicassigninherited |
A value indicating whether the geometry builder currently contains any curve segments.
The ArcGIS Platform supports polygon and polyline geometries that contain curve segments (where AGSSegment::curve is YES, sometimes known as true curves or nonlinear segments). Curves may be present in certain types of data - for example Mobile Map Packages (MMPKs), or geometry JSON.
Prior to v100.12, only AGSLineSegment instances were supported when creating new geometries using an AGSMultipartBuilder. Attempting to add curve geometries to an AGSMultipartBuilder would cause an error.
From v100.12, you can use curves in an AGSMultipartBuilder. New segment types AGSCubicBezierSegment and AGSEllipticArcSegment represent different types of curve that can be added to polygon and polyline geometries.
- Since
- 100.12
◆ hasM
|
readnonatomicassigninherited |
Indicates whether the builder's geometry contains m (measure) values.
- Since
- 100
- See also
AGSGeometry::hasM
◆ hasZ
|
readnonatomicassigninherited |
Indicates whether the builder's geometry contains z coordinate values.
- Since
- 100
- See also
AGSGeometry::hasZ
◆ m
|
readwritenonatomicassign |
The measure value of the builder's point geometry.
- Since
- 100
◆ spatialReference
|
readnonatomicstronginherited |
The spatial reference associated with the builder's gometry. It specifies the coordinate system for the geometry's x, y, and z coordinate values.
- Since
- 100
- Note
- Geometries that represent geographic locations should always have a spatial reference. Otherwise the coordinates of the geometry are meaningless.
- See also
AGSGeometry::spatialReference
◆ x
|
readwritenonatomicassign |
The position of the builder's point geometry along x-axis.
- Since
- 100
◆ y
|
readwritenonatomicassign |
The position of the builder's point geometry along y-axis.
- Since
- 100
◆ z
|
readwritenonatomicassign |
The position of the builder's point geometry along z-axis. Only applicable for 3D point geometries. The minimum z-value is -6,356,752 meters, which is the approximate radius of the earth (the WGS 84 datum semi-minor axis). The maximum z-value is 55,000,000 meters.
- Since
- 100
