class MappingImageMeshData
MappingImageMeshData stores the mapped meshes and their paths in the original scene. This can be used to find a specific triangle on the original mesh in the scene from the combined id in the mapping image.
Properties
| Property | Description |
|---|
| Name | The name of the MappingImageMeshData object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Clear the MappingImageMeshData. |
| GetClass | Get the name of the MappingImageMeshData class. (Inherited from Object) |
| GetMappedGeometriesCount | The MappedGeometriesCount, the number of mapped geometries. |
| GetNodeGuidOfGeometry | The node guid containing the original geometry. |
| GetScenePathOfGeometry | The mesh path in the scene of the geometry at the specified index. |
| GetStartTriangleIdOfGeometry | The Id of the first triangle of the geometry at the specified index. |
| IsA | Returns true if MappingImageMeshData is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the MappingImageMeshData object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the MappingImageMeshData object is valid. (Inherited from Object) |
| NonNull | Returns true if the MappingImageMeshData object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the MappingImageMeshData object to the log. (Inherited from Object) |
| 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 spMappingImageMeshData, and if this is the case, returns the object cast into spMappingImageMeshData. (Inherited from Object) |
Properties details
Name
The name of the MappingImageMeshData object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
Clear
Clear the MappingImageMeshData.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the MappingImageMeshData class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetMappedGeometriesCount
The MappedGeometriesCount, the number of mapped geometries.
Syntax
Parameters
GetMappedGeometriesCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetMappedGeometriesCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetMappedGeometriesCount takes no parameters.
Return value
Type: int
GetNodeGuidOfGeometry
The node guid containing the original geometry.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | GeometryIndex | | | Is index of the geometry in the list of mapped geometries. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | GeometryIndex | | | Is index of the geometry in the list of mapped geometries. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| GeometryIndex | int | | | Is index of the geometry in the list of mapped geometries. |
Return value
Type: str
GetScenePathOfGeometry
The mesh path in the scene of the geometry at the specified index.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | GeometryIndex | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | GeometryIndex | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| GeometryIndex | int | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: str
GetStartTriangleIdOfGeometry
The Id of the first triangle of the geometry at the specified index.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | GeometryIndex | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | GeometryIndex | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| GeometryIndex | int | | | The index of the geometry in the list of mapped geometries. |
Return value
Type: int
IsA
Returns true if MappingImageMeshData is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if MappingImageMeshData is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if MappingImageMeshData is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if MappingImageMeshData is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the MappingImageMeshData object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the MappingImageMeshData object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the MappingImageMeshData object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the MappingImageMeshData object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spMappingImageMeshData, and if this is the case, returns the object cast into spMappingImageMeshData. (Inherited from Object)
