class SurfaceMapper
ISurfaceMapper creates a mapping image between two user-defined geometries. The mapper basically looks for the source geometry in the inverse normal direction from the outwardly offset destination geometry, and maps pixels accordingly. This means that you can modify the normals of the destination geometry to adjust the search direction to your liking. The geometries can either be set as IGeometryDatas or as the root nodes of scenes. If both are set, the scene is used. If only a single source or a destination is set, or if the source and destination are the same scene or geometry, the surface mapper will map the mesh onto itself.
Properties
| Property | Description |
|---|
| DestinationGeometry | The destination geometry data. |
| DestinationScene | The scene used for the surface transfer destination. |
| Name | The name of the SurfaceMapper object. (Inherited from Object) |
| RecalculateSearchDirection | If set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry. |
| SearchDirectionHardEdgeAngle | The hard edge angle in degrees. If RecalculateSearchDirection is on, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry. |
| SearchDistance | The search distance. If the source geometry is found within this distance from the destination geometry, it will be mapped. If negative, it will be set to a sane default internally, based on the mesh size. |
| SearchOffset | The search offset. This is how far out from the destination geometry the search for the source geometry will begin, propagating inwardly for the length of SearchDistance. If negative, it will be set to a sane default internally, based on the mesh size. |
| SourceGeometry | The source geometry data. |
| SourceScene | The scene used for the surface transfer source. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the SurfaceMapper class. (Inherited from Object) |
| GetMappingImage | The mapping image. |
| GetMappingImageSettings | The mapping image settings. Currently, the only applicable settings for this mapper is texcoordlevel, texcoordname, size, and supersampling settings. |
| IsA | Returns true if SurfaceMapper is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the SurfaceMapper object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the SurfaceMapper object is valid. (Inherited from Object) |
| NonNull | Returns true if the SurfaceMapper object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the SurfaceMapper object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunSurfaceMapping | Runs the surface mapping. |
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 spSurfaceMapper, and if this is the case, returns the object cast into spSurfaceMapper. (Inherited from Object) |
Properties details
DestinationGeometry
The destination geometry data.
Syntax
SetDestinationGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | Is the destination geometry. |
GetDestinationGeometry return value
Type: GeometryData
Syntax
SetDestinationGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | Is the destination geometry. |
GetDestinationGeometry return value
Type: GeometryData
Syntax
SetDestinationGeometry parameters
| Name | Type | Min | Max | Description |
|---|
| value | GeometryData | | | Is the destination geometry. |
GetDestinationGeometry return value
Type: GeometryData
DestinationScene
The scene used for the surface transfer destination.
Syntax
SetDestinationScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | Is the destination scene object. |
GetDestinationScene return value
Type: Scene
Syntax
SetDestinationScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | Is the destination scene object. |
GetDestinationScene return value
Type: Scene
Syntax
SetDestinationScene parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | Is the destination scene object. |
GetDestinationScene return value
Type: Scene
Name
The name of the SurfaceMapper 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
RecalculateSearchDirection
If set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.
Syntax
SetRecalculateSearchDirection parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the desired flag value. |
GetRecalculateSearchDirection return value
Type: bool
Syntax
SetRecalculateSearchDirection parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the desired flag value. |
GetRecalculateSearchDirection return value
Type: bool
Syntax
SetRecalculateSearchDirection parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | Is the desired flag value. |
GetRecalculateSearchDirection return value
Type: bool
SearchDirectionHardEdgeAngle
The hard edge angle in degrees. If RecalculateSearchDirection is on, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.
Syntax
SetSearchDirectionHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | 180 | Is the hard angle value. |
GetSearchDirectionHardEdgeAngle return value
Type: real
Default: 180
Syntax
SetSearchDirectionHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | 180 | Is the hard angle value. |
GetSearchDirectionHardEdgeAngle return value
Type: float
Default: 180
Syntax
SetSearchDirectionHardEdgeAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | 180 | Is the hard angle value. |
GetSearchDirectionHardEdgeAngle return value
Type: float
Default: 180
SearchDistance
The search distance. If the source geometry is found within this distance from the destination geometry, it will be mapped. If negative, it will be set to a sane default internally, based on the mesh size.
Syntax
SetSearchDistance parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | Is the search distance value. |
GetSearchDistance return value
Type: real
Syntax
SetSearchDistance parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | Is the search distance value. |
GetSearchDistance return value
Type: float
Syntax
SetSearchDistance parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | Is the search distance value. |
GetSearchDistance return value
Type: float
SearchOffset
The search offset. This is how far out from the destination geometry the search for the source geometry will begin, propagating inwardly for the length of SearchDistance. If negative, it will be set to a sane default internally, based on the mesh size.
Syntax
SetSearchOffset parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | Is the search offset value. |
GetSearchOffset return value
Type: real
Syntax
SetSearchOffset parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | Is the search offset value. |
GetSearchOffset return value
Type: float
Syntax
SetSearchOffset parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | Is the search offset value. |
GetSearchOffset return value
Type: float
SourceGeometry
The source geometry data.
Syntax
SetSourceGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | Is the source geometry. |
GetSourceGeometry return value
Type: GeometryData
Syntax
SetSourceGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | Is the source geometry. |
GetSourceGeometry return value
Type: GeometryData
Syntax
SetSourceGeometry parameters
| Name | Type | Min | Max | Description |
|---|
| value | GeometryData | | | Is the source geometry. |
GetSourceGeometry return value
Type: GeometryData
SourceScene
The scene used for the surface transfer source.
Syntax
SetSourceScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | Is the source scene object. |
GetSourceScene return value
Type: Scene
Syntax
SetSourceScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | Is the source scene object. |
GetSourceScene return value
Type: Scene
Syntax
SetSourceScene parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | Is the source scene object. |
GetSourceScene return value
Type: Scene
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
GetClass
Get the name of the SurfaceMapper 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
GetMappingImage
The mapping image.
Syntax
Parameters
GetMappingImage takes no parameters.
Return value
Type: MappingImage
Syntax
Parameters
GetMappingImage takes no parameters.
Return value
Type: MappingImage
Syntax
Parameters
GetMappingImage takes no parameters.
Return value
Type: MappingImage
GetMappingImageSettings
The mapping image settings. Currently, the only applicable settings for this mapper is texcoordlevel, texcoordname, size, and supersampling settings.
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
IsA
Returns true if SurfaceMapper 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 SurfaceMapper 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 SurfaceMapper 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 SurfaceMapper is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the SurfaceMapper 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 SurfaceMapper 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 SurfaceMapper 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 SurfaceMapper 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. |
RunSurfaceMapping
Runs the surface mapping.
Syntax
Parameters
RunSurfaceMapping takes no parameters.
Syntax
Parameters
RunSurfaceMapping takes no parameters.
Syntax
Parameters
RunSurfaceMapping takes no parameters.
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 spSurfaceMapper, and if this is the case, returns the object cast into spSurfaceMapper. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SurfaceMapper
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SurfaceMapper
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: SurfaceMapper
