StdMeshInstanceAnimationNode Class Reference

#include <StdMesh.h>

Collaboration diagram for StdMeshInstanceAnimationNode:

Public Types
enum	NodeType { LeafNode , CustomNode , LinearInterpolationNode }
typedef StdMeshInstanceAnimationNode	AnimationNode
typedef StdMeshInstanceValueProvider	ValueProvider

Public Member Functions
	StdMeshInstanceAnimationNode ()
	StdMeshInstanceAnimationNode (const StdMeshAnimation *animation, ValueProvider *position)
	StdMeshInstanceAnimationNode (const StdMeshBone *bone, const StdMeshTransformation &trans)
	StdMeshInstanceAnimationNode (AnimationNode *child_left, AnimationNode *child_right, ValueProvider *weight)
	~StdMeshInstanceAnimationNode ()
bool	GetBoneTransform (unsigned int bone, StdMeshTransformation &transformation)
int	GetSlot () const
unsigned int	GetNumber () const
NodeType	GetType () const
AnimationNode *	GetParent ()
const StdMeshAnimation *	GetAnimation () const
ValueProvider *	GetPositionProvider ()
C4Real	GetPosition () const
AnimationNode *	GetLeftChild ()
AnimationNode *	GetRightChild ()
ValueProvider *	GetWeightProvider ()
C4Real	GetWeight () const
void	CompileFunc (StdCompiler *pComp, const StdMesh *Mesh)
void	DenumeratePointers ()
void	ClearPointers (class C4Object *pObj)

Protected Attributes
int	Slot
unsigned int	Number
NodeType	Type {LeafNode}
AnimationNode *	Parent {nullptr}
union {
struct {
const StdMeshAnimation *	Animation
ValueProvider *	Position
}	Leaf
struct {
unsigned int	BoneIndex
StdMeshTransformation *	Transformation
}	Custom
struct {
AnimationNode *	ChildLeft
AnimationNode *	ChildRight
ValueProvider *	Weight
}	LinearInterpolation
};

Friends
class	StdMeshInstance
class	StdMeshUpdate
class	StdMeshAnimationUpdate

Detailed Description

Definition at line 327 of file StdMesh.h.

Member Typedef Documentation

AnimationNode

typedef StdMeshInstanceAnimationNode StdMeshInstanceAnimationNode::AnimationNode

Definition at line 333 of file StdMesh.h.

ValueProvider

typedef StdMeshInstanceValueProvider StdMeshInstanceAnimationNode::ValueProvider

Definition at line 334 of file StdMesh.h.

Member Enumeration Documentation

NodeType

enum StdMeshInstanceAnimationNode::NodeType

Enumerator
LeafNode
CustomNode
LinearInterpolationNode

Definition at line 335 of file StdMesh.h.

{ LeafNode, CustomNode, LinearInterpolationNode };

Constructor & Destructor Documentation

StdMeshInstanceAnimationNode() [1/4]

StdMeshInstanceAnimationNode::StdMeshInstanceAnimationNode

(

)

Definition at line 787 of file StdMesh.cpp.

{
    Leaf.Animation = nullptr;
    Leaf.Position = nullptr;
}

StdMeshInstanceAnimationNode() [2/4]

StdMeshInstanceAnimationNode::StdMeshInstanceAnimationNode	(	const StdMeshAnimation *	animation,
		ValueProvider *	position
	)

Definition at line 793 of file StdMesh.cpp.

{
    Leaf.Animation = animation;
    Leaf.Position = position;
}

StdMeshInstanceAnimationNode() [3/4]

StdMeshInstanceAnimationNode::StdMeshInstanceAnimationNode	(	const StdMeshBone *	bone,
		const StdMeshTransformation &	trans
	)

Definition at line 799 of file StdMesh.cpp.

                                                                                                                     :
        Type(CustomNode), Parent(nullptr)
{
    Custom.BoneIndex = bone->Index;
    Custom.Transformation = new StdMeshTransformation(trans);
}

References StdMeshBone::Index.

StdMeshInstanceAnimationNode() [4/4]

StdMeshInstanceAnimationNode::StdMeshInstanceAnimationNode	(	AnimationNode *	child_left,
		AnimationNode *	child_right,
		ValueProvider *	weight
	)

Definition at line 806 of file StdMesh.cpp.

                                                                                                                                      :
        Type(LinearInterpolationNode), Parent(nullptr)
{
    LinearInterpolation.ChildLeft = child_left;
    LinearInterpolation.ChildRight = child_right;
    LinearInterpolation.Weight = weight;
}

~StdMeshInstanceAnimationNode()

StdMeshInstanceAnimationNode::~StdMeshInstanceAnimationNode

(

)

Definition at line 814 of file StdMesh.cpp.

{
    switch (Type)
    {
    case LeafNode:
        delete Leaf.Position;
        break;
    case CustomNode:
        delete Custom.Transformation;
        break;
    case LinearInterpolationNode:
        delete LinearInterpolation.ChildLeft;
        delete LinearInterpolation.ChildRight;
        delete LinearInterpolation.Weight;
        break;
    }
}

References CustomNode, LeafNode, LinearInterpolationNode, and Type.

Member Function Documentation

ClearPointers()

void StdMeshInstanceAnimationNode::ClearPointers

(

class C4Object *

pObj

)

Definition at line 953 of file StdMesh.cpp.

{
    StdMeshInstance::SerializableValueProvider* value_provider = nullptr;
    switch(Type)
    {
    case LeafNode:
        value_provider = dynamic_cast<StdMeshInstance::SerializableValueProvider*>(Leaf.Position);
        break;
    case CustomNode:
        value_provider = nullptr;
        break;
    case LinearInterpolationNode:
        value_provider = dynamic_cast<StdMeshInstance::SerializableValueProvider*>(LinearInterpolation.Weight);
        // non-recursive, StdMeshInstance::ClearPointers walks over all nodes
        break;
    }
 
    if(value_provider) value_provider->ClearPointers(pObj);
}

References StdMeshInstance::SerializableValueProvider::ClearPointers(), CustomNode, LeafNode, LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::ClearPointers().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void StdMeshInstanceAnimationNode::CompileFunc	(	StdCompiler *	pComp,
		const StdMesh *	Mesh
	)

Definition at line 864 of file StdMesh.cpp.

{
    static const StdEnumEntry<NodeType> NodeTypes[] =
    {
        { "Leaf",                  LeafNode                      },
        { "Custom",                CustomNode                    },
        { "LinearInterpolation",   LinearInterpolationNode       },
 
        { nullptr,     static_cast<NodeType>(0)  }
    };
 
    pComp->Value(mkNamingAdapt(Slot, "Slot"));
    pComp->Value(mkNamingAdapt(Number, "Number"));
    pComp->Value(mkNamingAdapt(mkEnumAdaptT<uint8_t>(Type, NodeTypes), "Type"));
 
    switch(Type)
    {
    case LeafNode:
        if(pComp->isDeserializer())
        {
            StdCopyStrBuf anim_name;
            pComp->Value(mkNamingAdapt(toC4CStrBuf(anim_name), "Animation"));
            Leaf.Animation = Mesh->GetSkeleton().GetAnimationByName(anim_name);
            if(!Leaf.Animation) pComp->excCorrupt(R"(No such animation: "%s")", anim_name.getData());
        }
        else
        {
            pComp->Value(mkNamingAdapt(mkParAdapt(mkDecompileAdapt(Leaf.Animation->Name), StdCompiler::RCT_All), "Animation"));
        }
 
        pComp->Value(mkNamingAdapt(mkValueProviderAdapt(&Leaf.Position), "Position"));
        break;
    case CustomNode:
        if(pComp->isDeserializer())
        {
            StdCopyStrBuf bone_name;
            pComp->Value(mkNamingAdapt(toC4CStrBuf(bone_name), "Bone"));
            const StdMeshBone* bone = Mesh->GetSkeleton().GetBoneByName(bone_name);
            if(!bone) pComp->excCorrupt(R"(No such bone: "%s")", bone_name.getData());
            Custom.BoneIndex = bone->Index;
            Custom.Transformation = new StdMeshTransformation;
        }
        else
        {
            pComp->Value(mkNamingAdapt(mkParAdapt(mkDecompileAdapt(Mesh->GetSkeleton().GetBone(Custom.BoneIndex).Name), StdCompiler::RCT_All), "Bone"));
        }
 
        pComp->Value(mkNamingAdapt(mkTransformAdapt(*Custom.Transformation), "Transformation"));
        break;
    case LinearInterpolationNode:
        pComp->Value(mkParAdapt(mkNamingPtrAdapt(LinearInterpolation.ChildLeft, "ChildLeft"), Mesh));
        pComp->Value(mkParAdapt(mkNamingPtrAdapt(LinearInterpolation.ChildRight, "ChildRight"), Mesh));
        pComp->Value(mkNamingAdapt(mkValueProviderAdapt(&LinearInterpolation.Weight), "Weight"));
        if(pComp->isDeserializer())
        {
            if(LinearInterpolation.ChildLeft->Slot != Slot)
                pComp->excCorrupt("Slot of left child does not match parent slot");
            if(LinearInterpolation.ChildRight->Slot != Slot)
                pComp->excCorrupt("Slof of right child does not match parent slot");
            LinearInterpolation.ChildLeft->Parent = this;
            LinearInterpolation.ChildRight->Parent = this;
        }
        break;
    default:
        pComp->excCorrupt("Invalid animation node type");
        break;
    }
}

References CustomNode, StdCompiler::excCorrupt(), StdMeshSkeleton::GetAnimationByName(), StdMeshSkeleton::GetBone(), StdMeshSkeleton::GetBoneByName(), StdStrBuf::getData(), StdMesh::GetSkeleton(), StdMeshBone::Index, StdCompiler::isDeserializer(), LeafNode, LinearInterpolationNode, mkDecompileAdapt(), mkNamingAdapt(), mkNamingPtrAdapt(), mkParAdapt(), StdMeshBone::Name, Number, StdCompiler::RCT_All, Slot, toC4CStrBuf, Type, and StdCompiler::Value().

Here is the call graph for this function:

DenumeratePointers()

void StdMeshInstanceAnimationNode::DenumeratePointers

(

)

Definition at line 933 of file StdMesh.cpp.

{
    StdMeshInstance::SerializableValueProvider* value_provider = nullptr;
    switch(Type)
    {
    case LeafNode:
        value_provider = dynamic_cast<StdMeshInstance::SerializableValueProvider*>(Leaf.Position);
        break;
    case CustomNode:
        value_provider = nullptr;
        break;
    case LinearInterpolationNode:
        value_provider = dynamic_cast<StdMeshInstance::SerializableValueProvider*>(LinearInterpolation.Weight);
        // non-recursive, StdMeshInstance::DenumeratePointers walks over all nodes
        break;
    }
 
    if(value_provider) value_provider->DenumeratePointers();
}

References CustomNode, StdMeshInstance::SerializableValueProvider::DenumeratePointers(), LeafNode, LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::DenumeratePointers().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAnimation()

const StdMeshAnimation* StdMeshInstanceAnimationNode::GetAnimation ( ) const

inline

Definition at line 350 of file StdMesh.h.

{ assert(Type == LeafNode); return Leaf.Animation; }

References LeafNode, and Type.

Referenced by C4ValueProviderAction::Execute(), and StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

GetBoneTransform()

bool StdMeshInstanceAnimationNode::GetBoneTransform	(	unsigned int	bone,
		StdMeshTransformation &	transformation
	)

Definition at line 832 of file StdMesh.cpp.

{
    StdMeshTransformation combine_with;
    StdMeshTrack* track;
 
    switch (Type)
    {
    case LeafNode:
        track = Leaf.Animation->Tracks[bone];
        if (!track) return false;
        transformation = track->GetTransformAt(fixtof(Leaf.Position->Value), Leaf.Animation->Length);
        return true;
    case CustomNode:
        if(bone == Custom.BoneIndex)
            transformation = *Custom.Transformation;
        else
            return false;
        return true;
    case LinearInterpolationNode:
        if (!LinearInterpolation.ChildLeft->GetBoneTransform(bone, transformation))
            return LinearInterpolation.ChildRight->GetBoneTransform(bone, transformation);
        if (!LinearInterpolation.ChildRight->GetBoneTransform(bone, combine_with))
            return true; // First Child affects bone
 
        transformation = StdMeshTransformation::Nlerp(transformation, combine_with, fixtof(LinearInterpolation.Weight->Value));
        return true;
    default:
        assert(false);
        return false;
    }
}

References CustomNode, fixtof(), StdMeshTrack::GetTransformAt(), LeafNode, LinearInterpolationNode, StdMeshTransformation::Nlerp(), and Type.

Here is the call graph for this function:

GetLeftChild()

AnimationNode* StdMeshInstanceAnimationNode::GetLeftChild ( )

inline

Definition at line 354 of file StdMesh.h.

{ assert(Type == LinearInterpolationNode); return LinearInterpolation.ChildLeft; }

References LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

GetNumber()

unsigned int StdMeshInstanceAnimationNode::GetNumber ( ) const

inline

Definition at line 346 of file StdMesh.h.

{ return Number; }

References Number.

GetParent()

AnimationNode* StdMeshInstanceAnimationNode::GetParent ( )

inline

Definition at line 348 of file StdMesh.h.

{ return Parent; }

References Parent.

GetPosition()

C4Real StdMeshInstanceAnimationNode::GetPosition ( ) const

inline

Definition at line 352 of file StdMesh.h.

{ assert(Type == LeafNode); return Leaf.Position->Value; }

References LeafNode, and Type.

GetPositionProvider()

ValueProvider* StdMeshInstanceAnimationNode::GetPositionProvider ( )

inline

Definition at line 351 of file StdMesh.h.

{ assert(Type == LeafNode); return Leaf.Position; }

References LeafNode, and Type.

Referenced by StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

GetRightChild()

AnimationNode* StdMeshInstanceAnimationNode::GetRightChild ( )

inline

Definition at line 355 of file StdMesh.h.

{ assert(Type == LinearInterpolationNode); return LinearInterpolation.ChildRight; }

References LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

GetSlot()

int StdMeshInstanceAnimationNode::GetSlot ( ) const

inline

Definition at line 345 of file StdMesh.h.

{ return Slot; }

References Slot.

GetType()

NodeType StdMeshInstanceAnimationNode::GetType ( ) const

inline

Definition at line 347 of file StdMesh.h.

{ return Type; }

References Type.

Referenced by StdMeshInstance::ExecuteAnimationNode(), StdMeshInstance::SetAnimationBoneTransform(), StdMeshInstance::SetAnimationPosition(), and StdMeshInstance::SetAnimationWeight().

Here is the caller graph for this function:

GetWeight()

C4Real StdMeshInstanceAnimationNode::GetWeight ( ) const

inline

Definition at line 357 of file StdMesh.h.

{ assert(Type == LinearInterpolationNode); return LinearInterpolation.Weight->Value; }

References LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

GetWeightProvider()

ValueProvider* StdMeshInstanceAnimationNode::GetWeightProvider ( )

inline

Definition at line 356 of file StdMesh.h.

{ assert(Type == LinearInterpolationNode); return LinearInterpolation.Weight; }

References LinearInterpolationNode, and Type.

Referenced by StdMeshInstance::ExecuteAnimationNode().

Here is the caller graph for this function:

Friends And Related Function Documentation

StdMeshAnimationUpdate

friend class StdMeshAnimationUpdate

friend

Definition at line 331 of file StdMesh.h.

StdMeshInstance

friend class StdMeshInstance

friend

Definition at line 329 of file StdMesh.h.

StdMeshUpdate

friend class StdMeshUpdate

friend

Definition at line 330 of file StdMesh.h.

Member Data Documentation

union { ... }

Number

unsigned int StdMeshInstanceAnimationNode::Number

protected

Definition at line 365 of file StdMesh.h.

Referenced by StdMeshInstance::CompileFunc(), CompileFunc(), GetNumber(), StdMeshInstance::InsertAnimationNode(), and StdMeshInstance::StopAnimation().

Parent

AnimationNode* StdMeshInstanceAnimationNode::Parent {nullptr}

protected

Definition at line 367 of file StdMesh.h.

Referenced by GetParent(), StdMeshInstance::InsertAnimationNode(), and StdMeshInstance::StopAnimation().

Slot

int StdMeshInstanceAnimationNode::Slot

protected

Definition at line 364 of file StdMesh.h.

Referenced by StdMeshInstance::CompileFunc(), CompileFunc(), GetSlot(), StdMeshInstance::InsertAnimationNode(), and StdMeshInstance::StopAnimation().

Type

NodeType StdMeshInstanceAnimationNode::Type {LeafNode}

protected

Definition at line 366 of file StdMesh.h.

Referenced by ClearPointers(), StdMeshInstance::CompileFunc(), CompileFunc(), DenumeratePointers(), GetAnimation(), GetBoneTransform(), GetLeftChild(), GetPosition(), GetPositionProvider(), GetRightChild(), GetType(), GetWeight(), GetWeightProvider(), StdMeshInstance::StopAnimation(), and ~StdMeshInstanceAnimationNode().

---

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

• StdMesh.h
• StdMesh.cpp