Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISPoint
Since: 1.0.0
Inheritance: ArcGISGeometry->ArcGISPoint
Summary
A location defined by x and y (and optionally z) coordinates.
Constructors
ArcGISPoint(double, double, double, const ArcGISSpatialReference&)
Creates a point with an x, y, z and spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
z | No | The z-coordinate for the point. | |
spatial | Yes | The spatial reference for the point. |
ArcGISPoint(double, double, const ArcGISSpatialReference&)
Creates a point with an x, y and a spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
spatial | Yes | The spatial reference for the point. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | An optional coordinate to define a measure value for the point. | ||
No | Yes | The x-coordinate for the point. | ||
No | Yes | The y-coordinate for the point. | ||
No | Yes | The z-coordinate for the point. |
M
double GetM() const
An optional coordinate to define a measure value for the point.
M-values are used in linear referencing scenarios and may represent things like mile markers along a highway. Like z-values, every geometry can optionally store m-values with the point coordinates that comprise it. The default m-value is NaN. If an m-value is specified when a geometry is created, the new geometry has m-values (ArcGISGeometry::HasM is true). Note that when you get m-values back from a geometry, the default value of NAN is returned for vertices that do not have m-values. A geometry with m-values is sometimes known as an m-aware geometry.
Z
double GetZ() const
The z-coordinate for the point.
Geometries can have z-values, indicating values along the z-axis, which is perpendicular to both the x-axis and y-axis. Z-values indicate height above or depth below a surface, or an absolute elevation. Z-values are stored on ArcGISPoint and ArcGISEnvelope. Since ArcGISMultipoint, ArcGISPolyline, and ArcGISPolygon are created from a collection of ArcGISPoint, all types of geometry can have z-values.
Whether or not a geometry has z-values is determined when the geometry is created; if you use a method that has a z-value parameter, the new geometry has z-values (ArcGISGeometry::HasZ is true). If you create geometries using constructors that take z-value parameters, or if you pass points or segments that have z-values into the constructor, the new geometry has z-values. A ArcGISGeometry with z-values is sometimes known as a z-aware geometry.
It may be that not all vertices in your geometry have a z-value defined. NAN is a valid z-value used to indicate an unknown z-value. However, the default z-value is 0. When you get z-values from a geometry that does not have z-values, the default is 0. Check the ArcGISGeometry::HasZ to determine whether a z-value of 0 means that there are no z-values in the geometry or that the z-value in the geometry's coordinates really is 0.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Creates a point with an x,y coordinates and m-value and a null spatial reference. | ||
Creates a point with an x, y, z coordinates and m-value. | ||
CreateWithM(double, double, double, double, const ArcGISSpatialReference&) | Creates a point with an x, y, z, m and a spatial reference. | |
CreateWithM(double, double, double, const ArcGISSpatialReference&) | Creates a point with an x, y, m and spatial reference. |
CreateWithM
static ArcGISPoint CreateWithM(double x, double y, double m)
Creates a point with an x,y coordinates and m-value and a null spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
m | No | The m-value for the point. |
Returns ArcGISPoint
A point. This is passed to geometry or point functions.
CreateWithM
static ArcGISPoint CreateWithM(double x, double y, double z, double m)
Creates a point with an x, y, z coordinates and m-value.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
z | No | The z-coordinate for the point. | |
m | No | The m-value for the point. |
Returns ArcGISPoint
A point. This is passed to geometry or point functions.
CreateWithM
static ArcGISPoint CreateWithM(double x, double y, double z, double m, const ArcGISSpatialReference& spatialReference)
Creates a point with an x, y, z, m and a spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
z | No | The z-coordinate for the point. | |
m | No | The m-value for the point. | |
spatial | Yes | The spatial reference for the point. |
Returns ArcGISPoint
A point. This is passed to geometry or point functions.
CreateWithM
static ArcGISPoint CreateWithM(double x, double y, double m, const ArcGISSpatialReference& spatialReference)
Creates a point with an x, y, m and spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate for the point. | |
y | No | The y-coordinate for the point. | |
m | No | The m-value for the point. | |
spatial | Yes | The spatial reference for the point. |
Returns ArcGISPoint
A point. This is passed to geometry or point functions.