xsi_parameter.h

Go to the documentation of this file.

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

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

#ifndef __XSIPARAMETER_H__
#define __XSIPARAMETER_H__

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

#ifdef _MSC_VER
#pragma warning(disable:4251)
#endif

namespace XSI {

class FCurve;
class Expression ;
class Parameter;
class Model;
class X3DObject;

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

    CParameterRefArray();

    CParameterRefArray( const CParameterRefArray& );

    ~CParameterRefArray();

    CParameterRefArray& operator=( const CParameterRefArray& in_refArray );

    CRef GetItem( const CString& in_scriptname ) const;

    void Add( const CRef& in_item );

    void RemoveItem( const CString& in_scriptname );

    CRefArray PlotAnimation(
        double                  in_startFrame=DBL_MAX,
        double                  in_stopFrame=DBL_MAX,
        double                  in_stepFrame=1,
        siFCurveType            in_fcurveTypeToPlot=siStandardFCurve,
        siFCurveInterpolation   in_interpolation=siCubicInterpolation,
        bool                    in_bFitValues=false,
        double                  in_fitTolerance=0.01,
        bool                    in_bProcessRotation=false,
        bool                    in_bDisplayProgressBar=true );

    CValue GetValue( const CString& in_scriptname, double in_time=DBL_MAX ) const;

    CValue GetValue( LONG in_index, double in_time=DBL_MAX ) const;

    CStatus PutValue( const CString& in_scriptname, const CValue& in_val, double in_time=DBL_MAX );

    CStatus PutValue( LONG in_index, const CValue& in_val, double in_time=DBL_MAX );

    private:
    void* m_pIndices;
};

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

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

    ~Parameter();

    Parameter(const CRef& in_ref);

    Parameter(const Parameter& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Parameter& operator=(const Parameter& in_obj);

    Parameter& operator=(const CRef& in_ref);

    LONG GetCapabilities() const;

    CStatus PutCapabilityFlag( siCapabilities in_flag, bool in_bEnable ) ;


    bool GetMarked() const;

    CStatus PutMarked( bool in_bVal );

    CParameterRefArray& GetParameters() const;

    Parameter GetParameter( const CString& in_scriptname ) const;

    CValue GetValue(double in_time=DBL_MAX) const;

    CStatus PutValue(const CValue& in_val, double in_time=DBL_MAX );

    CString GetScriptName() const;

    CString GetDescription() const;

    CValue::DataType GetValueType() const;

    CValue GetMin() const;

    CValue GetMax() const;

    CValue GetSuggestedMin() const;

    CValue GetSuggestedMax() const;

    CValue GetDefault() const;

    CRef GetSource() const;

    CRefArray GetSources() const;


    CStatus PutSource( const CRef& in_source );

    CStatus AddFCurve
    (
        siFCurveType        in_Type,
        FCurve&             io_FCurve
    );


    Expression AddExpression
    (
        CString&        in_ExpressionDefinition
    );


    CStatus ConnectFromPreset
    (
        const CString&  in_strName,
        const CString&  in_strFamily,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus ConnectFromPreset
    (
        const CString&  in_strName,
        const CString&  in_strFamily,
        const CString&  in_strSourceName,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus ConnectFromFile
    (
        const CString&  in_strName,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus ConnectFromFile
    (
        const CString&  in_strName,
        const CString&  in_strSourceName,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus ConnectFromProgID
    (
        const CString&  in_strName,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus ConnectFromProgID
    (
        const CString&  in_strName,
        const CString&  in_strSourceName,
        CRef&           io_prevSource,
        CRef&           io_source
    );

    CStatus Connect
    (
        const CRef& in_source,
        CRef&       io_prevSource
    );

    CStatus Disconnect();

    CStatus Disconnect( CRef& io_prevSource );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        bool            in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        double          in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        float           in_val,
        double          in_time = DBL_MAX
    );
    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        short           in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        LONG            in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        LLONG           in_val,
        double          in_time = DBL_MAX
    );


    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        const CValue&   in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        const CRef&     in_val,
        double          in_time = DBL_MAX
    );

    CStatus PutParameterValue
    (
        const CString&  in_scriptname,
        const CString&  in_val,
        double          in_time = DBL_MAX
    );

    CValue GetParameterValue
    (
        const CString& in_name,
        double in_time=DBL_MAX
    ) const;

    bool IsAnimated
    (
        siSourceType in_sourceType = siAnySource
    ) const;

    CRefArray GetAnimatedParameters(
        siSourceType in_sourceType = siAnySource) const;

    siLockType GetLockType();
    siLockLevel GetLockLevel();
    bool IsLocked();

    CStatus SetLock(siLockLevel  in_level=siLockLevelAll);

    CStatus UnSetLock(siLockLevel in_level=siLockLevelAll, const CString&in_password=CString() );

    siTags GetTags();

    CStatus PutTags( siTags in_eVal );

    CRef AddScriptedOp( const CString& in_code=L"", const CRefArray& in_inputs = CRefArray(), const CString& in_name=L"", const CString& in_language=L"", CStatus* io_pst = 0 );

    CRef AddScriptedOpFromFile( const CString& in_filename = L"", const CRefArray& in_inputs = CRefArray(), const CString& in_name = L"", const CString& in_language = L"", CStatus* io_pst = 0 );

    CRef AddCustomOp( const CString& in_type, const CRefArray& in_inputs = CRefArray(), const CString& in_name=L"", CStatus* io_pst = 0 );

    X3DObject GetParent3DObject() const;

    Model GetModel() const;

    bool HasInstanceValue() const;

    bool IsSupportedInstanceValue(const CRef& in_obj, const CValue& in_val ) const;

    CValue GetInstanceValue(const CRef& in_obj, bool in_bindtobject = false ) const;

    CStatus PutInstanceValue(const CRef& in_obj, const CValue& in_val, bool in_bindtovalidate = false);

    Parameter GetOverridingObject() const;

    Parameter GetOverridenObject() const;

    CValue GetOriginalValue(double in_time=DBL_MAX) const;

    protected:
    mutable CParameterRefArray m_paramArray;

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

};
#endif // __XSIPARAMETER_H__