HOM/HOM_BaseKeyframe.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:
 *      The user of HOM will never really know about this class.  They'll
 *      work with either Keyframe or StringKeyframe objects.
 */

#ifndef __HOM_BaseKeyframe_h__
#define __HOM_BaseKeyframe_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include "HOM_EnumModules.h"
#include <string>

SWIGOUT(%rename(BaseKeyframe) HOM_BaseKeyframe;)

class HOM_API HOM_BaseKeyframe
{
public:
    HOM_BaseKeyframe();
    HOM_BaseKeyframe(const HOM_BaseKeyframe &base_keyframe);
    virtual ~HOM_BaseKeyframe();

    virtual bool operator==(HOM_BaseKeyframe &base_keyframe);
    virtual bool operator!=(HOM_BaseKeyframe &base_keyframe);

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

    SWIGPYTHONOUT(%feature("autodoc",
        "evaluatedType(self) -> hou.parmData enum value") evaluatedType;)
    virtual HOM_EnumValue &evaluatedType() = 0;

    void setExpression(const std::string &expression,
            HOM_EnumValue *language = NULL)
        throw(HOM_TypeError);
    std::string expression() throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isExpressionSet();

    SWIGPYTHONOUT(%feature("autodoc",
        "expressionLanguage(self) -> hou.exprLanguage enum value")
        expressionLanguage;)
    HOM_EnumValue &expressionLanguage()
        throw(HOM_KeyframeValueNotSet, HOM_Error);
    bool isExpressionLanguageSet();

    void setTime(double time);
    bool isTimeSet();
    double time() throw(HOM_KeyframeValueNotSet, HOM_Error);

    void setFrame(double frame) throw(HOM_Error);
    double frame() throw(HOM_KeyframeValueNotSet, HOM_Error);

    SWIGOUT(%kwargs asCode;)
    virtual std::string asCode(
            bool brief=false,
            bool save_keys_in_frames=false,
            const char *function_name=NULL)
        throw(HOM_Error) = 0;

protected:
    double myTime;
    bool myIsTimeSet;

    std::string myExpression;
    HOM_EnumValue *myExpressionLanguage;
    bool myIsExpressionSet;
};

#endif

---