HOM/HOM_Keyframe.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_Keyframe_h__
#define __HOM_Keyframe_h__

#include "HOM_API.h"
#include "HOM_BaseKeyframe.h"
#include "HOM_EnumModules.h"
#include "HOM_Module.h"

SWIGOUT(%rename(Keyframe) HOM_Keyframe;)

SWIGOUT(%feature("notabstract") HOM_Keyframe;)
class HOM_API HOM_Keyframe : public HOM_BaseKeyframe
{
public:

#ifdef SWIG
%extend
{
    HOM_Keyframe() throw(HOM_Error)
    { return HOM().newKeyframe(); }
    HOM_Keyframe(double value) throw(HOM_Error)
    { return HOM().newKeyframe(value); }
    HOM_Keyframe(double value, double time) throw(HOM_Error)
    { return HOM().newKeyframe(value, time); }
    HOM_Keyframe(const HOM_Keyframe &keyframe)
    { return HOM().newKeyframe(keyframe); }
}
#else
    HOM_Keyframe() throw(HOM_Error);
    HOM_Keyframe(double value) throw(HOM_Error);
    HOM_Keyframe(double value, double time) throw(HOM_Error);
    HOM_Keyframe(const HOM_Keyframe &keyframe) throw(HOM_Error);
#endif

    virtual ~HOM_Keyframe();

    virtual bool operator==(HOM_Keyframe &keyframe);
    virtual bool operator!=(HOM_Keyframe &keyframe);

    virtual int __hash__();
    virtual std::string __repr__();

    virtual HOM_EnumValue &evaluatedType()
    { return HOM_parmData::Float; }

    void setValue(double value);
    double value() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isValueSet();

    // If you set the in value and the (out) value is not set, it will be
    // set to the same value.  Setting the in value breaks the tie between
    // the values.  If neither of the in or (out) values are set, they
    // are considered tied.
    void setInValue(double in_value);
    void unsetInValue();
    double inValue() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isValueTied();
    bool isValueUsed();
    void useValue(bool use);

    void setSlope(double slope);
    double slope() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isSlopeSet();
    bool isSlopeUsed();
    void useSlope(bool use);

    void setInSlope(double in_slope);
    void unsetInSlope();
    double inSlope() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isSlopeTied();

    void setAccel(double accel);
    double accel() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isAccelSet();
    bool isAccelUsed();
    void useAccel(bool use);

    void setInAccel(double in_accel);
    void unsetInAccel();
    double inAccel() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isAccelTied();
    void interpretAccelAsRatio(bool on);
    bool isAccelInterpretedAsRatio();

private:
    double myValue;
    bool myIsValueSet;
    bool myIsValueUsed;
    double myInValue;
    bool myIsValueTied;

    double mySlope;
    bool myIsSlopeSet;
    bool myIsSlopeUsed;
    double myInSlope;
    bool myIsSlopeTied;

    double myAccel;
    bool myIsAccelSet;
    bool myIsAccelUsed;
    double myInAccel;
    bool myIsAccelTied;
    bool myAccelAsRatio;
};

#endif

---