Provides script language access to C++ objects of this type.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AcquireNode | Transfers ownership of a <Node> from the source <NodeBuffer> to this <NodeBuffer>. The owning pointer in the source <NodeBuffer> is replaced with a nullptr, and the overall memory layout of the source <NodeBuffer> does not change. (No deallocation occurs inside the source <NodeBuffer> when the owning pointer is transferred.) |
| int32 | AcquireNodes | Transfers ownership of all <Node> objects from the source <NodeBuffer> to this <NodeBuffer>, provided this <NodeBuffer> contains non-owning pointers to the <Node> objects. The owning pointers in the source <NodeBuffer> are replaced with null pointers, and the non-owning pointers in hte destination are replaced with owning pointers. The overall memory layout of the source <NodeBuffer> does not change. (No deallocation occurs inside the source <NodeBuffer> when the owning pointers are transferred.) |
| int32 | Add | Adds to this <NodeBuffer> an owning pointer to the <Node>, provided this <NodeBuffer> does not already store an owning pointer to the <Node>. |
| int32 | AddIfUnique | Adds an owning pointer to the buffer if a pointer to the <Node> is not already resident. |
| int32 | AddRef | Adds to this <NodeBuffer> a non-owning pointer to the <Node>. |
| int32 | AddRefUnique | Adds a non-owning pointer to the buffer if a pointer to the <Node> is not already resident. |
| int32 | Clear | Destroys any <Node> objects owned by this <NodeBuffer> and deallocates the underlying <NodePtrArray> and <Int32Array> objects used to implement the <NodeBuffer>. Does not destroy this <NodeBuffer> object. |
| int32 | Compact | A <NodeBuffer> can contain a mix of owning pointers, non-owning pointers, and null pointers. Removes any collection indices that refer to null pointers. |
| int32 | ContainsNullPointer | Returns true if this <NodeBuffer> contains any null pointers. |
| int32 | CountIsMultipleOf | Returns true if the count is a multiple of the specified value. |
| int32 | Del | If the <NodeBuffer> owns the object at the specified index, this function destroys the object. In either case, complementary deallocations occur in the underlying <NodePtrArray> and <Int32Array> objects that implement <NodeBuffer>. |
| int32 | DelFirst | Deletes the first item in the array. Complementary deallocations occur in the underlying <NodePtrArray> and <Int32Array> objects that implement <NodeBuffer>. |
| int32 | DelLast | Deletes the last item in the array. Complementary deallocations occur in the underlying <NodePtrArray> and <Int32Array> objects that implement <NodeBuffer>. |
| int32 | Find | Returns the index of a <Node> in the <NodeBuffer> or -1 if the <Node> cannot be found. |
| <Node> | FindByGuid | Returns a pointer to the <Node> with the specified GUID or nullptr if the <Node> cannot be found in the collection. |
| <Node> | FindByName | Returns a pointer to the <Node> with the specified name or nullptr if the <Node> cannot be found in the collection. |
| int32 | FindIndexByGuid | Returns the index of the <Node> with the specified GUID or -1 if the <Node> cannot be found in the collection. |
| int32 | FindIndexByName | Returns the index of the <Node> with the specified name or -1 if the <Node> cannot be found in the collection. |
| <Node> | Get | Returns a pointer to the <Node> at the specified index or nullptr if the specified index is invalid. |
| <Node> | GetByGuid | Returns a pointer to the <Node> with the specified GUID or nullptr if the <Node> cannot be found in the collection. |
| <Node> | GetByName | Returns a pointer to the <Node> with the specified name or nullptr if the <Node> cannot be found in the collection. |
| int32 | GetCount | Returns the count of the underlying <NodePtrArray> object. |
| <Node> | GetFirst | Returns a pointer to the first <Node> in the <NodeBuffer>, or nullptr if the <NodeBuffer> is empty. |
| int32 | GetIndexByGuid | Returns the index of the <Node> with the specified GUID or -1 if the <Node> cannot be found in the collection. |
| int32 | GetIndexByName | Returns the index of the <Node> with the specified name or -1 if the <Node> cannot be found in the collection. |
| int32 | GetIndicesByType | Populates an <Int32Array> with the indices of any nodes of the specified type. |
| <Node> | GetLast | Returns a pointer to the last <Node> in the <NodeBuffer>, or nullptr if the <NodeBuffer> is empty. |
| <Node> | GetNode | Returns a pointer to the <Node> with the specified name, or nullptr if the <Node> cannot be found. |
| <Node> | GetNodeByGuid | Populates this object with pointers to <Node> objects whose GUIDs match the GUID submitted to this function. |
| <Node> | GetNodeByName | Returns a pointer to the first <Node> object in the collection that has a matching name. |
| <Node> | GetNodeByType | Returns a pointer to the first <Node> object in the collection that has a matching type. |
| <Node> | GetNodeType | Returns a pointer to the first <Node> of the specified type, or nullptr if a matching <Node> cannot be found. |
| <NodeBufferView> | GetView | Returns a pointer to a <NodeBufferView> object that contains iterators to the start and end of the collection. |
| int32 | IfOwnsIndex | Returns true if the <NodeBuffer> owns the <Node> at the specified index. |
| int32 | IfOwnsObj | Returns true if the <NodeBuffer> owns the specified <Node>. |
| int32 | In | Returns true if the <NodeBuffer> has a pointer to the <Node>. |
| int32 | Insert | Inserts a <Node> into the collection and sets an owning or non-owning relationship. This function can require a full allocation and deallocation cycle. Note that the collection does not support multiple ownership, so this function fails if the collection already has an owning pointer to the <Node>. |
| int32 | IsEmpty | Returns true if the collection is empty. |
| int32 | IsHeterogenous | Returns true if the collection contains more than one type of <Node>, with an option to allow subclasses to constitute a match. |
| int32 | IsHomogenous | Returns true if the collection contains one type of <Node>, with an option to allow subclasses to constitute a match. |
| <Node> | MakeNonOwning | Changes the pointer at the specified index from owning to non-owning and returns a pointer to the <Node>. |
| int32 | Move | Moves the collection's memory from this <NodeBuffer> to the destination <NodeBuffer>. This operation uses move semantics to avoid a copy. |
| int32 | Owns | Adds to the collection an owning pointer to specified <Node>. This can require up to a full allocation and deallocation cycle. |
| int32 | OwnsIfUnique | Adds an owning pointer to the buffer if a pointer to the <Node> is not already resident. |
| int32 | Refers | Adds to the collection a non-owning pointer to specified <Node>. This can require up to a full allocation and deallocation cycle. |
| int32 | RefersIfUnique | Adds a non-owning pointer to the buffer if a pointer to the <Node> is not already resident. |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| <Node> | RemoveAt | Removes the <Node> at the specified index from the collection, replaces its index with a nullptr, changes ownership status to non-owning, and returns a pointer to the <Node>. |
| <Node> | RemoveFirst | Removes the first <Node> from the collection, replaces its index with a nullptr, changes ownership status to non-owning, and returns a pointer to the <Node>. |
| <Node> | RemoveLast | Removes the last <Node> from the collection, replaces its index with a nullptr, changes ownership status to non-owning, and returns a pointer to the <Node>. |
| <Node> | RemoveObj | Removes the specified <Node> from the collection, replaces its index with a nullptr, changes ownership status to non-owning, and returns a pointer to the <Node>. |
| int32 | Reverse | Reverses the order of the pointers in the <NodeBuffer> from last to first. |
| int32 | Set | Sets the pointer at the specified index to have an owning or non-owning relationship with the specified <Node>. Note that multiple ownership is not supported and this call fails if the collection already has an owning pointer to the <Node>. |
| int32 | ShallowCopy | Populates this <NodeBuffer> with non-owning pointers to all the <Node> objects in the source <NodeBuffer>. |
| int32 | Shrink | Shrinks the collection to a range specified by a start index and count. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | Count | Sets the number of items in the collection. Requires at least one memory allocation, but may require a full allocation and deallocation cycle. |
| int32 | Reserve | Sets the reserve memory, which does not refer to the number of items in the collection, but refers to the size of the underlying buffer. |