xsi_renderer.h

Go to the documentation of this file.

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

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

#ifndef __XSIRENDERER_H__
#define __XSIRENDERER_H__

#include <xsi_status.h>
#include <xsi_longarray.h>

namespace XSI {

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

class SICPPSDKDECL Renderer : public SIObject
{
public:

    Renderer();

    ~Renderer();

    Renderer(const CRef& in_ref);

    Renderer(const Renderer& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Renderer& operator=(const Renderer& in_obj);

    Renderer& operator=(const CRef& in_ref);


    CStatus PutProcessTypes( const CLongArray &in_types );

    CLongArray GetProcessTypes( );

    bool HasProcessType( siRenderProcessType in_eProcessType );

    CStatus PutArchiveFormat( const CString &in_strName, const CString &in_strExtension, bool in_bMultiFrame );

    CStatus GetArchiveFormat( CString &out_strName, CString &out_strExtension, bool &out_bMultiFrame );

    CStatus PutObjectArchiveFormat( const CString &in_strName, const CString &in_strExtension, bool in_bMultiFrame, bool in_bDisplayProxy );

    CStatus GetObjectArchiveFormat( CString &out_strName, CString &out_strExtension, bool &out_bMultiFrame, bool &out_bDisplayProxy );

    CStatus AddProperty( siRenderPropertyType in_eType, const CString &in_strName );

    CString GetPropertyName( siRenderPropertyType in_eType, bool in_bScriptingName = false );

    CStatus AddOutputImageFormat( const CString &in_strName, const CString &in_strExtension );

    CStatus GetOutputImageFormats( CStringArray &out_names, CStringArray &out_extensions );

    CStatus AddOutputImageFormatSubType( siRenderChannelType in_eChannelType, const CString &in_strDataType, siImageBitDepth in_eBitDepth );

    CStatus GetOutputImageFormatSubTypes( const CString &in_strName, CLongArray &out_channelTypes, CStringArray &out_dataTypes, CLongArray &out_bitDepths );

    CStatus AddDefaultChannel( const CString &in_strName, siRenderChannelType in_eChannelType );

    CStatus GetDefaultChannels( CStringArray &out_names, CLongArray &out_channelTypes );

    CString GetVersionString( );

    CStatus LockSceneData( );

    CStatus UnlockSceneData( );

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

};
#endif // __XSIRENDERER_H__