Simplygon 10.3.2100.0
class SceneBoneTable ​
SceneBoneTable keeps information on bones used while rendering.
Properties ​
| Property | Description |
|---|---|
| Name | The name of the SceneBoneTable object. (Inherited from Object) |
Methods ​
| Method | Description |
|---|---|
| AddBone | Adds a bone to the table. The returned value is the id of the bone within the table. |
| AddItem | Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem(). (Inherited from Table) |
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table) |
| Copy | Clears the current table and copies the items from a source table. (Inherited from Table) |
| FindBone | Finds a bone in the table, using the bone name. If multiple bones have the same name, the first will be returned. If the bone was not found, null is returned. |
| FindBoneId | Finds the id of a bone in the table, using the bone name. If multiple bones have the same name, the first will be returned. If the bone was not found, -1 is returned. |
| FindItem | Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned. (Inherited from Table) |
| FindItemId | Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1. (Inherited from Table) |
| GetBone | Returns the i:th bone, using the id of the bone. |
| GetBonesCount | Returns the number of bones in the table. |
| GetClass | Get the name of the SceneBoneTable class. (Inherited from Object) |
| GetItem | Returns the i:th item, using the id of the item. (Inherited from Table) |
| GetItemsCount | The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table. (Inherited from Table) |
| IsA | Returns true if SceneBoneTable is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the SceneBoneTable object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the SceneBoneTable object is valid. (Inherited from Object) |
| NonNull | Returns true if the SceneBoneTable object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the SceneBoneTable object to the log. (Inherited from Object) |
| RemoveBone | Removes a bone. If GetBone is called with the bone id, the value returned will be null. |
| RemoveItem | Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id. (Inherited from Table) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetItem | Sets an item in the table. The id must exist in the table. (Inherited from Table) |
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 spSceneBoneTable, and if this is the case, returns the object cast into spSceneBoneTable. (Inherited from Object) |
Properties details ​
Name ​
The name of the SceneBoneTable object. (Inherited from Object)
Methods details ​
AddBone ​
Adds a bone to the table. The returned value is the id of the bone within the table.
AddItem ​
Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem().
AddObserver ​
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear ​
Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.
Copy ​
Clears the current table and copies the items from a source table.
FindBone ​
Finds a bone in the table, using the bone name. If multiple bones have the same name, the first will be returned. If the bone was not found, null is returned.
FindBoneId ​
Finds the id of a bone in the table, using the bone name. If multiple bones have the same name, the first will be returned. If the bone was not found, -1 is returned.
FindItem ​
Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned.
FindItemId ​
Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1.
GetBone ​
Returns the i:th bone, using the id of the bone.
GetBonesCount ​
Returns the number of bones in the table.
GetClass ​
Get the name of the SceneBoneTable class. (Inherited from Object)
GetItem ​
Returns the i:th item, using the id of the item.
GetItemsCount ​
The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table.
IsA ​
Returns true if SceneBoneTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull ​
Returns true if the SceneBoneTable object is invalid. (Inherited from Object)
IsSameObjectAs ​
Returns true if the SceneBoneTable object is valid. (Inherited from Object)
NonNull ​
Returns true if the SceneBoneTable object is valid. (Inherited from Object)
PrintInfo ​
Prints the content/info of the SceneBoneTable object to the log. (Inherited from Object)
RemoveBone ​
Removes a bone. If GetBone is called with the bone id, the value returned will be null.
RemoveItem ​
Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id.
RemoveObserver ​
Removes a previously added observer object. (Inherited from Object)
SetItem ​
Sets an item in the table. The id must exist in the table.
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 spSceneBoneTable, and if this is the case, returns the object cast into spSceneBoneTable. (Inherited from Object)