xsi_application.h

Go to the documentation of this file.

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

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

#ifndef __XSIAPPLICATION_H__
#define __XSIAPPLICATION_H__

#include <xsi_siobject.h>
#include <xsi_value.h>
#include <xsi_status.h>

namespace XSI {

class Selection;
class Dictionary;
class Command;
class CommandArray;
class Project;
class Model;
class Preferences;
class Desktop;
class UIToolkit;
class Plugin;
class UIToolkit;
class Factory;
class ProjectItem;
class ShaderDef;

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

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

    ~Application(){}

    Application(const CRef& in_ref);

    Application(const Application& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Application& operator=(const Application& in_obj);

    Application& operator=(const CRef& in_ref);

    Selection GetSelection() const;

    CRefArray GetFCurveSelection() const;

    Dictionary GetDictionary() const;

    Project GetActiveProject() const;

    CStatus PutActiveProject(const CString& in_Project) const;

    Model GetActiveSceneRoot() const;

    CString GetInstallationPath( siInstallationPath in_pathType ) const;

    CString GetVersion() const;

    CString GetLicense() const;

    CStatus InstallAddon( const CString& in_strFileName, siInstallationPath in_eInstallDir, bool in_bNoUI=false );

    CStatus UnInstallAddon( const CString& in_strFileName );

    Command CreateCommand( const CString& in_CommandName, siCommandCategory in_category = siNoCategory );

    CStatus AddCommand(const CRef& in_Cmd);

    CStatus RemoveCommand( const CString& name );

    CommandArray GetCommands() const;

    Command GetCommandByScriptingName(const CString& scriptingName) const ;

    CStatus ExecuteCommand
    (
        const CString&  in_name,
        CValueArray&    in_args,
        CValue&         io_val
    ) const;

    CStatus ExecuteCommand
    (
        const CString&      in_name,
        const CValueArray&  in_args,
        CValue&             io_val
    ) const;

    CScriptErrorDescriptor ExecuteScript
    (
        const CString &     in_ScriptFilename,
        const CString&      in_ScriptLanguage,
        const CString&      in_ScriptProcedure,
        CValueArray&        in_args,
        CValue&             out_returnval
    ) ;

    CScriptErrorDescriptor ExecuteScriptCode
    (
        const CString & in_ScriptCode,
        const CString&  in_ScriptLanguage
    ) ;

    CScriptErrorDescriptor ExecuteScriptProcedure
    (
        const CString & in_ScriptCode,
        const CString&  in_ScriptLanguage,
        const CString&  in_ScriptProcedure,
        CValueArray&    in_args,
        CValue&         out_returnval
    ) ;

    CRefArray GetEventInfos() const;

    CStatus LogMessage
    (
        const CString& in_Message,
        siSeverityType in_Sev = siInfoMsg
    ) const;

    CStatus CreateProject(
            const CString& in_ProjectPath,
            Project &out_rProject) const;

    Preferences GetPreferences() const;

    Desktop GetDesktop() const;

    Factory GetFactory() const;

    CString GetActiveToolName() const;

    UIToolkit GetUIToolkit() const;

    CRefArray GetFilters() const;

    CRefArray GetPlugins() const;

    bool IsInteractive() const;

    Plugin LoadPlugin( const CString& in_pluginPath );

    CStatus UnloadPlugin( const CString& in_pluginPath, bool in_bRemove );

    CStatus UpdatePlugins() ;

    CStatus AddWorkgroup(const CString& in_workgroupPath) ;

    CStatus RemoveWorkgroup(const CString& in_workgroupPath) ;

    CStringArray GetWorkgroups() ;

    CStatus RescanWorkgroups() ;

    CStatus ActivateWorkgroup( const CString& in_workgroupPath, bool in_bActivate ) ;

    CRefArray GetRenderers( ) ;

    ProjectItem GetObjectFromID( ULONG in_nID ) const;

    CSIObjectRefArray FindObjects( const XSI::siClassID& in_nClsID ) const;

    CSIObjectRefArray FindObjects( const CString& in_sCLSID ) const;

    ShaderDef GetShaderDef( const CString&  in_progID );

    CRefArray GetShaderDefinitions( );

    CStatus RegisterShaderFamily(
        const CString &in_strName,
        const CString &in_strDisplayName,
        const CString &in_strDescription,
        unsigned char in_nodeRed,
        unsigned char in_nodeGreen,
        unsigned char in_nodeBlue,
        bool        in_bShaderball
        );

    CStatus RegisterShaderCustomParameterType(
        const CString &in_strName,
        const CString &in_strDisplayName,
        const CString &in_strDescription,
        unsigned char in_portRed,
        unsigned char in_portGreen,
        unsigned char in_portBlue,
        const CStringArray &in_typeFilter,
        const CStringArray &in_familyFilter
        );

    CStatus OpenUndo( const CString& in_sComplexName );

    CStatus CloseUndo( );

    bool IsUndoing() const;
    
    ULONG GetCustomPropertyCount( const CString& in_strType ) const;

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



};

#endif // __XSIAPPLICATION_H__