xsi_shaderdef.h

Go to the documentation of this file.

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

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

#ifndef __XSISHADERDEF_H__
#define __XSISHADERDEF_H__

#include <xsi_valuemap.h>
#include <xsi_metashaderrendererdef.h>
#include <xsi_shaderballoptions.h>
#include <xsi_shaderparamdefcontainer.h>
#include <xsi_siobject.h>
#include <xsi_ppglayout.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL ShaderDef : public SIObject
{
public:
    ShaderDef();

    ~ShaderDef();

    ShaderDef(const CRef& in_ref);

    ShaderDef(const ShaderDef& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    ShaderDef& operator=(const ShaderDef& in_obj);

    ShaderDef& operator=(const CRef& in_ref);


    MetaShaderRendererDef AddRendererDef( const CString& in_renderer );

    ValueMap GetAttributes(  ) const;

    CString GetCategory(  ) const;

    CStatus PutCategory( const CString& in_category );

    CString GetDefinitionPath(  ) const;

    CStatus PutDefinitionPath( const CString& in_path );

    CString GetDisplayName(  ) const;

    CStatus PutDisplayName( const CString& in_name );

    MetaShaderRendererDef GetRendererDefByName( const CString& in_renderer ) const;

    ShaderParamDefContainer GetInputParamDefs(  ) const;

    ShaderParamDefContainer GetOutputParamDefs(  ) const;

    bool GetParsed(  ) const;

    CStatus PutParsed( bool in_parsed );

    CString GetParser(  ) const;

    CStatus PutParser( const CString& in_parser );

    bool GetParserBased(  ) const;

    CString GetPlugin(  ) const;

    CStatus PutPlugin( const CString& in_plugin );

    bool GetPluginBased(  ) const;

    CString GetPluginFilename(  ) const;

    CString GetProgID(  ) const;

    CStatus RemoveRendererDef( const MetaShaderRendererDef& in_rendererdef );

    CRefArray GetRendererDefs(  ) const;

    ULONG GetShaderInstanceCount(  ) const;

    CRefArray GetShaderInstances(  ) const;

    ShaderballOptions GetShaderballOptions(  ) const;

    CStatus AddShaderFamily( const CString& in_type, bool in_bPrimary = false );

    bool IsShaderFamily( const CString& in_type ) const;

    CString GetPrimaryShaderFamily( );

    CStringArray GetShaderFamilies() const;

    PPGLayout GetPPGLayout() const;

    PPGLayout GetRenderTreeLayout() const;

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

};

#endif