Simplygon 10.2.400.0
class GeometryDataCollection ​
GeometryDataCollection holds a number of GeometryData objects. The objects can be looked up by their names (if they have been named with a call to SetName).
See also: ObjectCollection
Properties ​
| Property | Description |
|---|---|
| Name | The name of the GeometryDataCollection object. (Inherited from Object) |
Methods ​
| Method | Description |
|---|---|
| AddGeometryData | Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size. |
| AddObject | Adds an object to the collection. The handle refers to the object until the object is removed from the collection again. (Inherited from ObjectCollection) |
| AddObjectSorted | Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name. (Inherited from ObjectCollection) |
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| FindGeometryData | Finds a named object. |
| FindObject | Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive. (Inherited from ObjectCollection) |
| GetClass | Get the name of the GeometryDataCollection class. (Inherited from Object) |
| GetFirstItem | Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty. (Inherited from ObjectCollection) |
| GetGeometryData | The object the handle is referring to. |
| GetItem | Returns the handle of the i:th item. (Inherited from ObjectCollection) |
| GetItemAsObject | Returns the object of the i:th item. (Inherited from ObjectCollection) |
| GetItemCount | The number of items in the collection. (Inherited from ObjectCollection) |
| GetItemsObject | The object the handle is referring to. (Inherited from ObjectCollection) |
| GetNextItem | Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached. (Inherited from ObjectCollection) |
| GetNextItemAsGeometryData | Returns the object of the next item. |
| IsA | Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsGeometryDataInCollection | Returns true if the object is in the collection. |
| IsItemInCollection | Returns true if the item is in the collection. (Inherited from ObjectCollection) |
| IsNull | Returns true if the GeometryDataCollection object is invalid. (Inherited from Object) |
| IsObjectInCollection | Returns true if the object is in the collection. (Inherited from ObjectCollection) |
| IsSameObjectAs | Returns true if the GeometryDataCollection object is valid. (Inherited from Object) |
| NonNull | Returns true if the GeometryDataCollection object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the GeometryDataCollection object to the log. (Inherited from Object) |
| RemoveAllItems | Removes all items from the collection. (Inherited from ObjectCollection) |
| RemoveGeometryData | Removes an object from the collection. Only the first occurrence of the object is removed. |
| RemoveItem | Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object. (Inherited from ObjectCollection) |
| RemoveObject | Removes an object from the collection. Only the first occurrence of the object is removed from the collection. (Inherited from ObjectCollection) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Static methods ​
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection. (Inherited from Object) |
Properties details ​
Name ​
The name of the GeometryDataCollection object. (Inherited from Object)
Methods details ​
AddGeometryData ​
Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size.
AddObject ​
Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.
AddObjectSorted ​
Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
AddObserver ​
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
FindGeometryData ​
Finds a named object.
FindObject ​
Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
GetClass ​
Get the name of the GeometryDataCollection class. (Inherited from Object)
GetFirstItem ​
Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.
GetGeometryData ​
The object the handle is referring to.
GetItem ​
Returns the handle of the i:th item.
GetItemAsObject ​
Returns the object of the i:th item.
GetItemCount ​
The number of items in the collection.
GetItemsObject ​
The object the handle is referring to.
GetNextItem ​
Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.
GetNextItemAsGeometryData ​
Returns the object of the next item.
IsA ​
Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsGeometryDataInCollection ​
Returns true if the object is in the collection.
IsItemInCollection ​
Returns true if the item is in the collection.
IsNull ​
Returns true if the GeometryDataCollection object is invalid. (Inherited from Object)
IsObjectInCollection ​
Returns true if the object is in the collection.
IsSameObjectAs ​
Returns true if the GeometryDataCollection object is valid. (Inherited from Object)
NonNull ​
Returns true if the GeometryDataCollection object is valid. (Inherited from Object)
PrintInfo ​
Prints the content/info of the GeometryDataCollection object to the log. (Inherited from Object)
RemoveAllItems ​
Removes all items from the collection.
RemoveGeometryData ​
Removes an object from the collection. Only the first occurrence of the object is removed.
RemoveItem ​
Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.
RemoveObject ​
Removes an object from the collection. Only the first occurrence of the object is removed from the collection.
RemoveObserver ​
Removes a previously added observer object. (Inherited from Object)
Static methods details ​
IsClassA ​
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast ​
SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection. (Inherited from Object)