# class MappingImage
MappingImage stores the mapping between a processed geometry and the source geometry it is based on. The mapping image object also stores multisampling settings. It can be used to cast information from the original geometry to the processed geometry, such as surface transfer or calculating normal maps. See IMaterialCaster and subclasses for casting uses.
# Methods
| Method | Description |
|---|---|
| GetClass | Get the name of the MappingImage class. |
| GetHeight | The height of the mapping texture. |
| GetImageData | The ImageData object, which stores the mapping data. |
| GetLayerCount | The number of layers of the mapping texture. |
| GetMappingMeshData | The IMappingImageMeshData Mesh data that is used to retrieve the triangle mapping to mesh information to map back to the original scene. |
| GetMultisamplingHeight | The multi sampling height of the mapping texture. |
| GetMultisamplingWidth | The multi sampling width of the mapping texture. |
| GetWidth | The width of the mapping texture. |
| IsA | Returns true if MappingImage is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the MappingImage object is invalid. |
| NewQuartersizeCopy | Return a copy of the mapping image which is scaled in size by half, in width and height. The area covered is a quarter size of the original, hence its name. |
# 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 spMappingImage, and if this is the case, returns the object cast into spMappingImage. |
# Methods details
# GetClass
Get the name of the MappingImage class.
# GetHeight
The height of the mapping texture.
# GetImageData
The ImageData object, which stores the mapping data.
# Syntax
spChunkedImageData GetImageData();
# Parameters
GetImageData takes no parameters.
# Return value
Type: ChunkedImageData
# GetLayerCount
The number of layers of the mapping texture.
# GetMappingMeshData
The IMappingImageMeshData Mesh data that is used to retrieve the triangle mapping to mesh information to map back to the original scene.
# Syntax
spMappingImageMeshData GetMappingMeshData();
# Parameters
GetMappingMeshData takes no parameters.
# Return value
Type: MappingImageMeshData
# GetMultisamplingHeight
The multi sampling height of the mapping texture.
# GetMultisamplingWidth
The multi sampling width of the mapping texture.
# GetWidth
The width of the mapping texture.
# IsA
Returns true if MappingImage is a or is a descendant of the class named as the type parameter.
# IsNull
Returns true if the MappingImage object is invalid.
# NewQuartersizeCopy
Return a copy of the mapping image which is scaled in size by half, in width and height. The area covered is a quarter size of the original, hence its name.
# Syntax
spMappingImage NewQuartersizeCopy();
# Parameters
NewQuartersizeCopy takes no parameters.
# Return value
Type: MappingImage
# 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 spMappingImage, and if this is the case, returns the object cast into spMappingImage.