xsi_pluginregistrar.h

Go to the documentation of this file.

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

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

#ifndef __XSIPLUGINREGISTRAR_H__
#define __XSIPLUGINREGISTRAR_H__

#include <xsi_siobject.h>
#include <xsi_pluginitem.h>

namespace XSI {

class ICENodeDef;

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

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

    ~PluginRegistrar();

    PluginRegistrar(const CRef& in_ref);

    PluginRegistrar(const PluginRegistrar& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    PluginRegistrar& operator=(const PluginRegistrar& in_obj);

    PluginRegistrar& operator=(const CRef& in_ref);

    PluginItem RegisterFilter( const CString& in_strName, siFilterType in_type );

    PluginItem RegisterCustomDisplay( const CString& in_strName );

    PluginItem RegisterProperty( const CString& in_strName );

    PluginItem RegisterDisplayCallback( const CString& in_strName );

    PluginItem RegisterDisplayPass( const CString& in_strName );

    PluginItem RegisterMenu(    siMenuAnchorPoints  in_anchorID,
                                const CString&      in_menuName,
                                bool                in_bDisplayAsSubmenu=true,
                                bool                in_bDynamicMenu=true );

    PluginItem RegisterCommand( const CString&  in_commandScriptName );

    PluginItem RegisterCommand( const CString&  in_commandName,
                                const CString&  in_commandScriptName );

    PluginItem RegisterEvent( const CString& in_eventName, const siEventID in_eventID );

    PluginItem RegisterTimerEvent(  const CString&  in_eventName,
                                    LONG            in_nInterval,
                                    LONG            in_nDelay=0 );

    PluginItem RegisterConverterEvent(  const CString&  in_eventName,
                                        const siEventID in_eventID,
                                        const CString&  in_eventExtension );

    PluginItem RegisterOperator( const CString& in_name );

    PluginItem RegisterRenderer( const CString& in_name );

    PluginItem RegisterICENode( const ICENodeDef& in_nodedef );

    PluginItem RegisterShaderLanguageParser( const CString& in_strParserName );

    PluginItem RegisterShader( const CString& in_strShaderClassName, ULONG in_ulMajorVersion, ULONG in_ulMinorVersion );

    PluginItem RegisterTool( const CString& in_name );

    CString GetAuthor() const;

    CString GetURL() const;

    CString GetEmail() const;

    CStatus GetVersion( LONG& out_major, LONG& out_minor ) const;

    CString GetLanguage() const;

    CString GetFilename() const;

    CStatus PutAuthor( const CString& in_strName );

    CStatus PutURL( const CString& in_strURL );

    CStatus PutEmail( const CString& in_strEmail );

    CStatus PutVersion( LONG in_major, LONG in_minor );

    CStatus PutHelp( const CString& in_strHelp );

    CStatus PutCategories( const CString& in_strCat );

    CStatus PutUserData( const CValue& in_userdata ) ;

    CValue GetUserData( ) const;

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

};

#endif // __XSIPluginRegistrar_H__