handle a message

Handle a message, override this method accordingly in subclasses!

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called when entity is created

This will initialize the managed model inside the ModelEntity.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called before entity is destroyed

Cleanup our managed model, and ModelInstance if it is already initialized.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called to setup the client-portion of the shared data object

This method is called from OnActivate() to setup the shared data object of the entity. The method must call the ClientSetup() method on the sharedData object with the same template type as the main-thread side entity.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called to discard the client-portion of the shared data object

Called from OnDeactivate() to discard the shared data object of the entity from the client side.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called per frame to reset the shared data object

This method is called once per frame before OnCullBefore() to initialize the shared data object with suitable data (which may be overwritten with uptodate-data later in the frame). This is necessary because the SharedData object is double buffered, and thus if an update if missed for one frame invalid data from the previous frame may "leak" into the next frame.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called from internalview

This method is called whenever the the internalview comes to its Render method. Add light entities to the LightServer or to the ShadowServer.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called when transform matrix changed

In OnTransformChanged() we need to update the transformation of our ModelInstance (if it has already been initialised).

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called before culling on each(!) graphics entity (visible or not!)

This method is called each frame on each entity (visible or not), so keep this method cheap!

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called when the entity has been found visible, may be called several times per frame!

This method is called once (per-view) before the entity is rendered, and only for visible entities. Please note that this method may be called several times per frame!

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called right before rendering

This method is called on the entity from InternalView::Render() once per frame for every visible entity.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called to render a debug visualization of the entity

Render our debug visualization (the bounding box).

Reimplemented from InternalGraphics::InternalGraphicsEntity.

validate the ModelInstance

This creates and initializes our ModelInstance if needed. Since Model loading happens asynchronously this may happen at any time after the ModelEntity is activated.

called when the entity becomes visible

This method is called from the SetVisible() method when the entity changes from invisible to visible state.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

called when the entity becomes invisible

This method is called from the SetVisible() method when the entity changes from visible to invisible state.

Reimplemented from InternalGraphics::InternalGraphicsEntity.

handle per-frame anim events

Handle character anim event stuff, always call this method, even if anim event tracking is not enabled.

handle per-frame anim-driven-movement stuff

Handle character anim driven motion feedback. This is called once per frame for visible characters.

handle tracked character joints

Handle the tracked character joints if joint tracking is enabled. NOTE: it's important that this method is called after the character's asynchronous update jobs have finished!

compute clip status against bounding box

Compute the clip status between this entity and a bounding box in global space. This method must be overwritten in a derived class.

Reimplemented in InternalGraphics::InternalCameraEntity, Lighting::InternalGlobalLightEntity, Lighting::InternalPointLightEntity, and Lighting::InternalSpotLightEntity.

add a message for deferred handling once the object becomes valid

Message handlers may decide to defer message handling until the object has become valid.

called when attached to Stage

This method is called when the graphics entity is attached to a stage. An entity may only be attached to one stage at any time, but can be attached to different stages during its lifetime. Attachging an entity to a stage may be relatively slow because the entity must be inserted into the cell hierarchy.

called when removed from Stage

This method is called when the graphics entity is removed from a stage.

handle deferred messages (called by subclasses once resources are loaded)

This method is called once when an object with deferred validation (e.g. ModelEntities) become valid (usually after their resources have finished loading). Any deferred messages will be processed here.

get the current refcount

Return the current refcount of the object.

increment refcount by one

Increment the refcount of the object.

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

get the class name

Get the class name of the object.

get the class FourCC code

Get the class FourCC of the object.

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.