`class` ValueArrayCollection

ValueArrayCollection and its specializations handles a collection of ValueArrays. There are methods for adding, removing and iterating through the objects.

Properties

Property	Description
Name	The name of the ValueArrayCollection object. (Inherited from Object)

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. (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)
AddValueArray	Adds an array to the collection. The handle refers to the array until the object 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. (Inherited from ObjectCollection)
FindRegexValueArray	Finds an array in the collection, using the primary name and/or the alternative name of the array. Either of the names can also be looked up using regular expressions, or exactly matched to the name.
FindValueArray	Finds a named array in the collection. The first object with this name is returned. The search is case-sensitive.
GetClass	Get the name of the ValueArrayCollection 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)
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)
GetValueArray	Retrieves a value array using a handle.
IsA	Returns true if ValueArrayCollection is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsItemInCollection	Returns true if the item is in the collection. (Inherited from ObjectCollection)
IsNull	Returns true if the ValueArrayCollection object is invalid. (Inherited from Object)
IsObjectInCollection	Returns true if the object is in the collection. (Inherited from ObjectCollection)
IsSameObjectAs	Returns true if the ValueArrayCollection object is valid. (Inherited from Object)
IsValueArrayInCollection	Returns true if the array is in the collection.
NonNull	Returns true if the ValueArrayCollection object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ValueArrayCollection object to the log. (Inherited from Object)
RemoveAllItems	Removes all items from the collection. (Inherited from ObjectCollection)
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)
RemoveValueArray	Removes an array from the collection. Only the first occurrence 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. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spValueArrayCollection, and if this is the case, returns the object cast into spValueArrayCollection. (Inherited from Object)

Properties details

Name

The name of the ValueArrayCollection object. (Inherited from Object)

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

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

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

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.

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

AddValueArray

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

Type	Name	Min	Max	Description
ValueArray	obj			The array that is to be added to the collection.

Type	Name	Min	Max	Description
ValueArray	obj			The array that is to be added to the collection.

Name	Type	Min	Max	Description
obj	ValueArray			The array 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.

FindRegexValueArray

Finds an array in the collection, using the primary name and/or the alternative name of the array. Either of the names can also be looked up using regular expressions, or exactly matched to the name.

Type	Name	Description
`const char *`	name	The Name to search for, or null to match any name
`bool`	nameIsRegex	If true, the name parameter is defined as a regular expression. If false, the Name field is matched verbatim.
`const char *`	alternativeName	The AlternativeName to search for, or null to match any name
`bool`	alternativeNameIsRegex	If true, the alternativeName parameter is defined as a regular expression. If false, the AlternativeName field is matched verbatim.

Type	Name	Description
`string`	name	The Name to search for, or null to match any name
`bool`	nameIsRegex	If true, the name parameter is defined as a regular expression. If false, the Name field is matched verbatim.
`string`	alternativeName	The AlternativeName to search for, or null to match any name
`bool`	alternativeNameIsRegex	If true, the alternativeName parameter is defined as a regular expression. If false, the AlternativeName field is matched verbatim.

Name	Type	Description
name	`str`	The Name to search for, or null to match any name
nameIsRegex	`bool`	If true, the name parameter is defined as a regular expression. If false, the Name field is matched verbatim.
alternativeName	`str`	The AlternativeName to search for, or null to match any name
alternativeNameIsRegex	`bool`	If true, the alternativeName parameter is defined as a regular expression. If false, the AlternativeName field is matched verbatim.

FindValueArray

Finds a named array 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 ValueArrayCollection 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.

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.

GetValueArray

Retrieves a value array using a handle.

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

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

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

IsA

Returns true if ValueArrayCollection is a or is a descendant of the class named as the type parameter. (Inherited from Object)

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

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

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ValueArrayCollection 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 ValueArrayCollection object is invalid. (Inherited from Object)

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.

IsSameObjectAs

Returns true if the ValueArrayCollection object is valid. (Inherited from Object)

IsValueArrayInCollection

Returns true if the array is in the collection.

NonNull

Returns true if the ValueArrayCollection object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the ValueArrayCollection object to the log. (Inherited from Object)

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

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

RemoveValueArray

Removes an array from the collection. Only the first occurrence 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. (Inherited from Object)

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spValueArrayCollection, and if this is the case, returns the object cast into spValueArrayCollection. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ValueArrayCollection ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

Methods details ​

AddObject ​

AddObjectSorted ​

AddObserver ​

AddValueArray ​

FindObject ​

FindRegexValueArray ​

FindValueArray ​

GetClass ​

GetFirstItem ​