xsi_shaderparamdef.h

Go to the documentation of this file.

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

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

#ifndef __XSISHADERPARAMDEF_H__
#define __XSISHADERPARAMDEF_H__

#include <xsi_valuemap.h>
#include <xsi_siobject.h>

namespace XSI {

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

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

    ~ShaderParamDef();

    ShaderParamDef(const CRef& in_ref);

    ShaderParamDef(const ShaderParamDef& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    ShaderParamDef& operator=(const ShaderParamDef& in_obj);

    ShaderParamDef& operator=(const CRef& in_ref);


    ValueMap GetAttributes(  ) const;

    LONG GetCapabilities(  ) const;

    CValue GetDefaultValue(  ) const;

     CStatus SetDefaultValue( const CValue& in_value );

    CString GetDisplayName(  ) const;

    bool HasDefaultValue(  ) const;

    bool IsArray(  ) const;

    // Not implemented
    bool IsArrayItem(  ) const;

    bool IsInput(  ) const;

    bool IsOutput(  ) const;

    bool IsStructure(  ) const;

    bool GetMainPort(  ) const;

    CStatus PutMainPort( bool in_main );

    CValue GetMaxValue(  ) const;

     CStatus SetMaxValue( const CValue& in_value );

    CValue GetMinValue(  ) const;

     CStatus SetMinValue( const CValue& in_value );

    siShaderParameterDataType GetDataType(  ) const;

    CValue GetSuggestedMaxValue(  ) const;

     CStatus SetSuggestedMaxValue( const CValue& in_value );

    CValue GetSuggestedMinValue(  ) const;

     CStatus SetSuggestedMinValue( const CValue& in_value );

    bool GetTexturable(  ) const;

    CStatus SetTexturable( bool in_value );

    CStatus SetDisplayName( const CString &in_str );

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

};

#endif