Urho3D
|
Animated model component. More...
#include <AnimatedModel.h>
Public Member Functions | |
AnimatedModel (Context *context) | |
Construct. | |
virtual | ~AnimatedModel () |
Destruct. | |
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 void | ApplyAttributes () |
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. | |
virtual void | ProcessRayQuery (const RayOctreeQuery &query, PODVector< RayQueryResult > &results) |
Process octree raycast. May be called from a worker thread. | |
virtual void | Update (const FrameInfo &frame) |
Update before octree reinsertion. Is called from a worker thread. Needs to be requested with MarkForUpdate(). | |
virtual void | UpdateBatches (const FrameInfo &frame) |
Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly. | |
virtual void | UpdateGeometry (const FrameInfo &frame) |
Prepare geometry for rendering. Called from a worker thread if possible (no GPU update.) | |
virtual UpdateGeometryType | GetUpdateGeometryType () |
Return whether a geometry update is necessary, and if it can happen in a worker thread. | |
virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
Visualize the component as debug geometry. | |
void | SetModel (Model *model, bool createBones=true) |
Set model. | |
AnimationState * | AddAnimationState (Animation *animation) |
Add an animation. | |
void | RemoveAnimationState (Animation *animation) |
Remove an animation by animation pointer. | |
void | RemoveAnimationState (const String &animationName) |
Remove an animation by animation name. | |
void | RemoveAnimationState (StringHash animationNameHash) |
Remove an animation by animation name hash. | |
void | RemoveAnimationState (AnimationState *state) |
Remove an animation by AnimationState pointer. | |
void | RemoveAnimationState (unsigned index) |
Remove an animation by index. | |
void | RemoveAllAnimationStates () |
Remove all animations. | |
void | SetAnimationLodBias (float bias) |
Set animation LOD bias. | |
void | SetInvisibleLodFactor (float factor) |
Set animation LOD distance factor when not visible (default 0 = do not update at all when invisible.) | |
void | SetMorphWeight (unsigned index, float weight) |
Set vertex morph weight by index. | |
void | SetMorphWeight (const String &name, float weight) |
Set vertex morph weight by name. | |
void | SetMorphWeight (StringHash nameHash, float weight) |
Set vertex morph weight by name hash. | |
void | ResetMorphWeights () |
Reset all vertex morphs to zero. | |
Skeleton & | GetSkeleton () |
Return skeleton. | |
const Vector< SharedPtr < AnimationState > > & | GetAnimationStates () const |
Return all animation states. | |
unsigned | GetNumAnimationStates () const |
Return number of animation states. | |
AnimationState * | GetAnimationState (Animation *animation) const |
Return animation state by animation pointer. | |
AnimationState * | GetAnimationState (const String &animationName) const |
Return animation state by animation name. | |
AnimationState * | GetAnimationState (const StringHash animationNameHash) const |
Return animation state by animation name hash. | |
AnimationState * | GetAnimationState (unsigned index) const |
Return animation state by index. | |
float | GetAnimationLodBias () const |
Return animation LOD bias. | |
float | GetInvisibleLodFactor () const |
Return animation LOD distance factor when not visible. | |
const Vector< ModelMorph > & | GetMorphs () const |
Return all vertex morphs. | |
const Vector< SharedPtr < VertexBuffer > > & | GetMorphVertexBuffers () const |
Return all morph vertex buffers. | |
unsigned | GetNumMorphs () const |
Return number of vertex morphs. | |
float | GetMorphWeight (unsigned index) const |
Return vertex morph weight by index. | |
float | GetMorphWeight (const String &name) const |
Return vertex morph weight by name. | |
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 (ResourceRef value) |
Set model attribute. | |
void | SetBonesEnabledAttr (VariantVector value) |
Set bones' animation enabled attribute. | |
void | SetAnimationStatesAttr (VariantVector value) |
Set animation states attribute. | |
void | SetMorphsAttr (const PODVector< unsigned char > &value) |
Set morphs attribute. | |
ResourceRef | GetModelAttr () const |
Return model attribute. | |
VariantVector | GetBonesEnabledAttr () const |
Return bones' animation enabled attribute. | |
VariantVector | GetAnimationStatesAttr () const |
Return animation states attribute. | |
const PODVector< unsigned char > & | GetMorphsAttr () const |
Return morphs attribute. | |
const Vector< PODVector < unsigned > > & | GetGeometryBoneMappings () const |
Return per-geometry bone mappings. | |
const Vector< PODVector < Matrix3x4 > > & | GetGeometrySkinMatrices () const |
Return per-geometry skin matrices. If empty, uses global skinning. | |
![]() | |
StaticModel (Context *context) | |
Construct. | |
~StaticModel () | |
Destruct. | |
virtual Geometry * | GetLodGeometry (unsigned batchIndex, unsigned level) |
Return the geometry for a specific LOD level. | |
virtual unsigned | GetNumOccluderTriangles () |
Return number of occlusion geometry triangles. | |
virtual bool | DrawOcclusion (OcclusionBuffer *buffer) |
Draw to occlusion buffer. Return true if did not run out of triangles. | |
void | SetModel (Model *model) |
Set model. | |
void | SetMaterial (Material *material) |
Set material on all geometries. | |
bool | SetMaterial (unsigned index, Material *material) |
Set material on one geometry. Return true if successful. | |
void | SetOcclusionLodLevel (unsigned level) |
Set occlusion LOD level. By default (M_MAX_UNSIGNED) same as visible. | |
Model * | GetModel () const |
Return model. | |
const BoundingBox & | GetBoundingBox () const |
Return model's bounding box. | |
unsigned | GetNumGeometries () const |
Return number of geometries. | |
Material * | GetMaterial (unsigned index) const |
Return material by geometry index. | |
unsigned | GetOcclusionLodLevel () const |
Return occlusion LOD level. | |
void | SetMaterialsAttr (const ResourceRefList &value) |
Set materials attribute. | |
const ResourceRefList & | GetMaterialsAttr () const |
Return materials attribute. | |
![]() | |
Drawable (Context *context, unsigned char drawableFlags) | |
Construct. | |
virtual | ~Drawable () |
Destruct. | |
void | SetDrawDistance (float distance) |
Set draw distance. | |
void | SetShadowDistance (float distance) |
Set shadow draw distance. | |
void | SetLodBias (float bias) |
Set LOD bias. | |
void | SetViewMask (unsigned mask) |
Set view mask. Is and'ed with camera's view mask to see if the object should be rendered. | |
void | SetLightMask (unsigned mask) |
Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit. | |
void | SetShadowMask (unsigned mask) |
Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map. | |
void | SetZoneMask (unsigned mask) |
Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone. | |
void | SetMaxLights (unsigned num) |
Set maximum number of per-pixel lights. Default 0 is unlimited. | |
void | SetVisible (bool enable) |
Set visible flag. | |
void | SetCastShadows (bool enable) |
Set shadowcaster flag. | |
void | SetOccluder (bool enable) |
Set occlusion flag. | |
void | SetOccludee (bool enable) |
Set occludee flag. | |
void | MarkForUpdate () |
Mark for update before octree reinsertion. | |
const BoundingBox & | GetWorldBoundingBox () |
Return world bounding box. | |
unsigned char | GetDrawableFlags () const |
Return drawable flags. | |
float | GetDrawDistance () const |
Return draw distance. | |
float | GetShadowDistance () const |
Return shadow draw distance. | |
float | GetLodBias () const |
Return LOD bias. | |
unsigned | GetViewMask () const |
Return view mask. | |
unsigned | GetLightMask () const |
Return light mask. | |
unsigned | GetShadowMask () const |
Return shadow mask. | |
unsigned | GetZoneMask () const |
Return zone mask. | |
unsigned | GetMaxLights () const |
Return maximum number of per-pixel lights. | |
bool | IsVisible () const |
Return visible flag. | |
bool | GetCastShadows () const |
Return shadowcaster flag. | |
bool | IsOccluder () const |
Return occluder flag. | |
bool | IsOccludee () const |
Return occludee flag. | |
const Vector< SourceBatch > & | GetBatches () const |
Return draw call source data. | |
void | SetZone (Zone *zone, bool temporary=false) |
Set new zone. | |
void | SetSortValue (float value) |
Set sorting value. | |
void | SetMinMaxZ (float minZ, float maxZ) |
Set view-space depth bounds. | |
void | MarkInView (const FrameInfo &frame, bool mainView=true) |
Mark in view (either the main camera, or a shadow camera view) this frame. | |
void | ClearLights () |
Clear lights and base pass flags for a new frame. | |
void | AddLight (Light *light) |
Add a per-pixel light. | |
void | AddVertexLight (Light *light) |
Add a per-vertex light. | |
void | LimitLights () |
Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights. | |
void | LimitVertexLights () |
Sort and limit per-vertex lights to maximum allowed. | |
void | SetBasePass (unsigned batchIndex) |
Set base pass flag for a batch. | |
Octant * | GetOctant () const |
Return octree octant. | |
Zone * | GetZone () const |
Return current zone. | |
Zone * | GetLastZone () const |
Return previous zone. | |
float | GetDistance () const |
Return distance from camera. | |
float | GetLodDistance () const |
Return LOD scaled distance from camera. | |
float | GetSortValue () const |
Return sorting value. | |
bool | IsInView (unsigned frameNumber) const |
Return whether is in view this frame. | |
bool | IsInView (const FrameInfo &frame, bool mainView=true) const |
Return whether is visible in a specific view this frame. | |
bool | HasBasePass (unsigned batchIndex) const |
Return whether has a base pass. | |
const PODVector< Light * > & | GetLights () const |
Return per-pixel lights. | |
const PODVector< Light * > & | GetVertexLights () const |
Return per-vertex lights. | |
Light * | GetFirstLight () const |
Return the first added per-pixel light. | |
float | GetMinZ () const |
Return the minimum view-space depth. | |
float | GetMaxZ () const |
Return the maximum view-space depth. | |
![]() | |
Component (Context *context) | |
Construct. | |
virtual | ~Component () |
Destruct. | |
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
Handle attribute write access. | |
virtual bool | Save (Serializer &dest) |
Save as binary data. Return true if successful. | |
virtual bool | SaveXML (XMLElement &dest) |
Save as XML data. Return true if successful. | |
virtual void | GetDependencyNodes (PODVector< Node * > &dest) |
Return the depended on nodes to order network updates. | |
void | Remove () |
Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. | |
unsigned | GetID () const |
Return ID. | |
Node * | GetNode () const |
Return scene node. | |
Scene * | GetScene () const |
Return the scene the node belongs to. | |
void | GetComponents (PODVector< Component * > &dest, ShortStringHash type) const |
Return components in the same scene node by type. | |
Component * | GetComponent (ShortStringHash 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. | |
template<class T > | |
void | GetComponents (PODVector< T * > &dest) const |
Template version of returning components in the same scene node by type. | |
void | AddReplicationState (ComponentReplicationState *state) |
Add a replication state that is tracking this component. | |
void | PrepareNetworkUpdate () |
Prepare network update by comparing attributes and marking replication states dirty as necessary. | |
void | CleanupConnection (Connection *connection) |
Clean up all references to a network connection that is about to be removed. | |
void | MarkNetworkUpdate () |
Mark for attribute check on the next network update. | |
![]() | |
Serializable (Context *context) | |
Construct. | |
virtual | ~Serializable () |
Destruct. | |
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) |
Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor. | |
bool | SetAttribute (unsigned index, const Variant &value) |
Set attribute by index. Return true if successfully set. | |
bool | SetAttribute (const String &name, const Variant &value) |
Set attribute by name. Return true if successfully set. | |
void | AllocateNetworkState () |
Allocate network attribute state. | |
void | WriteInitialDeltaUpdate (Serializer &dest) |
Write initial delta network update. | |
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits) |
Write a delta network update according to dirty attribute bits. | |
void | WriteLatestDataUpdate (Serializer &dest) |
Write a latest data network update. | |
void | ReadDeltaUpdate (Deserializer &source) |
Read and apply a network delta update. | |
void | ReadLatestDataUpdate (Deserializer &source) |
Read and apply a network latest data update. | |
Variant | GetAttribute (unsigned index) |
Return attribute value by index. Return empty if illegal index. | |
Variant | GetAttribute (const String &name) |
Return attribute value by name. Return empty if not found. | |
unsigned | GetNumAttributes () const |
Return number of attributes. | |
unsigned | GetNumNetworkAttributes () const |
Return number of network replication attributes. | |
const Vector< AttributeInfo > * | GetAttributes () const |
Return attribute descriptions, or null if none defined. | |
const Vector< AttributeInfo > * | GetNetworkAttributes () const |
Return network replication attribute descriptions, or null if none defined. | |
![]() | |
Object (Context *context) | |
Construct. | |
virtual | ~Object () |
Destruct. Clean up self from event sender & receiver structures. | |
virtual ShortStringHash | GetType () const =0 |
Return type hash. | |
virtual const String & | GetTypeName () const =0 |
Return type name. | |
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
Handle event. | |
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
Subscribe to an event that can be sent by any sender. | |
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *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 PODVector< StringHash > &exceptions, bool onlyUserData) |
Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.) | |
void | SendEvent (StringHash eventType) |
Send event to all subscribers. | |
void | SendEvent (StringHash eventType, VariantMap &eventData) |
Send event with parameters to all subscribers. | |
Context * | GetContext () const |
Return execution context. | |
Object * | GetSubsystem (ShortStringHash 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. | |
template<class T > | |
T * | GetSubsystem () const |
Template version of returning a subsystem. | |
![]() | |
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. | |
void | AddRef () |
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
void | ReleaseRef () |
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
int | Refs () const |
Return reference count. | |
int | WeakRefs () const |
Return weak reference count. | |
RefCount * | RefCountPtr () |
Return pointer to the reference count structure. |
Static Public Member Functions | |
static void | RegisterObject (Context *context) |
Register object factory. Drawable must be registered first. |
Protected Member Functions | |
virtual void | OnNodeSet (Node *node) |
Handle node being assigned. | |
virtual void | OnMarkedDirty (Node *node) |
Handle node transform being dirtied. | |
virtual void | OnWorldBoundingBoxUpdate () |
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 | AddToOctree () |
Add to octree. | |
void | RemoveFromOctree () |
Remove from octree. | |
void | SetOctant (Octant *octant) |
Move into another octree octant. | |
![]() | |
void | SetID (unsigned id) |
Set ID. Called by Scene. | |
void | SetNode (Node *node) |
Set scene node. Called by Node when creating the component. |
Private Member Functions | |
OBJECT (AnimatedModel) | |
void | AssignBoneNodes () |
Assign skeleton and animation bone node references as a postprocess. Called by ApplyAttributes. | |
void | MarkAnimationDirty () |
Mark animation and skinning to require an update. | |
void | MarkAnimationOrderDirty () |
Mark animation and skinning to require a forced update (blending order changed.) | |
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 | CopyMorphVertices (void *dest, void *src, unsigned vertexCount, VertexBuffer *clone, VertexBuffer *original) |
Copy morph vertices. | |
void | UpdateAnimation (const FrameInfo &frame) |
Recalculate animations. Called from Update(). | |
void | UpdateSkinning () |
Recalculate skinning. | |
void | UpdateMorphs () |
Reapply all vertex morphs. | |
void | ApplyMorph (VertexBuffer *buffer, void *destVertexData, unsigned morphRangeStart, const VertexBufferMorph &morph, float weight) |
Apply a vertex morph. | |
void | HandleModelReloadFinished (StringHash eventType, VariantMap &eventData) |
Handle model reload finished. |
Private Attributes | |
Skeleton | skeleton_ |
Skeleton. | |
Vector< SharedPtr< VertexBuffer > > | morphVertexBuffers_ |
Morph vertex buffers. | |
Vector< ModelMorph > | morphs_ |
Vertex morphs. | |
Vector< SharedPtr < AnimationState > > | animationStates_ |
Animation states. | |
PODVector< Matrix3x4 > | skinMatrices_ |
Skinning matrices. | |
Vector< PODVector< unsigned > > | geometryBoneMappings_ |
Mapping of subgeometry bone indices, used if more bones than skinning shader can manage. | |
Vector< PODVector< Matrix3x4 > > | geometrySkinMatrices_ |
Subgeometry skinning matrices, used if more bones than skinning shader can manage. | |
Vector< PODVector< Matrix3x4 * > > | geometrySkinMatrixPtrs_ |
Subgeometry skinning matrix pointers, if more bones than skinning shader can manage. | |
VectorBuffer | attrBuffer_ |
Attribute buffer. | |
unsigned | animationLodFrameNumber_ |
The frame number animation LOD distance was last calculated on. | |
unsigned | morphElementMask_ |
Morph vertex element mask. | |
float | animationLodBias_ |
Animation LOD bias. | |
float | animationLodTimer_ |
Animation LOD timer. | |
float | animationLodDistance_ |
Animation LOD distance, the minimum of all LOD view distances last frame. | |
float | invisibleLodFactor_ |
Animation LOD distance factor when not visible. | |
bool | animationDirty_ |
Animation dirty flag. | |
bool | animationOrderDirty_ |
Animation order dirty flag. | |
bool | morphsDirty_ |
Vertex morphs dirty flag. | |
bool | skinningDirty_ |
Skinning dirty flag. | |
bool | isMaster_ |
Master model flag. | |
bool | loading_ |
Loading flag. During loading bone nodes are not created, as they will be serialized as child nodes. | |
bool | assignBonesPending_ |
Bone nodes assignment pending flag. |
Friends | |
class | AnimationState |
Additional Inherited Members | |
![]() | |
BoundingBox | boundingBox_ |
Local-space bounding box. | |
PODVector < StaticModelGeometryData > | geometryData_ |
Extra per-geometry data. | |
Vector< Vector< SharedPtr < Geometry > > > | geometries_ |
All geometries. | |
SharedPtr< Model > | model_ |
Model. | |
unsigned | occlusionLodLevel_ |
Occlusion LOD level. | |
ResourceRefList | materialsAttr_ |
Material list attribute. | |
![]() | |
BoundingBox | worldBoundingBox_ |
World bounding box. | |
Vector< SourceBatch > | batches_ |
Draw call source data. | |
unsigned char | drawableFlags_ |
Drawable flags. | |
bool | worldBoundingBoxDirty_ |
Bounding box dirty flag. | |
bool | visible_ |
Visible flag. | |
bool | castShadows_ |
Shadowcaster flag. | |
bool | occluder_ |
Occluder flag. | |
bool | occludee_ |
Occludee flag. | |
bool | updateQueued_ |
Octree update queued flag. | |
bool | reinsertionQueued_ |
Octree reinsertion queued flag. | |
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 | minZ_ |
Current minimum view space depth. | |
float | maxZ_ |
Current maximum view space depth. | |
float | lodBias_ |
LOD bias. | |
unsigned | basePassFlags_ |
Base pass flags. | |
unsigned | maxLights_ |
Maximum lights. | |
Octant * | octant_ |
Octree octant. | |
Light * | firstLight_ |
First per-pixel light added this frame. | |
PODVector< Light * > | lights_ |
Per-pixel lights affecting this drawable. | |
PODVector< Light * > | vertexLights_ |
Per-vertex lights affecting this drawable. | |
WeakPtr< Zone > | zone_ |
Current zone. | |
WeakPtr< Zone > | lastZone_ |
Previous zone. | |
const FrameInfo * | viewFrame_ |
Last view's frameinfo. Not safe to dereference. | |
Camera * | viewCamera_ |
Last view's camera. Not safe to dereference. | |
bool | temporaryZone_ |
Zone assignment temporary flag. | |
![]() | |
Node * | node_ |
Scene node. | |
unsigned | id_ |
Unique ID within the scene. | |
bool | networkUpdate_ |
Network update queued flag. | |
![]() | |
NetworkState * | networkState_ |
Network attribute state. | |
![]() | |
Context * | context_ |
Execution context. |
Animated model component.