xsi_renderer.h Source File
 
 
 
xsi_renderer.h
Go to the documentation of this file.
00001 //*****************************************************************************
00011 //*****************************************************************************
00012 
00013 #if (_MSC_VER > 1000) || defined(SGI_COMPILER)
00014 #pragma once
00015 #endif
00016 
00017 #ifndef __XSIRENDERER_H__
00018 #define __XSIRENDERER_H__
00019 
00020 #include <xsi_status.h>
00021 #include <xsi_longarray.h>
00022 
00023 namespace XSI {
00024 
00025 //*****************************************************************************
00033 //*****************************************************************************
00034 
00035 class SICPPSDKDECL Renderer : public SIObject
00036 {
00037 public:
00038 
00040         Renderer();
00041 
00043         ~Renderer();
00044 
00048         Renderer(const CRef& in_ref);
00049 
00053         Renderer(const Renderer& in_obj);
00054 
00059         bool IsA( siClassID in_ClassID) const;
00060 
00064         siClassID GetClassID() const;
00065 
00070         Renderer& operator=(const Renderer& in_obj);
00071 
00077         Renderer& operator=(const CRef& in_ref);
00078 
00079 
00089         CStatus PutProcessTypes( const CLongArray &in_types );
00090 
00095         CLongArray GetProcessTypes( );
00096 
00101         bool HasProcessType( siRenderProcessType in_eProcessType );
00102 
00119         CStatus PutArchiveFormat( const CString &in_strName, const CString &in_strExtension, bool in_bMultiFrame );
00120 
00132         CStatus GetArchiveFormat( CString &out_strName, CString &out_strExtension, bool &out_bMultiFrame );
00133 
00156         CStatus PutObjectArchiveFormat( const CString &in_strName, const CString &in_strExtension, bool in_bMultiFrame, bool in_bDisplayProxy );
00157 
00170         CStatus GetObjectArchiveFormat( CString &out_strName, CString &out_strExtension, bool &out_bMultiFrame, bool &out_bDisplayProxy );
00171 
00182         CStatus AddProperty( siRenderPropertyType in_eType, const CString &in_strName );
00183 
00191         CString GetPropertyName( siRenderPropertyType in_eType, bool in_bScriptingName = false );
00192 
00205         CStatus AddOutputImageFormat( const CString &in_strName, const CString &in_strExtension );
00206 
00214         CStatus GetOutputImageFormats( CStringArray &out_names, CStringArray &out_extensions );
00215 
00229         CStatus AddOutputImageFormatSubType( siRenderChannelType in_eChannelType, const CString &in_strDataType, siImageBitDepth in_eBitDepth );
00230 
00242         CStatus GetOutputImageFormatSubTypes( const CString &in_strName, CLongArray &out_channelTypes, CStringArray &out_dataTypes, CLongArray &out_bitDepths );
00243 
00255         CStatus AddDefaultChannel( const CString &in_strName, siRenderChannelType in_eChannelType );
00256 
00264         CStatus GetDefaultChannels( CStringArray &out_names, CLongArray &out_channelTypes );
00265 
00273         CString GetVersionString( );
00274 
00290         CStatus LockSceneData( );
00291 
00301         CStatus UnlockSceneData( );
00302 
00303         private:
00304         Renderer * operator&() const;
00305         Renderer * operator&();
00306 };
00307 
00308 };
00309 #endif // __XSIRENDERER_H__