# class
ImpostorProcessor
The ImpostorProcessor generates an impostor of one of these impostor types: BillboardCloud, Flipbook or ImpostorFromSingleView.
# Properties
Property | Description |
---|---|
Scene | The scene for the impostor processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor. |
# Methods
Method | Description |
---|---|
Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. |
GetBillboardCloudMaterialId | If an impostor has been generated with ImpostorType: BillboardCloud, this function returns the material id of the generated material. |
GetClass | Get the name of the ImpostorProcessor class. |
GetImpostorGeometryFromSingleView | If an impostor has been generated with ImpostorType: ImpostorFromSingleView, this function returns the quad GeometryData. |
GetImpostorSettings | The settings for the ImpostorProcessor. |
GetMappingImage | The MappingImage for the Impostor geometry. |
GetMappingImageSettings | The settings for the the MappingImage. |
GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. |
GetSingleViewAspectRatio | If an impostor has been generated with ImpostorType: ImpostorFromSingleView, this function returns the aspect ratio so the mapping setting can be set accordingly. TextureHeight * AspectRatio = TextureWidth |
IsA | Returns true if ImpostorProcessor is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the ImpostorProcessor object is invalid. |
RunProcessing | Runs the processing the object is designed for. |
# 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 spImpostorProcessor, and if this is the case, returns the object cast into spImpostorProcessor. |
# Properties details
# Scene
The scene for the impostor processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.
# Methods details
# Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
# GetBillboardCloudMaterialId
If an impostor has been generated with ImpostorType: BillboardCloud, this function returns the material id of the generated material.
# GetClass
Get the name of the ImpostorProcessor class.
# GetImpostorGeometryFromSingleView
If an impostor has been generated with ImpostorType: ImpostorFromSingleView, this function returns the quad GeometryData.
# Syntax
spGeometryData GetImpostorGeometryFromSingleView();
# Parameters
GetImpostorGeometryFromSingleView takes no parameters.
# Return value
Type: GeometryData
# GetImpostorSettings
The settings for the ImpostorProcessor.
# Syntax
spImpostorSettings GetImpostorSettings();
# Parameters
GetImpostorSettings takes no parameters.
# Return value
Type: ImpostorSettings
# GetMappingImage
The MappingImage for the Impostor geometry.
# Syntax
spMappingImage GetMappingImage();
# Parameters
GetMappingImage takes no parameters.
# Return value
Type: MappingImage
# GetMappingImageSettings
The settings for the the MappingImage.
# Syntax
spMappingImageSettings GetMappingImageSettings();
# Parameters
GetMappingImageSettings takes no parameters.
# Return value
Type: MappingImageSettings
# GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
# GetSingleViewAspectRatio
If an impostor has been generated with ImpostorType: ImpostorFromSingleView, this function returns the aspect ratio so the mapping setting can be set accordingly. TextureHeight * AspectRatio = TextureWidth
# IsA
Returns true if ImpostorProcessor is a or is a descendant of the class named as the type parameter.
# IsNull
Returns true if the ImpostorProcessor object is invalid.
# RunProcessing
Runs the processing the object is designed for.
# 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 spImpostorProcessor, and if this is the case, returns the object cast into spImpostorProcessor.