Class for software model animation (morphing and skinning). More...

#include <Urho3D/Graphics/SoftwareModelAnimator.h>

Inheritance diagram for Urho3D::SoftwareModelAnimator:

Public Member Functions
	SoftwareModelAnimator (Context *context)
	Construct.

	~SoftwareModelAnimator () override
	Destruct.

void	Initialize (Model *model, bool skinned, unsigned numBones)
	Initialize with model. Shall be manually called on model reload.

void	ResetAnimation ()
	Reset morph and/or skeletal animation. Safe to call from worker thread.

void	ApplyMorphs (ea::span< const ModelMorph > morphs)
	Apply morphs. Safe to call from worker thread.

void	ApplySkinning (ea::span< const Matrix3x4 > worldTransforms)
	Apply skinning.

void	Commit ()
	Commit data to GPU.

const ea::vector< ea::vector< SharedPtr< Geometry > > > &	GetGeometries () const
	Return animated geometries.

const ea::vector< SharedPtr< VertexBuffer > > &	GetVertexBuffers () const
	Return all cloned vertex buffers.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.

bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Attributes
static const unsigned	MaxBones = 4
	Max number of bones.

Private Member Functions
	URHO3D_OBJECT (SoftwareModelAnimator, Object)

VertexMaskFlags	GetMorphElementMask () const
	Return morph mask.

void	CloneModelGeometries ()
	Clone model geometries.

void	InitializeAnimationData ()
	Initialize skeletal animation data.

void	CopyMorphVertices (void destVertexData, const void srcVertexData, unsigned vertexCount, VertexBuffer destBuffer, VertexBuffer srcBuffer) const
	Copy morph vertices.

void	ApplyMorph (VertexBuffer *buffer, const VertexBufferMorph &morph, float weight)
	Apply a vertex buffer morph.

template<bool SkinNormals, bool SkinTangents>
void	ApplyVertexBufferSkinning (VertexBuffer *clonedBuffer, const VertexBufferAnimationData &animationData, ea::span< const Matrix3x4 > worldTransforms) const
	Apply skinning for given vertex buffer.

Private Attributes
SharedPtr< Model >	originalModel_
	Original model.

ea::vector< SharedPtr< VertexBuffer > >	vertexBuffers_
	Animated model vertex buffers.

ea::vector< ea::vector< SharedPtr< Geometry > > >	geometries_
	Animated model geometries.

bool	skinned_ {}
	Whether CPU skinning is applied.

unsigned	numBones_ {}
	Number of bones used for skeletal animation.

ea::vector< VertexBufferAnimationData >	vertexBuffersData_
	Animation data for vertex buffers.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Class for software model animation (morphing and skinning).

The documentation for this class was generated from the following files:

Urho3D/Graphics/SoftwareModelAnimator.h
Urho3D/Graphics/SoftwareModelAnimator.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description