# `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).

# 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.
AddObjectSorted	Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
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.
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.
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.
IsObjectInCollection	Returns true if the object is in the collection.
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 occurance of the object is removed from the collection.

# Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter.
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.

# 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.

Type	Name	Min	Max	Description
GeometryData	obj			The GeometryData to add.

Type	Name	Min	Max	Description
GeometryData	obj			The GeometryData to add.

Name	Type	Min	Max	Description
obj	GeometryData			The GeometryData to add.

# AddObject

Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.

Type	Name	Min	Max	Description
`Object`	obj			The object that is to be added to the collection.

Type	Name	Min	Max	Description
`Object`	obj			The object that is to be added to the collection.

Name	Type	Min	Max	Description
obj	`Object`			The object that is to be added to the collection.

# AddObjectSorted

Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.

Type	Name	Min	Max	Description
`Object`	obj			The object that is to be added to the collection.
`bool`	ascending			Determines the sorting order.

Type	Name	Min	Max	Description
`Object`	obj			The object that is to be added to the collection.
`bool`	ascending			Determines the sorting order.

Name	Type	Min	Max	Description
obj	`Object`			The object that is to be added to the collection.
ascending	`bool`			Determines the sorting order.

# FindGeometryData

Finds a named object.

Type	Name	Min	Max	Description
`const char *`	name			The name of the geometry object.

Type	Name	Min	Max	Description
`string`	name			The name of the geometry object.

Name	Type	Min	Max	Description
name	`str`			The name of the geometry object.

# FindObject

Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.

Type	Name	Min	Max	Description
`const char *`	name			The name of an object in the collection.

Type	Name	Min	Max	Description
`string`	name			The name of an object in the collection.

Name	Type	Min	Max	Description
name	`str`			The name of an object in the collection.

# GetClass

Get the name of the GeometryDataCollection class.

# 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.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of the geometry data object to fetch.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of the geometry data object to fetch.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of the geometry data object to fetch.

# GetItem

Returns the handle of the i:th item.

Type	Name	Min	Max	Description
`unsigned int`	index			The index of an object in the collection.

Type	Name	Min	Max	Description
`uint`	index			The index of an object in the collection.

Name	Type	Min	Max	Description
index	`int`			The index of an object in the collection.

# GetItemAsObject

Returns the object of the i:th item.

Type	Name	Min	Max	Description
`unsigned int`	index			The index of an object in the collection.

Type	Name	Min	Max	Description
`uint`	index			The index of an object in the collection.

Name	Type	Min	Max	Description
index	`int`			The index of an object in the collection.

# GetItemCount

The number of items in the collection.

# GetItemsObject

The object the handle is referring to.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of an object in the collection.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of an object in the collection.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of an object in the collection.

# 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.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of an object i.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of an object i.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of an object i.

# GetNextItemAsGeometryData

Returns the object of the next item.

Type	Name	Min	Max	Description
`RhandleData`	phandle			The handle to the geometry object.

Type	Name	Min	Max	Description
`System.IntPtr[]`	phandle			The handle to the geometry object.

Name	Type	Min	Max	Description
phandle	`PyObject*`			The handle to the geometry object.

# IsA

Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter.

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if GeometryDataCollection is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if GeometryDataCollection is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if GeometryDataCollection is, or is a descendant of.

# IsGeometryDataInCollection

Returns true if the object is in the collection.

Type	Name	Min	Max	Description
GeometryData	pobj			The GeometryData to look for.

Type	Name	Min	Max	Description
GeometryData	pobj			The GeometryData to look for.

Name	Type	Min	Max	Description
pobj	GeometryData			The GeometryData to look for.

# IsItemInCollection

Returns true if the item is in the collection.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of an object to be checked for.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of an object to be checked for.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of an object to be checked for.

# IsNull

Returns true if the GeometryDataCollection object is invalid.

# IsObjectInCollection

Returns true if the object is in the collection.

Type	Name	Min	Max	Description
`Object`	pobj			The object to be checked for.

Type	Name	Min	Max	Description
`Object`	pobj			The object to be checked for.

Name	Type	Min	Max	Description
pobj	`Object`			The object to be checked for.

# RemoveAllItems

Removes all items from the collection.

# RemoveGeometryData

Removes an object from the collection. Only the first occurrence of the object is removed.

Type	Name	Min	Max	Description
GeometryData	pobj			The GeometryData to remove from the collection.

Type	Name	Min	Max	Description
GeometryData	pobj			The GeometryData to remove from the collection.

Name	Type	Min	Max	Description
pobj	GeometryData			The GeometryData to remove from the collection.

# 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 occurance of the object is removed from the collection.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

# 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.

← FieldData SceneNodeCollection →

# class GeometryDataCollection