C4ValueProviderLinear Class Reference

#include <C4MeshAnimation.h>

Inheritance diagram for C4ValueProviderLinear:

Collaboration diagram for C4ValueProviderLinear:

Public Member Functions
	C4ValueProviderLinear ()
	C4ValueProviderLinear (C4Real pos, C4Real begin, C4Real end, int32_t length, C4AnimationEnding ending)
bool	Execute () override
void	CompileFunc (StdCompiler *pComp) override
virtual void	DenumeratePointers ()
virtual void	ClearPointers (class C4Object *pObj)

Static Public Member Functions
static const IDBase *	Lookup (const char *name)
static const IDBase *	Lookup (const std::type_info &type)

Public Attributes
C4Real	Value

Detailed Description

Definition at line 63 of file C4MeshAnimation.h.

Constructor & Destructor Documentation

C4ValueProviderLinear() [1/2]

C4ValueProviderLinear::C4ValueProviderLinear ( )

inline

Definition at line 66 of file C4MeshAnimation.h.

: Begin(Fix0), End(Fix0) {}

C4ValueProviderLinear() [2/2]

C4ValueProviderLinear::C4ValueProviderLinear	(	C4Real	pos,
		C4Real	begin,
		C4Real	end,
		int32_t	length,
		C4AnimationEnding	ending
	)

Definition at line 151 of file C4MeshAnimation.cpp.

                                                                                                                          :
        Begin(begin), End(end), Length(length), Ending(ending), LastTick(Game.FrameCounter)
{
    Value = pos;
}

References StdMeshInstanceValueProvider::Value.

Member Function Documentation

ClearPointers()

virtual void StdMeshInstance::SerializableValueProvider::ClearPointers ( class C4Object *  pObj )

inlinevirtualinherited

Reimplemented in C4ValueProviderAction, C4ValueProviderSinV, C4ValueProviderCosV, C4ValueProviderSinR, C4ValueProviderCosR, C4ValueProviderAbsRDir, C4ValueProviderRDir, C4ValueProviderYDir, C4ValueProviderXDir, C4ValueProviderDist, C4ValueProviderAbsY, C4ValueProviderAbsX, C4ValueProviderR, C4ValueProviderY, and C4ValueProviderX.

Definition at line 480 of file StdMesh.h.

{}

Referenced by StdMeshInstanceAnimationNode::ClearPointers().

Here is the caller graph for this function:

CompileFunc()

void C4ValueProviderLinear::CompileFunc ( StdCompiler *  pComp )

overridevirtual

Reimplemented from StdMeshInstance::SerializableValueProvider.

Definition at line 182 of file C4MeshAnimation.cpp.

{
    const StdEnumEntry<C4AnimationEnding> Endings[] =
    {
        { "Loop",   ANIM_Loop                          },
        { "Hold",   ANIM_Hold                          },
        { "Remove", ANIM_Remove                        },
 
        { nullptr,     static_cast<C4AnimationEnding>(0)  }
    };
 
    SerializableValueProvider::CompileFunc(pComp);
    pComp->Separator();
    pComp->Value(Begin);
    pComp->Separator();
    pComp->Value(End);
    pComp->Separator();
    pComp->Value(Length);
    pComp->Separator();
    pComp->Value(mkEnumAdaptT<uint8_t>(Ending, Endings));
    pComp->Separator();
    pComp->Value(LastTick);
 
    // When a scenario is saved as scenario the FrameCounter will be reset
    // upon scenario start. The LastTick variable is fixed here.
    // TODO: A nicer solution would be to always set LastTick to
    // Game.FrameCounter and to make sure that the Value is always up to
    // date (current frame) when saving by running Execute(). This could
    // even be done in the base class.
    if(pComp->isDeserializer())
        if(LastTick > Game.FrameCounter)
            LastTick = 0;
}

References ANIM_Hold, ANIM_Loop, ANIM_Remove, CompileFunc(), C4Game::FrameCounter, Game, StdCompiler::isDeserializer(), StdCompiler::Separator(), and StdCompiler::Value().

Here is the call graph for this function:

DenumeratePointers()

virtual void StdMeshInstance::SerializableValueProvider::DenumeratePointers ( )

inlinevirtualinherited

Reimplemented in C4ValueProviderAction, C4ValueProviderSinV, C4ValueProviderCosV, C4ValueProviderSinR, C4ValueProviderCosR, C4ValueProviderAbsRDir, C4ValueProviderRDir, C4ValueProviderYDir, C4ValueProviderXDir, C4ValueProviderDist, C4ValueProviderAbsY, C4ValueProviderAbsX, C4ValueProviderR, C4ValueProviderY, and C4ValueProviderX.

Definition at line 479 of file StdMesh.h.

{}

Referenced by StdMeshInstanceAnimationNode::DenumeratePointers().

Here is the caller graph for this function:

Execute()

bool C4ValueProviderLinear::Execute ( )

overridevirtual

Implements StdMeshInstanceValueProvider.

Definition at line 157 of file C4MeshAnimation.cpp.

{
    Value += (End - Begin) * itofix(Game.FrameCounter - LastTick) / Length;
    LastTick = Game.FrameCounter;
 
    assert( (End >= Begin && Value >= Begin) || (End <= Begin && Value <= Begin));
    while ( (End > Begin && Value > End) || (End < Begin && Value < End))
    {
        switch (Ending)
        {
        case ANIM_Loop:
            Value -= (End - Begin);
            return true;
        case ANIM_Hold:
            Value = End;
            return true;
        case ANIM_Remove:
            Value = End;
            return false;
        }
    }
 
    return true;
}

References ANIM_Hold, ANIM_Loop, ANIM_Remove, C4Game::FrameCounter, Game, itofix(), and StdMeshInstanceValueProvider::Value.

Here is the call graph for this function:

Lookup() [1/2]

static const IDBase* StdMeshInstance::SerializableValueProvider::Lookup ( const char *  name )

inlinestaticinherited

Definition at line 460 of file StdMesh.h.

        {
            if(!IDs) return nullptr;
            for(auto & ID : *IDs)
                if(strcmp(ID->name, name) == 0)
                    return ID;
            return nullptr;
        }

References StdMeshInstance::SerializableValueProvider::IDBase::name.

Lookup() [2/2]

static const IDBase* StdMeshInstance::SerializableValueProvider::Lookup ( const std::type_info &  type )

inlinestaticinherited

Definition at line 469 of file StdMesh.h.

        {
            if(!IDs) return nullptr;
            for(auto & ID : *IDs)
                if(ID->type == type)
                    return ID;
            return nullptr;
        }

References StdMeshInstance::SerializableValueProvider::IDBase::type.

Member Data Documentation

Value

C4Real StdMeshInstanceValueProvider::Value

inherited

Definition at line 322 of file StdMesh.h.

Referenced by C4ValueProviderAbsX::C4ValueProviderAbsX(), C4ValueProviderAbsY::C4ValueProviderAbsY(), C4ValueProviderConst::C4ValueProviderConst(), C4ValueProviderDist::C4ValueProviderDist(), C4ValueProviderLinear(), C4ValueProviderX::C4ValueProviderX(), C4ValueProviderY::C4ValueProviderY(), StdMeshInstance::SerializableValueProvider::CompileFunc(), Execute(), C4ValueProviderX::Execute(), C4ValueProviderY::Execute(), C4ValueProviderR::Execute(), C4ValueProviderAbsX::Execute(), C4ValueProviderAbsY::Execute(), C4ValueProviderDist::Execute(), C4ValueProviderXDir::Execute(), C4ValueProviderYDir::Execute(), C4ValueProviderRDir::Execute(), C4ValueProviderAbsRDir::Execute(), C4ValueProviderCosR::Execute(), C4ValueProviderSinR::Execute(), C4ValueProviderCosV::Execute(), C4ValueProviderSinV::Execute(), C4ValueProviderAction::Execute(), C4ValueProviderRef< SourceT >::Execute(), StdMeshInstance::ExecuteAnimationNode(), StdMeshInstance::InsertAnimationNode(), StdMeshInstance::PlayAnimation(), StdMeshInstance::SetAnimationPosition(), and StdMeshInstance::SetAnimationWeight().

---

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

• C4MeshAnimation.h
• C4MeshAnimation.cpp