3DKeyCurve.h

Go to the documentation of this file.

//! @file 3DKeyCurve.h
//! @brief The file defines C3DKeyCurve, C3DTCBCurve which handles interpolation curve between two keyframes. 
//!
//////////////////////////////////////////////////////////////////////
 
#ifndef C3DKEYCURVE_CLASS_H
#define C3DKEYCURVE_CLASS_H
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "CustomData.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @class C3DKeyCurve
//! @brief C3DKeyCurve is the base class that determines the transition curve between a given keyframe and the next keyframe which has the same class.
//! @details The derived class can be determined using GetClassID method.
//! There is currently one kind of derived class which is C3DTCBCurve, which has the KEYCURVE_TCB class id.
class DLL_3DFUNCTION C3DKeyCurve
{
public:
    C3DKeyCurve(void);
    virtual ~C3DKeyCurve(void);
 
protected:
    int classid;
 
public:
    enum
    {
        KEYCURVE_NULLID = 0,
        KEYCURVE_TCB = MAKE_CUSTOM_ID('T', 'C', 'B', ' '),
    };
 
    unsigned int GetClassID() const;
 
    static C3DKeyCurve *CreateCurve(unsigned int classid);
    C3DKeyCurve *Copy() const;
 
    virtual void Serialize(CXArchive& ar);
 
    virtual bool operator==(const C3DKeyCurve& key) const;
    virtual bool operator=(const C3DKeyCurve& key);
};
 
//! @class C3DTCBCurve
//! @brief C3DTCBCurve class handles a transition between two keyframes based on Tension, Continuity and Bias parameters.
//! These values can be directly retrieved from the public members of the class.
class DLL_3DFUNCTION C3DTCBCurve : public C3DKeyCurve
{
public:
    float tension;
    float continuity;
    float bias;
    float easeIn;
    float easeOut;
 
public:
    C3DTCBCurve();
 
    virtual void Serialize(CXArchive& ar);
 
    virtual bool operator=(const C3DKeyCurve& curve);
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // C3DKEYCURVE_CLASS_H