Rebel Fork Framework
Urho3D::AnimatedModel Class Reference

Animated model component. More...

#include <Urho3D/Graphics/AnimatedModel.h>

Inheritance diagram for Urho3D::AnimatedModel:
Urho3D::StaticModel Urho3D::Drawable Urho3D::Component Urho3D::PipelineStateTracker Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 AnimatedModel (Context *context)
 Construct.
 
 ~AnimatedModel () override
 Destruct.
 
void ApplyAttributes () override
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
 
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, const Matrix3x4 &worldTransform, ea::span< const Matrix3x4 > boneWorldTransforms, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
 
void ProcessRayQuery (const RayOctreeQuery &query, ea::vector< RayQueryResult > &results) override
 Process octree raycast. May be called from a worker thread.
 
void Update (const FrameInfo &frame) override
 Update before octree reinsertion. Is called from a worker thread.
 
void UpdateBatches (const FrameInfo &frame) override
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
 
void UpdateGeometry (const FrameInfo &frame) override
 Prepare geometry for rendering. Called from a worker thread if possible (no GPU update).
 
UpdateGeometryType GetUpdateGeometryType () override
 Return whether a geometry update is necessary, and if it can happen in a worker thread.
 
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
 
void SetModel (Model *model, bool createBones)
 Set model.
 
void SetModel (Model *model) override
 Set model and create bone nodes.
 
void SetAnimationLodBias (float bias)
 
void SetUpdateInvisible (bool enable)
 
void SetMorphWeight (unsigned index, float weight)
 Set vertex morph weight by index.
 
void SetMorphWeight (const ea::string &name, float weight)
 
void SetMorphWeight (StringHash nameHash, float weight)
 Set vertex morph weight by name hash.
 
void ResetMorphWeights ()
 Reset all vertex morphs to zero.
 
void ResetBones ()
 Reset node transforms of skeleton bones.
 
void ApplyAnimation ()
 Apply all animation states to nodes.
 
void ConnectToAnimationStateSource (AnimationStateSource *source)
 Connect to AnimationStateSource that provides animation states.
 
SkeletonGetSkeleton ()
 
float GetAnimationLodBias () const
 
bool GetUpdateInvisible () const
 
const ea::vector< ModelMorph > & GetMorphs () const
 Return all vertex morphs.
 
const ea::vector< SharedPtr< VertexBuffer > > & GetMorphVertexBuffers () const
 Return all morph vertex buffers.
 
unsigned GetNumMorphs () const
 
float GetMorphWeight (unsigned index) const
 Return vertex morph weight by index.
 
float GetMorphWeight (const ea::string &name) const
 
float GetMorphWeight (StringHash nameHash) const
 Return vertex morph weight by name hash.
 
bool IsMaster () const
 Return whether is the master (first) animated model.
 
void SetModelAttr (const ResourceRef &value)
 Set model attribute.
 
void SetBonesEnabledAttr (const VariantVector &value)
 Set bones' animation enabled attribute.
 
void SetMorphsAttr (const ea::vector< unsigned char > &value)
 Set morphs attribute.
 
ResourceRef GetModelAttr () const
 Return model attribute.
 
VariantVector GetBonesEnabledAttr () const
 Return bones' animation enabled attribute.
 
const ea::vector< unsigned char > & GetMorphsAttr () const
 Return morphs attribute.
 
const ea::vector< ea::vector< unsigned > > & GetGeometryBoneMappings () const
 Return per-geometry bone mappings.
 
const ea::vector< ea::vector< Matrix3x4 > > & GetGeometrySkinMatrices () const
 Return per-geometry skin matrices. If empty, uses global skinning.
 
void UpdateBoneBoundingBox ()
 Recalculate the bone bounding box. Normally called internally, but can also be manually called if up-to-date information before rendering is necessary.
 
- Public Member Functions inherited from Urho3D::StaticModel
 StaticModel (Context *context)
 Construct.
 
 ~StaticModel () override
 Destruct.
 
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, const Matrix3x4 &worldTransform, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
 
void ProcessRayQuery (const RayOctreeQuery &query, ea::vector< RayQueryResult > &results) override
 Process octree raycast. May be called from a worker thread.
 
void UpdateBatches (const FrameInfo &frame) override
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
 
GeometryGetLodGeometry (unsigned batchIndex, unsigned level) override
 Return the geometry for a specific LOD level.
 
unsigned GetNumOccluderTriangles () override
 Return number of occlusion geometry triangles.
 
bool DrawOcclusion (OcclusionBuffer *buffer) override
 Draw to occlusion buffer. Return true if did not run out of triangles.
 
virtual void SetMaterial (Material *material)
 
virtual bool SetMaterial (unsigned index, Material *material)
 
void SetOcclusionLodLevel (unsigned level)
 
void ApplyMaterialList (const ea::string &fileName=EMPTY_STRING)
 Apply default materials from a material list file. If filename is empty (default), the model's resource name with extension .txt will be used.
 
ModelGetModel () const
 
unsigned GetNumGeometries () const
 
virtual MaterialGetMaterial () const
 
virtual MaterialGetMaterial (unsigned index) const
 
unsigned GetOcclusionLodLevel () const
 
bool IsInside (const Vector3 &point) const
 Determines if the given world space point is within the model geometry.
 
bool IsInsideLocal (const Vector3 &point) const
 Determines if the given local space point is within the model geometry.
 
void SetModelAttr (const ResourceRef &value)
 Set model attribute.
 
void SetMaterialsAttr (const ResourceRefList &value)
 Set materials attribute.
 
ResourceRef GetModelAttr () const
 Return model attribute.
 
const ResourceRefListGetMaterialsAttr () const
 Return materials attribute.
 
void SetBakeLightmap (bool bakeLightmap)
 Set whether the lightmap is baked for this object.
 
bool GetBakeLightmap () const
 Return whether the lightmap is baked for this object.
 
bool GetBakeLightmapEffective () const
 Return whether the lightmap is baked for this object. Return false for objects with zero scale in lightmap.
 
void SetScaleInLightmap (float scale)
 Set scale in lightmap.
 
float GetScaleInLightmap () const
 Return scale in lightmap.
 
void SetLightmapIndex (unsigned idx)
 Set lightmap index.
 
unsigned GetLightmapIndex () const
 Return lightmap index.
 
void SetLightmapScaleOffset (const Vector4 &scaleOffset)
 Set lightmap scale and offset.
 
const Vector4GetLightmapScaleOffset () const
 Return lightmap scale and offset.
 
- Public Member Functions inherited from Urho3D::Drawable
 Drawable (Context *context, DrawableFlags drawableFlags=DRAWABLE_UNDEFINED)
 Construct.
 
 ~Drawable () override
 Destruct.
 
void OnSetEnabled () override
 Handle enabled/disabled state change.
 
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
 
virtual void UpdateBatchesDelayed (const FrameInfo &frame)
 Batch update from main thread. Called on demand only if RequestUpdateBatchesDelayed() is called from UpdateBatches().
 
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
 
void SetDrawDistance (float distance)
 
void SetShadowDistance (float distance)
 
void SetLodBias (float bias)
 
void SetViewMask (unsigned mask)
 
void SetLightMask (unsigned mask)
 
void SetShadowMask (unsigned mask)
 
void SetZoneMask (unsigned mask)
 
void SetCastShadows (bool enable)
 
void SetOccluder (bool enable)
 
void SetOccludee (bool enable)
 
void SetGlobalIlluminationType (GlobalIlluminationType type)
 Set GI type.
 
void SetReflectionMode (ReflectionMode mode)
 Set reflection mode.
 
void MarkForUpdate ()
 Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
 
const BoundingBoxGetBoundingBox () const
 
const BoundingBoxGetWorldBoundingBox ()
 
DrawableFlags GetDrawableFlags () const
 Return drawable flags.
 
float GetDrawDistance () const
 
float GetShadowDistance () const
 
float GetLodBias () const
 
unsigned GetViewMask () const
 
unsigned GetLightMask () const
 
unsigned GetShadowMask () const
 
unsigned GetZoneMask () const
 
bool GetCastShadows () const
 
bool IsOccluder () const
 
bool IsOccludee () const
 
GlobalIlluminationType GetGlobalIlluminationType () const
 Return global illumination type.
 
ReflectionMode GetReflectionMode () const
 Return reflection mode.
 
bool IsInView () const
 
bool IsInView (Camera *camera) const
 Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
 
const ea::vector< SourceBatch > & GetBatches () const
 Return draw call source data.
 
void SetZone (Zone *zone, bool temporary=false)
 Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
 
void SetSortValue (float value)
 Set sorting value.
 
void MarkInView (const FrameInfo &frame)
 Mark in view. Also clear the light list.
 
void MarkInView (unsigned frameNumber)
 Mark in view without specifying a camera. Used for shadow casters.
 
OctantGetOctant () const
 Return octree octant.
 
unsigned GetDrawableIndex () const
 Return index in octree.
 
bool IsInOctree () const
 Return whether the drawable is added to Octree.
 
ZoneGetZone () const
 
bool IsZoneDirty () const
 Return whether current zone is inconclusive or dirty due to the drawable moving.
 
float GetDistance () const
 Return distance from camera.
 
float GetLodDistance () const
 Return LOD scaled distance from camera.
 
float GetSortValue () const
 Return sorting value.
 
bool IsInView (const FrameInfo &frame, bool anyCamera=false) const
 Return whether is in view on the current frame. Called by View.
 
unsigned & GetMutableLightProbeTetrahedronHint ()
 Return mutable light probe tetrahedron hint.
 
CachedDrawableZoneGetMutableCachedZone ()
 Return mutable cached zone data.
 
CachedDrawableReflectionGetMutableCachedReflection ()
 Return mutable cached reflection data.
 
unsigned GetLightMaskInZone () const
 Return combined light masks of Drawable and its currently cached Zone.
 
unsigned GetShadowMaskInZone () const
 Return combined shadow masks of Drawable and its currently cached Zone.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
 ~Component () override
 Destruct.
 
AttributeScopeHint GetEffectiveScopeHint () const
 
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
 
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
 
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
 
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
 
virtual bool HasAuxiliaryData () const
 
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
 
void SetEnabled (bool enable)
 
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
 
unsigned GetID () const
 
Node * GetNode () const
 
SceneGetScene () const
 Return the scene the node belongs to.
 
bool IsEnabled () const
 
bool IsEnabledEffective () const
 
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
 
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
 
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
 
unsigned GetIndexInParent () const
 Return index of this component in the node.
 
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
 
 ~Serializable () override
 Destruct.
 
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
 
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
 
virtual ObjectReflectionGetReflection () const
 Return reflection used for serialization.
 
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
 
void SerializeInBlock (Archive &archive, bool serializeTemporary)
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
 
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
 
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
 
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
 
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
 
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
 
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
 
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
 
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
 
void ResetToDefault ()
 Reset all editable attributes to their default values.
 
void RemoveInstanceDefault ()
 Remove instance's default values if they are set previously.
 
void SetTemporary (bool enable)
 
Variant GetAttribute (unsigned index) const
 
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
 
bool IsTemporary () const
 
- 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 TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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.
 
VariantMapGetEventDataMap () 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.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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.
 
- Public Member Functions inherited from Urho3D::PipelineStateTracker
virtual ~PipelineStateTracker ()
 Destruct.
 
unsigned GetPipelineStateHash () const
 Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.
 
void MarkPipelineStateHashDirty ()
 Mark pipeline state hash as dirty.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::StaticModel
static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Drawable
static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Protected Member Functions

void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
 
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.
 
void OnWorldBoundingBoxUpdate () override
 Recalculate the world-space bounding box. More...
 
- Protected Member Functions inherited from Urho3D::StaticModel
void OnWorldBoundingBoxUpdate () override
 Recalculate the world-space bounding box.
 
void SetBoundingBox (const BoundingBox &box)
 Set local-space bounding box.
 
void SetNumGeometries (unsigned num)
 Set number of geometries.
 
void ResetLodLevels ()
 Reset LOD levels.
 
void CalculateLodLevels ()
 Choose LOD levels based on distance.
 
void UpdateBatchesLightmaps ()
 Update lightmaps in batches.
 
- Protected Member Functions inherited from Urho3D::Drawable
unsigned RecalculatePipelineStateHash () const override
 Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
 
void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
 
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
 
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.
 
virtual void OnRemoveFromOctree ()
 Handle removal from octree.
 
void AddToOctree ()
 Add to octree.
 
void RemoveFromOctree ()
 Remove from octree.
 
void RequestUpdateBatchesDelayed (const FrameInfo &frame)
 Request UpdateBatchesDelayed call from main thread.
 
void SetOctant (Octant *octant)
 Move into another octree octant.
 
void SetDrawableIndex (unsigned drawableIndex)
 Update drawable index.
 
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
 
void SetID (unsigned id)
 
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
 
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
 
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
 
- Protected Member Functions inherited from Urho3D::PipelineStateTracker
PipelineStateSubscription CreateDependency (PipelineStateTracker *dependency)
 Create dependency onto another pipeline state.
 
void AddSubscriberReference (PipelineStateTracker *subscriber)
 Add reference to subscriber pipeline state tracker.
 
void RemoveSubscriberReference (PipelineStateTracker *subscriber)
 Remove reference to subscriber pipeline state tracker.
 

Private Member Functions

 URHO3D_OBJECT (AnimatedModel, StaticModel)
 
void AssignBoneNodes ()
 Assign skeleton and animation bone node references as a postprocess. Called by ApplyAttributes.
 
void FinalizeBoneBoundingBoxes ()
 Finalize master model bone bounding boxes by merging from matching non-master bones.. Performed whenever any of the AnimatedModels in the same node changes its model.
 
void RemoveRootBone ()
 Remove (old) skeleton root bone.
 
void MarkAnimationDirty ()
 Mark animation and skinning to require an update.
 
void MarkMorphsDirty ()
 Mark morphs to require an update.
 
void SetSkeleton (const Skeleton &skeleton, bool createBones)
 Set skeleton.
 
void SetGeometryBoneMappings ()
 Set mapping of subgeometry bone indices.
 
void CloneGeometries ()
 Clone geometries for vertex morphing.
 
void HandleModelReloadFinished (StringHash eventType, VariantMap &eventData)
 Handle model reload finished.
 
void UpdateSoftwareSkinningState ()
 Reconsider whether to use software skinning.
 
bool PrepareForThreadedUpdate (Camera *camera, unsigned frameNumber)
 
bool UpdateAndCheckAnimationTimers (float timeStep)
 
void InitializeLocalBoneTransforms (bool reset)
 
void CalculateFinalBoneTransforms ()
 
void CalculateLocalBoundingBox ()
 
void CalculateAnimations ()
 
void ApplyBoneTransformsToNodes ()
 
void UpdateSkinning ()
 
void UpdateMorphs ()
 

Private Attributes

Skeleton skeleton_
 Skeleton.
 
ea::vector< ModelAnimationOutputskeletonData_
 Animation data of Skeleton, used only during Update.
 
WeakPtr< AnimationStateSourceanimationStateSource_
 Component that provides animation states for the model.
 
SharedPtr< SoftwareModelAnimatormodelAnimator_
 Software model animator.
 
ea::vector< ModelMorphmorphs_
 Vertex morphs.
 
ea::vector< Matrix3x4skinMatrices_
 Skinning matrices.
 
ea::vector< ea::vector< unsigned > > geometryBoneMappings_
 Mapping of subgeometry bone indices, used if more bones than skinning shader can manage.
 
ea::vector< ea::vector< Matrix3x4 > > geometrySkinMatrices_
 Subgeometry skinning matrices, used if more bones than skinning shader can manage.
 
ea::vector< ea::vector< Matrix3x4 * > > geometrySkinMatrixPtrs_
 Subgeometry skinning matrix pointers, if more bones than skinning shader can manage.
 
BoundingBox boneBoundingBox_
 Bounding box calculated from bones.
 
VectorBuffer attrBuffer_
 Attribute buffer.
 
unsigned animationLodFrameNumber_
 The frame number animation LOD distance was last calculated on.
 
float animationLodBias_
 Animation LOD bias.
 
float animationLodTimer_
 Animation LOD timer.
 
float animationLodDistance_
 Animation LOD distance, the minimum of all LOD view distances last frame.
 
bool updateInvisible_
 Update animation when invisible flag.
 
bool softwareSkinning_ {}
 Software skinning flag.
 
unsigned numSoftwareSkinningBones_ { 4 }
 Number of bones used for software skinning.
 
bool isMaster_
 Master model flag.
 
bool assignBonesPending_
 Bone nodes assignment pending flag.
 
bool forceAnimationUpdate_
 Force animation update after becoming visible flag.
 
bool animationDirty_ {}
 
bool morphsDirty_ {}
 
bool skinningDirty_ {true}
 
bool boneBoundingBoxDirty_ {true}
 

Friends

class AnimationState
 

Additional Inherited Members

- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 
- Static Protected Member Functions inherited from Urho3D::Drawable
static GeometryGetGeometryIfNotEmpty (Geometry *geometry)
 Get Geometry pointer if the source one is not null or empty.
 
- Protected Attributes inherited from Urho3D::StaticModel
ea::vector< StaticModelGeometryDatageometryData_
 Extra per-geometry data.
 
ea::vector< ea::vector< SharedPtr< Geometry > > > geometries_
 All geometries.
 
SharedPtr< Modelmodel_
 Model.
 
unsigned occlusionLodLevel_
 Occlusion LOD level.
 
ResourceRefList materialsAttr_
 Material list attribute.
 
bool bakeLightmap_ {}
 Whether the lightmap is enabled.
 
float scaleInLightmap_ { 1.0f }
 Texel density scale in lightmap.
 
unsigned lightmapIndex_ {}
 Lightmap index.
 
Vector4 lightmapScaleOffset_ { 1.0f, 1.0f, 0.0f, 0.0f }
 Lightmap scale and offset.
 
- Protected Attributes inherited from Urho3D::Drawable
BoundingBox worldBoundingBox_
 World-space bounding box.
 
BoundingBox boundingBox_
 Local-space bounding box.
 
ea::vector< SourceBatchbatches_
 Draw call source data.
 
DrawableFlags drawableFlags_
 Drawable flags.
 
GlobalIlluminationType giType_ {}
 Global illumination type.
 
ReflectionMode reflectionMode_ {ReflectionMode::BlendProbesAndZone}
 Reflection mode.
 
bool worldBoundingBoxDirty_
 Bounding box dirty flag.
 
bool castShadows_
 Shadowcaster flag.
 
bool occluder_
 Occluder flag.
 
bool occludee_
 Occludee flag.
 
bool updateQueued_
 Octree update queued flag.
 
bool zoneDirty_
 Zone inconclusive or dirtied flag.
 
Octantoctant_
 Octree octant.
 
unsigned drawableIndex_ { M_MAX_UNSIGNED }
 Index of Drawable in Scene. May be updated.
 
CachedDrawableZone cachedZone_
 Current zone.
 
CachedDrawableReflection cachedReflection_
 Current reflection.
 
unsigned viewMask_
 View mask.
 
unsigned lightMask_
 Light mask.
 
unsigned shadowMask_
 Shadow mask.
 
unsigned zoneMask_
 Zone mask.
 
unsigned viewFrameNumber_
 Last visible frame number.
 
float distance_
 Current distance to camera.
 
float lodDistance_
 LOD scaled distance.
 
float drawDistance_
 Draw distance.
 
float shadowDistance_
 Shadow distance.
 
float sortValue_
 Current sort value.
 
float lodBias_
 LOD bias.
 
unsigned lightProbeTetrahedronHint_ { M_MAX_UNSIGNED }
 Light probe tetrahedron hint.
 
ea::vector< Camera * > viewCameras_
 List of cameras from which is seen on the current frame.
 
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
 
unsigned id_
 Unique ID within the scene.
 
bool networkUpdate_
 Network update queued flag.
 
bool enabled_
 Enabled flag.
 
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
 
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
 
bool temporary_
 Temporary flag.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Animated model component.

Member Function Documentation

◆ CalculateLocalBoundingBox()

void Urho3D::AnimatedModel::CalculateLocalBoundingBox ( )
private

◆ GetAnimationLodBias()

float Urho3D::AnimatedModel::GetAnimationLodBias ( ) const
inline

Return animation LOD bias.

◆ GetMorphWeight()

float Urho3D::AnimatedModel::GetMorphWeight ( const ea::string &  name) const

Return vertex morph weight by name.

◆ GetNumMorphs()

unsigned Urho3D::AnimatedModel::GetNumMorphs ( ) const
inline

Return number of vertex morphs.

◆ GetSkeleton()

Skeleton& Urho3D::AnimatedModel::GetSkeleton ( )
inline

Return skeleton.

◆ GetUpdateInvisible()

bool Urho3D::AnimatedModel::GetUpdateInvisible ( ) const
inline

Return whether to update animation when not visible.

◆ OnWorldBoundingBoxUpdate()

void Urho3D::AnimatedModel::OnWorldBoundingBoxUpdate ( )
overrideprotectedvirtual

Recalculate the world-space bounding box.

Implements Urho3D::Drawable.

◆ PrepareForThreadedUpdate()

bool Urho3D::AnimatedModel::PrepareForThreadedUpdate ( Camera camera,
unsigned  frameNumber 
)
private

Animation update sequence. Called from Update whenever possible, and from UpdateGeometry in other cases.

◆ RegisterObject()

void Urho3D::AnimatedModel::RegisterObject ( Context context)
static

Register object factory. Drawable must be registered first.

◆ SetAnimationLodBias()

void Urho3D::AnimatedModel::SetAnimationLodBias ( float  bias)

Set animation LOD bias.

◆ SetMorphWeight()

void Urho3D::AnimatedModel::SetMorphWeight ( const ea::string &  name,
float  weight 
)

Set vertex morph weight by name.

◆ SetUpdateInvisible()

void Urho3D::AnimatedModel::SetUpdateInvisible ( bool  enable)

Set whether to update animation and the bounding box when not visible. Recommended to enable for physically controlled models like ragdolls.

Member Data Documentation

◆ animationDirty_

bool Urho3D::AnimatedModel::animationDirty_ {}
private

Dirty flags used in animation update sequence.


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