Skip to content
On this page

class ImpostorProcessor

The ImpostorProcessor generates an impostor of one of these impostor types: BillboardCloud, Flipbook or ImpostorFromSingleView.

Properties

PropertyDescription
NameThe name of the ImpostorProcessor object. (Inherited from Object)
SceneThe scene for the impostor processing. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
ClearClear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject)
GetAttributeTessellationSettingsThe settings for handling attribute tessellation of the output geometry.
GetBillboardCloudMaterialIdIf an impostor has been generated with ImpostorType: BillboardCloud, this function returns the material id of the generated material.
GetClassGet the name of the ImpostorProcessor class. (Inherited from Object)
GetImpostorGeometryFromSingleViewIf an impostor has been generated with ImpostorType: ImpostorFromSingleView, this function returns the quad GeometryData.
GetImpostorSettingsThe settings for the ImpostorProcessor.
GetMappingImageThe MappingImage for the Impostor geometry.
GetMappingImageForImageIndexCalled with an id, it will fetch that specific mapping image if using multi-material output.
GetMappingImageSettingsThe settings for the the MappingImage.
GetPercentDoneReturns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
GetSingleViewAspectRatioIf 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
IsAReturns true if ImpostorProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ImpostorProcessor object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ImpostorProcessor object is valid. (Inherited from Object)
NonNullReturns true if the ImpostorProcessor object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ImpostorProcessor object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunProcessingRuns the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject)
ToJSONGet settings as JSON for debugging purposes. (Inherited from ProcessingObject)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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. (Inherited from Object)

Properties details

Name

The name of the ImpostorProcessor object. (Inherited from Object)

Scene

The scene for the impostor processing. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Clear

Clear all internal states of the object. This will NOT clear the parameters set in the object.

GetAttributeTessellationSettings

The settings for handling attribute tessellation of the output geometry.

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. (Inherited from Object)

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.

GetMappingImageForImageIndex

Called with an id, it will fetch that specific mapping image if using multi-material output.

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. (Inherited from Object)

IsNull

Returns true if the ImpostorProcessor object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the ImpostorProcessor object is valid. (Inherited from Object)

NonNull

Returns true if the ImpostorProcessor object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the ImpostorProcessor object to the log. (Inherited from Object)

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

RunProcessing

Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.

ToJSON

Get settings as JSON for debugging purposes.

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 spImpostorProcessor, and if this is the case, returns the object cast into spImpostorProcessor. (Inherited from Object)