xsi_shader.h

Go to the documentation of this file.

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

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

#ifndef __XSISHADER_H__
#define __XSISHADER_H__

#include <xsi_projectitem.h>
#include <xsi_texturelayer.h>

namespace XSI {

class Property ;

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

class SICPPSDKDECL Shader : public ProjectItem
{
public:
    Shader();

    ~Shader();

    Shader(const CRef& in_ref);

    Shader(const Shader& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Shader& operator=(const Shader& in_obj);


    Shader& operator=(const CRef& in_ref);

    CRefArray   GetShaders() const;

    CRefArray   GetImageClips() const;

    CString     GetProgID() const;

    siShaderParameterType GetOutputType2() const;

    siShaderOutputType GetOutputType() const;


    CStatus GetColorParameterValue(
                const CString& in_name,
                float& out_red,
                float& out_green,
                float& out_blue,
                float& out_alpha,
                double in_time = DBL_MAX ) ;

    CStatus PutColorParameterValue(
                const CString& in_name,
                float in_red,
                float in_green,
                float in_blue,
                float in_alpha = 1.0f,
                double in_time = DBL_MAX ) ;

    //
    // Texture layering methods -- same as in Material.
    //

    TextureLayer    CreateTextureLayer( const CString& in_strName = CString(), bool in_bAfter = true, const TextureLayer& in_refLayer = TextureLayer() );

    CStatus         AddSharedTextureLayer( const TextureLayer& in_layer, bool in_bAfter = true, const TextureLayer& in_refLayer = TextureLayer() );

    CRefArray       GetTextureLayers() const;

    CStatus         RemoveTextureLayer( const TextureLayer& in_layer );


    bool HasRenderer( const CString &in_strRenderer ) const;

    CValue GetRendererOption(
        const CString   &in_strRenderer,
        const CString   &in_strOption
        ) const;

    CString GetSymbolName(
        const CString   &in_strRenderer
        ) const;

    CString GetCodePath(
        const CString   &in_strRenderer
        ) const;

    CString GetCodeText(
        const CString   &in_strRenderer
        ) const;

    Property    AddProperty
    (
        const CString&  in_preset,
        bool            in_bBranch = false ,
        const CString&  in_name = CString()
    );

    CRefArray GetProperties() const ;

    siShaderParameterType GetShaderInputType(const CString& in_scriptname) const;

    CString GetPortDisplayName( const CString &in_portScriptName ) const;

    CStatus PutPortDisplayName( const CString &in_portScriptName, const CString &in_displayName );

    CRef GetRoot(void) const;

    siShaderType GetShaderType() const;

    siShaderParameterType GetShaderParameterType( const CString& in_paramscriptname, bool& out_input ) const;

    CRefArray   GetAllShaders() const;

    CRef        GetShaderContainer() const;

    CRefArray GetShaderParameterTargets( const CString& in_paramscriptname ) const;

    CRefArray   GetAllImageClips() const;

    CRef    GetShaderDef() const;

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

};

#endif // __XSISHADER_H__