Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISMutablePointCollection
Since: 1.0.0

Summary

A collection object that can be changed containing points.

Constructors

ArcGISMutablePointCollection(const ArcGISSpatialReference&)

Creates a mutable point collection with a specified spatial reference.

Since 1.0.0

Arguments
NameTypeConstSummary
spatialReference
Yes

A spatial reference object, can be null.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

Indicates if the mutable point collection contains no points.

No
Yes

The number of points in the collection.

Yes
No

The spatial reference for the mutable point collection.

IsEmpty

bool GetIsEmpty() const

Indicates if the mutable point collection contains no points.

Size

size_t GetSize() const

The number of points in the collection.

SpatialReference

ArcGISSpatialReference GetSpatialReference() const

The spatial reference for the mutable point collection.

If the collection does not have a spatial reference null is returned.

Methods

SignatureReturn TypeSummary

Add a new point to the end of the mutable point collection by specifying the points x,y coordinates.

Add a new point to the end of the mutable point collection by specifying the points x,y,z coordinates.

Add a new point to the end of the mutable point collection.

Add a new points to the end of the mutable point collection.

Add a new points to the end of the mutable point collection.

Returns a point at the specified index in the collection.

Retrieves the position of the point in the mutable point collection. The first point that is equal to the supplied point is returned.

Inserts a point specified by its x,y coordinates into the mutable point collection at the specified point index.

Inserts a point specified by its x,y,z coordinate into the mutable point collection at the specified point index.

Inserts a point into the mutable point collection at the specified point index.

Remove all points from the mutable point collection.

Removes a point from the mutable point collection.

Replace a point in the mutable point collection at the specified point index.

AddPoint

size_t AddPoint(double x, double y)

Add a new point to the end of the mutable point collection by specifying the points x,y coordinates.

Since 1.0.0

Arguments
NameTypeConstSummary
x
No

The x-coordinate of the new point.

y
No

The y-coordinate of the new point.

Returns size_t

the point index where the point was added. If an error occurred, then -1 is returned.

AddPoint

size_t AddPoint(double x, double y, double z)

Add a new point to the end of the mutable point collection by specifying the points x,y,z coordinates.

Since 1.0.0

Arguments
NameTypeConstSummary
x
No

The x-coordinate of the new point.

y
No

The y-coordinate of the new point.

z
No

The z coordinate of the new point.

Returns size_t

the point index where the point was added. If an error occurred, then -1 is returned.

AddPoint

size_t AddPoint(const ArcGISPoint& point)

Add a new point to the end of the mutable point collection.

Since 1.0.0

Arguments
NameTypeConstSummary
point
Yes

The point to add.

Returns size_t

the point index where the point was added. If an error occurred, then -1 is returned.

AddPoints

void AddPoints(const ArcGISImmutablePointCollection& points)

Add a new points to the end of the mutable point collection.

Since 1.0.0

Arguments
NameTypeConstSummary
points
Yes

The new points to add.

Returns void

AddPoints

void AddPoints(const ArcGISMutablePointCollection& points)

Add a new points to the end of the mutable point collection.

Since 1.0.0

Arguments
NameTypeConstSummary
points
Yes

The new points to add.

Returns void

GetPoint

ArcGISPoint GetPoint(size_t index) const

Returns a point at the specified index in the collection.

Since 1.0.0

Arguments
NameTypeConstSummary
index
No

The position in the collection.

Returns ArcGISPoint

The point at the specified position in the collection.

IndexOf

size_t IndexOf(const ArcGISPoint& point) const

Retrieves the position of the point in the mutable point collection. The first point that is equal to the supplied point is returned.

Since 1.0.0

Arguments
NameTypeConstSummary
point
Yes

The point to find.

Returns size_t

The position of the point in the collection, -1 otherwise.

InsertPoint

void InsertPoint(size_t pointIndex, double x, double y)

Inserts a point specified by its x,y coordinates into the mutable point collection at the specified point index.

Since 1.0.0

Arguments
NameTypeConstSummary
pointIndex
No

Zero-based index of the point.

x
No

The x-coordinate of the new point.

y
No

The y-coordinate of the new point.

Returns void

InsertPoint

void InsertPoint(size_t pointIndex, double x, double y, double z)

Inserts a point specified by its x,y,z coordinate into the mutable point collection at the specified point index.

Since 1.0.0

Arguments
NameTypeConstSummary
pointIndex
No

Zero-based index of the point.

x
No

The x-coordinate of the new point.

y
No

The y-coordinate of the new point.

z
No

The z-coordinate of the new point.

Returns void

InsertPoint

void InsertPoint(size_t pointIndex, const ArcGISPoint& point)

Inserts a point into the mutable point collection at the specified point index.

Since 1.0.0

Arguments
NameTypeConstSummary
pointIndex
No

Zero-based index of the point.

point
Yes

The point to insert.

Returns void

RemoveAll

void RemoveAll()

Remove all points from the mutable point collection.

Since 1.0.0

Returns void

RemovePoint

void RemovePoint(size_t pointIndex)

Removes a point from the mutable point collection.

Since 1.0.0

Arguments
NameTypeConstSummary
pointIndex
No

Zero-based index of the point.

Returns void

SetPoint

void SetPoint(size_t pointIndex, const ArcGISPoint& point)

Replace a point in the mutable point collection at the specified point index.

Since 1.0.0

Arguments
NameTypeConstSummary
pointIndex
No

Zero-based index of the point.

point
Yes

The point.

Returns void