xsi_fcurve.h

Go to the documentation of this file.

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

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

#ifndef __XSIFCURVE_H__
#define __XSIFCURVE_H__

#include <xsi_animsource.h>
#include <xsi_fcurvekey.h>
#include <xsi_time.h>
#include <xsi_value.h>
#include <xsi_longarray.h>
#include <xsi_doublearray.h>

namespace XSI {

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

class SICPPSDKDECL FCurve : public AnimationSource
{
public:
    FCurve();

    ~FCurve();

    FCurve(const CRef& in_ref);

    FCurve(const FCurve& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    FCurve& operator=(const FCurve& in_obj);

    FCurve& operator=(const CRef& in_ref);

    CValue::DataType        GetValueType() const;

    siFCurveType            GetFCurveType(void) const;

    CStatus                 PutFCurveType(siFCurveType in_type);

    bool                    GetLocked(void) const;

    CStatus                 PutLocked(bool in_value);

    bool                    GetDependsOnFrameRate(void) const;

    CStatus                 PutDependsOnFrameRate(bool in_value);

    CValue                  GetNoKeyValue(void) const;

    CStatus                 PutNoKeyValue(const CValue& in_value);

    siFCurveExtrapolation   GetExtrapolation(void) const;

    CStatus                 PutExtrapolation(siFCurveExtrapolation in_type);

    siFCurveInterpolation   GetInterpolation(void) const;

    CStatus                 PutInterpolation(siFCurveInterpolation in_type);

    CValue                  GetLowClamp(void) const;

    CStatus                 PutLowClamp(const CValue& in_value);

    CValue                  GetHighClamp(void) const;

    CStatus                 PutHighClamp(const CValue& in_value);

    CValue                  Eval(const CTime& in_frame) const;

    CValue                  Eval(const double& in_frame) const;

    CFCurveKeyRefArray      GetKeys(void) const;

    CFCurveKeyRefArray      GetKeysBetween(const CTime&in_startframe = CTime(DBL_MAX,CTime::CUSTOM), const CTime &in_endframe = CTime(DBL_MAX,CTime::CUSTOM)) const;

    bool                    GetSelected(void) const;

    CFCurveKeyRefArray      GetSelectedKeys() const;

    CStatus                 SetKeys(
    const CTimeArray& in_timearray,
    const CValueArray& in_valuearray,
    bool in_keepexistingkeys = false );

    CStatus                 SetKeys(
    const CTimeArray&   in_timearray,
    const CDoubleArray& in_valuearray,
    const CLongArray&   in_keyinterpolationarray,
    const CTimeArray& in_lefttanxarray = CTimeArray(),
    const CDoubleArray& in_lefttanyarray = CDoubleArray(),
    const CTimeArray& in_righttanxarray = CTimeArray(),
    const CDoubleArray& in_righttanyarray = CDoubleArray(),
    bool                in_keepexistingkeys = false );

    CStatus                 SetKeyTangents( const CDoubleArray& in_array );

    bool GetSI3DStyle(void) const;

    CStatus PutSI3DStyle(bool in_value);

    LONG AddKey(
            const CTime& in_frame,
            const CValue& in_value,
            siFCurveKeyInterpolation in_interp = siDefaultKeyInterpolation,
            double in_ltx = DBL_MAX,
            double in_lty = DBL_MAX,
            double in_rtx = DBL_MAX,
            double in_rty = DBL_MAX,
            double in_tol = DBL_MAX,
            bool in_okl = false );

    CStatus Resample(
                const CTime& in_startframe = CTime(DBL_MAX,CTime::CUSTOM),
                const CTime& in_endframe = CTime(DBL_MAX,CTime::CUSTOM),
                double in_step = 1,
                bool in_keepexistingkeys = false,
                bool in_overridekeylock = false );

    CStatus Smooth( const CTime& in_start = CTime(DBL_MAX,CTime::CUSTOM),
                    const CTime& in_end = CTime(DBL_MAX,CTime::CUSTOM),
                    double in_dFilterSize=5,
                    double in_dSamplingStep=1,
                    siFCurveSmoothFilterType in_filterType=siFCurveAverageFilterType,
                    double in_dGaussianVariance=1 );

    CStatus Fit(    const CTime& in_start = CTime(DBL_MAX,CTime::CUSTOM),
                    const CTime& in_end = CTime(DBL_MAX,CTime::CUSTOM),
                    double in_dFittingTolerance = 0.1);

    CStatus Set( const FCurve& in_fcurve );

    CStatus RemoveKey( const CTime& in_frame, double in_tolerance = DBL_MAX, bool in_overridekeylock = false );

    CStatus RemoveKeyAtIndex( LONG in_index, bool in_overridekeylock = false );

    CStatus RemoveKeysAtIndex( LONG in_index, LONG in_count, bool in_overridekeylock = false );

    LONG RemoveKeys( const CTime& in_startframe = CTime(DBL_MAX,CTime::CUSTOM), const CTime& in_endframe = CTime(DBL_MAX,CTime::CUSTOM), bool in_overridekeylock = false );

    bool KeyExists( const CTime& in_frame, double in_tolerance = DBL_MAX ) const;

    FCurveKey GetKey( const CTime& in_frame, double in_tolerance = DBL_MAX ) const;

    LONG GetNumKeys( const CTime& in_startframe = CTime(DBL_MAX,CTime::CUSTOM), const CTime& in_endframe = CTime(DBL_MAX,CTime::CUSTOM) ) const;

    FCurveKey GetKeyAtIndex( LONG in_index ) const;

    LONG GetKeyIndex( const CTime& in_frame, double in_tolerance = DBL_MAX ) const;

    CTime GetKeyTime( LONG in_index ) const;

    CValue GetKeyValue( LONG in_index ) const;

    CStatus SetKey( LONG in_index, const CTime& in_frame, const CValue& in_value, bool in_overridekeylock = false );

    bool IsEditing(void) const;

    CStatus BeginEdit(void);

    CStatus EndEdit(void);

    CStatus UndoEdit(void);

    bool GetMute(void) const;

    CStatus PutMute(bool in_value);

    CStatus Offset( const CTime& in_frameOffset, const CValue& in_valueOffset );

    CStatus OffsetKeys( const CFCurveKeyRefArray& in_Keys, const CTime& in_frameOffset, const CValue& in_valueOffset );

    CStatus Scale( double in_frameFactor, double in_valueFactor, const CTime& in_frameAnchor, const CValue& in_valueAnchor );

    CStatus ScaleKeys( const CFCurveKeyRefArray& in_Keys, double in_frameFactor, double in_valueFactor, const CTime& in_frameAnchor, const CValue& in_valueAnchor, bool in_ripple = false );

    CStatus ExtendCycle( LONG in_CyclesBefore, LONG in_CyclesAfter );

    CStatus SnapToNearestFrame(void);

    CStatus MakeRotationsContinuous(void);

    CTime GetMinKeyFrame(void) const;

    CTime GetMidKeyFrame(void) const;

    CTime GetMaxKeyFrame(void) const;

    CValue GetMinKeyValue(void) const;

    CValue GetMidKeyValue(void) const;

    CValue GetMaxKeyValue(void) const;

    bool InsertKeyAtFrame(const CTime& in_frame);

private:
    FCurve * operator&() const;
    FCurve * operator&();
};

}; // namespace XSI

#endif // __XSIFCURVE_H__