EntityRenderer

EntityRenderer class

Subclass this to implement rendering for different kind of entities.

Methods

constructor

NameDescription
constructor(key, features)Constructor of EntityRenderer

Parameters:

NameTypeDescription
keyStringThe key of the entity renderer
featuresbyteEntityRendererFeatures

Result:


constructor_overload

NameDescription
constructor_overload(key)Constructor of EntityRenderer

Parameters:

NameTypeDescription
keyStringThe key of the entity renderer

Result:


initialize

NameDescription
initialize(renderer)Initialize the entity renderer

Parameters:

NameTypeDescription
rendereRenderernull

Result:


resetSceneCache

NameDescription
resetSceneCache()The scene has changed or removed, need to dispose scene-level render resources in this

Result:


frameBegin

NameDescription
frameBegin(renderer, renderQueue)Begin rendering a frame

Parameters:

NameTypeDescription
rendererRendererCurrent renderer
renderQueueIRenderQueueRender queue

Result:


frameEnd

NameDescription
frameEnd(renderer, renderQueue)Ends rendering a frame

Parameters:

NameTypeDescription
rendererRendererCurrent renderer
renderQueueIRenderQueueRender queue

Result:


prepareRenderQueue

NameDescription
prepareRenderQueue(renderer, queue, node, entity)Prepare rendering commands for specified node/entity pair.

Parameters:

NameTypeDescription
rendererRendererThe current renderer instance
queueIRenderQueueThe render queue used to manage render tasks
nodeNodeCurrent node
entityEntityThe entity that need to be rendered

Result:


renderEntity

NameDescription
renderEntity(renderer, commandList, node, renderableResource, subEntity)Each render task pushed to the com.aspose.threed.IRenderQueue will have a corresponding RenderEntity call to perform the concrete rendering job.

Parameters:

NameTypeDescription
rendererRendererThe renderer
commandListICommandListThe commandList used to record the rendering commands
nodeNodeThe same node that passed to PrepareRenderQueue of the entity that will be rendered
renderableResourceObjectThe custom object that passed to IRenderQueue during the PrepareRenderQueue
subEntityNumberThe index of the sub entity that passed to IRenderQueue

Result:


dispose

NameDescription
dispose()The entity renderer is being disposed, release shared resources.

Result: