set the current base animation (usually loop anims) - OBSOLETE, use FadeAnimation(), ClearAnimations()

Set a new base animation. This is usually a looping animation, like Idle, Walking, Running, etc...

Parameters:

	anim	new base animation
	fadeIn	time to fade from current animation
	timeOffset	optional animation time offset

set the current overlay animation (usually oneshot anims) - OBSOLETE, use FadeAnimation(), ClearAnimations()

Set a new overlay animation. This is usually a looping animation, like Idle, Walking, Running, etc...

Parameters:

	animName	new base animation
	fadeIn	time to fade from current animation
	overrideDuration	if != 0.0, override the animation's duration with this value

set the current fade animations - OBSOLETE, use FadeAnimation(), ClearAnimations()

Parameters:

	clipNames	new fade animations
	weights	new fade animation weights

called before rendering happens

This method checks whether the current overlay animation is over and the base animation must be re-activated. This is the only place where animations are actually started to prevent stuttering when several animations are started in the same frame.

Reimplemented from Graphics::ModelEntity.

get pointer to our nCharacter2 object

Returns the pointer to our nCharacter2 object.

bring the character's skeleton uptodate

This brings the character's skeleton uptodate. Make sure the entity's time and animation state weights in the rendercontext are uptodate before calling this method, to avoid one-frame-latencies.

return joint index by name, return InvalidIndex if joint doesn't exist

Returns a character joint index by its name. Returns -1 if a joint by that name doesn't exist in the character.

return joint at index

Return pointer to joint or 0 if joint doesn't exist.

return a joint's current matrix in model space

Returns a joint's current matrix in model space. Make sure to call EvaluateSkeleton() before!

get joint matrix by index in global space

Find the joint matrix in world space by index. Careful, this method does an EvaluateSkeleton() per invocation!

get joint matrix by name in global space, throws assert if joint doesn't exist

Returns a joint matrix in world space by name. Careful, this method does an EvaluateSkeleton() per invocation!

fade an animation to a weight

Fades an animation to the specified target weight

Parameters:

	animRestart	enable this, if you want to restart the clip (if it runs already) before fading it to the target weight
	fadeOutRunningAnims	enable this, if all currently running clips should fade out

fade a mix of animations to a weight

Fades a mix of animations to the specified target weight

Parameters:

	animRestart	enable this, if you want to restart currently running clips before fading them to the target weight
	fadeOutRunningAnims	enable this, if all currently running clips should fade out

fade a mix of animations to various weights

Fades a mix of animations to the specified target weights

Parameters:

	animRestart	enable this, if you want to restart currently running clips before fading them to the target weights
	fadeOutRunningAnims	enable this, if all currently running clips should fade out

fade all running animations out

Fade out all animation clips with a weight > 0.0f

fades running clips of the given type out

Fade out all animation clips with a weight > 0.0f, if they are running as Base- or Overlay-Animation

Parameters:

type

specify which animation type should fade out (Base- or Overlay-Animations)

called when transform matrix changed

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

Reimplemented from Graphics::GraphicsEntity.

called to render a debug visualization of the entity

Render our debug visualization (the bounding box).

Reimplemented from Graphics::GraphicsEntity.

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.

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 Graphics::CameraEntity, Lighting::GlobalLightEntity, and Lighting::SpotLightEntity.

create a clone of the entity

This method is called to create an exact clone of this graphics entity. The new entity will not be attached to a stage.

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.

called when attached to a Cell

This method is called when the graphics entity is attached to a cell inside a stage. When entity travel through the graphics world, they will be remove and attached themselves from and to Cells as they cross Cell borders.

called when removed from a Cell

Called when the graphics entity is removed from a cell inside a stage.

called when the entity becomes visible

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

called when the entity becomes invisible

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

called before the entity is rendered

This method is called on the graphics entity to render itself. This method will only be called if the entity is visible through the camera of the currently rendered View.

update our position in the cell hierarchy

This method is called from OnUpdate() when either the entity's transformation or bounding box has changed. It checks if the entity still fits into its current cell, and if not, moves the entity in a new cell.

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.