xsi_fcurvekey.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSIFCURVEKEY_H__
#define __XSIFCURVEKEY_H__

#include <xsi_siobject.h>
#include <xsi_value.h>
#include <xsi_time.h>

namespace XSI {

class CFCurveKeyRefArray;

//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL FCurveKey : public SIObject
{
public:
    FCurveKey();

    ~FCurveKey();

    FCurveKey(const CRef& in_ref);

    FCurveKey(const FCurveKey& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    FCurveKey& operator=(const FCurveKey& in_obj);

    FCurveKey& operator=(const CRef& in_ref);

    CValue::DataType            GetValueType() const;

    CValue                      GetValue(void) const;

    CStatus                     PutValue(const CValue& in_value);

    CTime                       GetTime(void) const;

    CStatus                     PutTime(const CTime& in_time);

    bool                        GetLocked(void) const;

    CStatus                     PutLocked(bool in_bFlag);

    bool                        GetSelected(void) const;

    CValue                      GetLeft() const;

    CStatus                     PutLeft(const CValue& in_value);

    CValue                      GetRight(void) const;

    CStatus                     PutRight(const CValue& in_value);

    double                      GetLeftTanY(void) const;

    CStatus                     PutLeftTanY(double in_value);

    double                      GetRightTanY(void) const;

    CStatus                     PutRightTanY(double in_value);

    CTime                       GetLeftTanX(void) const;

    CStatus                     PutLeftTanX(const CTime& in_value);

    CTime                       GetRightTanX(void) const;

    CStatus                     PutRightTanX(const CTime& in_value);

    siFCurveKeyInterpolation    GetInterpolation(void) const;

    CStatus                     PutInterpolation(siFCurveKeyInterpolation in_value);

    bool GetConstraint(siFCurveKeyConstraint in_eKC) const;

    CStatus PutConstraint(siFCurveKeyConstraint in_eKC, bool in_bSet );

    CStatus Set( const CTime& in_frame, const CValue& in_value, bool in_overridekeylock=false );

    LONG GetIndex(void) const;

private:
    FCurveKey * operator&() const;
    FCurveKey * operator&();
    friend void * FCurveKeyPtr(const FCurveKey &);
};

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL CFCurveKeyRefArray : public CRefArray
{
public:

    CFCurveKeyRefArray();

    CFCurveKeyRefArray( const CFCurveKeyRefArray& );

    ~CFCurveKeyRefArray();

    CFCurveKeyRefArray& operator=( const CFCurveKeyRefArray& in_refArray );

    CFCurveKeyRefArray& operator+=( const CFCurveKeyRefArray& in_refArray );

    virtual void Add( const CRef& in_item );

    void AddItems( const CFCurveKeyRefArray& in_keys );

    void RemoveAt( LONG in_index );

    CTime GetMinKeyFrame(void) const;

    CTime GetMidKeyFrame(void) const;

    CTime GetMaxKeyFrame(void) const;

    CValue GetMinKeyValue(void) const;

    CValue GetMidKeyValue(void) const;

    CValue GetMaxKeyValue(void) const;
};

}; // namespace XSI

#endif // __XSIFCURVEKEY_H__