xsi_customproperty.h

Go to the documentation of this file.

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

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

#ifndef __XSICUSTOMPROPERTY_H__
#define __XSICUSTOMPROPERTY_H__

#include <xsi_property.h>
#include <xsi_status.h>

namespace XSI {

class ProxyParameter ;

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

class SICPPSDKDECL CustomProperty : public Property
{
public:
    CustomProperty();

    ~CustomProperty();

    CustomProperty(const CRef& in_ref);

    CustomProperty(const CustomProperty& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    CustomProperty& operator=(const CustomProperty& in_obj);

    CustomProperty& operator=(const CRef& in_ref);

    CStatus AddParameter(
        const CString& in_scriptname,
        CValue::DataType in_type,
        siParamClassification in_classification,
        INT in_capabilities,
        const CString& in_name,
        const CString& in_description,
        const CValue& in_default,
        const CValue& in_min,
        const CValue& in_max,
        const CValue& in_suggestedmin,
        const CValue& in_suggestedmax,
        Parameter&  io_parameter );

    CStatus AddParameter(
        const CString& in_scriptname,
        CValue::DataType in_type,
        INT in_capabilities,
        const CString& in_name,
        const CString& in_description,
        const CValue& in_default,
        const CValue& in_min,
        const CValue& in_max,
        const CValue& in_suggestedmin,
        const CValue& in_suggestedmax,
        Parameter&  io_parameter );

    CStatus AddParameter(
        const CString& in_scriptname,
        CValue::DataType in_type,
        INT in_capabilities,
        const CString& in_name,
        const CString& in_description,
        const CValue& in_default,
        Parameter&  io_parameter );

    Parameter AddFCurveParameter( const CString& in_scriptname ) ;

    Parameter AddGridParameter( const CString& in_scriptname ) ;

    CStatus RemoveParameter( const Parameter& in_param );

    CStatus GetBinaryData( unsigned char *& io_buffer, UINT& io_size ) const;

    CStatus FreeBinaryData( unsigned char *& io_buffer ) const ;


    CStatus PutBinaryData( const unsigned char * in_buffer, UINT in_size );

    ProxyParameter AddProxyParameter(
                    Parameter in_ParamToProxy,
                    const CString& in_ProxyScriptName = CString(),
                    const CString& in_ProxyName = CString() ) ;

    Parameter AddParameterFromDef( const CRef& in_paramdef ) ;

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

};

#endif // __XSICUSTOMPROPERTY_H__