# `class` SceneNodeCollection

SceneNodeCollection holds a number of SceneNode objects. The objects can be looked up by their names (if they have been named through SetName()).

# Methods

Method	Description
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.
AddSceneNode	Adds an object object to the collection. The handle refers to the object until it is removed from the collection again.
FindObject	Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
FindSceneNode	Finds a named object.
GetClass	Get the name of the SceneNodeCollection 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.
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.
GetNextItemAsSceneNode	Returns the object of the next item.
GetSceneNode	The object the handle is referring to.
IsA	Returns true if SceneNodeCollection is a or is a descendant of the class named as the type parameter.
IsItemInCollection	Returns true if the item is in the collection.
IsNull	Returns true if the SceneNodeCollection object is invalid.
IsObjectInCollection	Returns true if the object is in the collection.
IsSceneNodeInCollection	Returns true if the object is in the collection.
RemoveAllItems	Removes all items 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.
RemoveSceneNode	Removes an object from the collection. Only the first occurrence of the object is removed.

# 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 spSceneNodeCollection, and if this is the case, returns the object cast into spSceneNodeCollection.

# Methods details

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

# AddSceneNode

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

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

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

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

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

# FindSceneNode

Finds a named object.

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

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

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

# GetClass

Get the name of the SceneNodeCollection 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.

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

# GetNextItemAsSceneNode

Returns the object of the next item.

Type	Name	Min	Max	Description
`RhandleData`	phandle			The handle of a node in the collection.

Type	Name	Min	Max	Description
`System.IntPtr[]`	phandle			The handle of a node in the collection.

Name	Type	Min	Max	Description
phandle	`PyObject*`			The handle of a node in the collection.

# GetSceneNode

The object the handle is referring to.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of the node.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of the node.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of the node.

# IsA

Returns true if SceneNodeCollection 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 SceneNodeCollection is, or is a descendant of.

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

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

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

# IsSceneNodeInCollection

Returns true if the object is in the collection.

Type	Name	Min	Max	Description
`SceneNode`	pobj			Is an arbitrary node.

Type	Name	Min	Max	Description
`SceneNode`	pobj			Is an arbitrary node.

Name	Type	Min	Max	Description
pobj	`SceneNode`			Is an arbitrary node.

# RemoveAllItems

Removes all items 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.

Type	Name	Min	Max	Description
`rhandle`	objhandle			The handle of the object that is to be removed.

Type	Name	Min	Max	Description
`System.IntPtr`	objhandle			The handle of the object that is to be removed.

Name	Type	Min	Max	Description
objhandle	`PyObject*`			The handle of the object that is to be removed.

# RemoveObject

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

# RemoveSceneNode

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

# 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 spSceneNodeCollection, and if this is the case, returns the object cast into spSceneNodeCollection.

← GeometryDataCollection MaterialTable →

# class SceneNodeCollection