Namespace: Esri::GameEngine::Layers::PointCloud
Class: Esri/GameEngine/Layers/PointCloud/ArcGISPointCloudColorStopCollection
Since: 2.4.0
Summary
Defines an collection of ArcGISPointCloudColorStop.
Constructors
ArcGISPointCloudColorStopCollection()
Creates a vector. This allocates memory that must be deleted.
Since 2.4.0
Properties
Size
size_t GetSize() const
The number of values in the vector.
If an error occurs, 0 will be returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Add(const ArcGISPointCloudColorStop&) | Add a value to the vector. | |
AddArray(const ArcGISCollection<ArcGISPointCloudColorStop>&) | Appends a vector to a vector. | |
Get a value at a specific position. | ||
Contains(const ArcGISPointCloudColorStop&) | Indicates if the vector contains the given value. | |
Equals(const ArcGISCollection<ArcGISPointCloudColorStop>&) | Determines if two vectors are equal. | |
First() | Get the first value in the vector. | |
IndexOf(const ArcGISPointCloudColorStop&) | Finds the position of the given value in the vector. | |
Insert(size_t, const ArcGISPointCloudColorStop&) | Insert the provided value at the specified position in the vector. | |
IsEmpty() | Determines if there are any values in the vector. | |
Last() | Get the last value in the vector. | |
Move a value from the current position to a new position in the vector. | ||
Npos() | Returns a value indicating a bad position within the vector. | |
Remove the value at a specific position in the vector. | ||
Remove all values from the vector. |
Add
size_t Add(const ArcGISPointCloudColorStop& value)
Add a value to the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | ArcGISPointCloudColorStop | Yes | The value that is to be added. |
Returns size_t
The position of the value. Max value of size_t if an error occurs.
AddArray
size_t AddArray(const ArcGISCollection<ArcGISPointCloudColorStop>& vector2)
Appends a vector to a vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
vector2 | ArcGISCollection<ArcGISPointCloudColorStop> | Yes | The value that is to be added. |
Returns size_t
The new size of vector_1. Max value of size_t if an error occurs.
At
ArcGISPointCloudColorStop At(size_t position) const
Get a value at a specific position.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position which you want to get the value. |
Returns ArcGISPointCloudColorStop
A ArcGISPointCloudColorStop that represents the value at the specified position.
Contains
bool Contains(const ArcGISPointCloudColorStop& value) const
Indicates if the vector contains the given value.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | ArcGISPointCloudColorStop | Yes | The value you want to find. |
Returns bool
True if the value is in the vector, otherwise false.
Equals
bool Equals(const ArcGISCollection<ArcGISPointCloudColorStop>& vector2) const
Determines if two vectors are equal.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
vector2 | ArcGISCollection<ArcGISPointCloudColorStop> | Yes | The second vector. |
Returns bool
True if the two vectors are equal, otherwise false.
First
ArcGISPointCloudColorStop First() const
Get the first value in the vector.
Since 2.4.0
Returns ArcGISPointCloudColorStop
A ArcGISPointCloudColorStop representing the value at the specified position.
IndexOf
size_t IndexOf(const ArcGISPointCloudColorStop& value) const
Finds the position of the given value in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | ArcGISPointCloudColorStop | Yes | The value you want to find. |
Returns size_t
The position of the value in the vector, Max value of size_t otherwise.
Insert
void Insert(size_t position, const ArcGISPointCloudColorStop& value)
Insert the provided value at the specified position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position at which to insert the given value. |
value | ArcGISPointCloudColorStop | Yes | The value to add. |
Returns void
IsEmpty
bool IsEmpty() const
Determines if there are any values in the vector.
Since 2.4.0
Returns bool
True if the vector object contains no values, otherwise false. Returns true if an error occurs.
Last
ArcGISPointCloudColorStop Last() const
Get the last value in the vector.
Since 2.4.0
Returns ArcGISPointCloudColorStop
A ArcGISPointCloudColorStop representing the value at the specified position.
Move
Move a value from the current position to a new position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
old | size_t | No | The current position of the value. |
new | size_t | No | The position to which you want to move the value. |
Returns void
Npos
static size_t Npos()
Returns a value indicating a bad position within the vector.
Since 2.4.0
Returns size_t
A size_t.
Remove
Remove the value at a specific position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position where you want to remove the value. |