xsi_renderercontext.h

Go to the documentation of this file.

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

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

#ifndef __XSIRENDERERCONTEXT_H__
#define __XSIRENDERERCONTEXT_H__

#include <xsi_base.h>
#include <xsi_value.h>
#include <xsi_context.h>
#include <xsi_time.h>

namespace XSI {

class Framebuffer;
class Property;

class RendererImageFragment
{
public:
    virtual unsigned int GetOffsetX( ) const = 0;

    virtual unsigned int GetOffsetY( ) const = 0;

    virtual unsigned int GetWidth( ) const = 0;

    virtual unsigned int GetHeight( ) const = 0;

    virtual bool GetScanlineRGBA( unsigned int in_uiRow, siImageBitDepth in_eBitDepth, unsigned char *out_pScanline ) const = 0;
};


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

class SICPPSDKDECL RendererContext : public Context
{
public:

    RendererContext();

    ~RendererContext();

    RendererContext(const CRef& in_ref);

    RendererContext(const RendererContext& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    RendererContext& operator=(const RendererContext& in_obj);

    RendererContext& operator=(const CRef& in_ref);

    CTime GetTime() const;

    unsigned int GetSequenceIndex( ) const;

    unsigned int GetSequenceLength( ) const;

    CStatus ProgressUpdate( const CString &in_strProgressShort, const CString &in_strProgressLong, int in_iPercentage );

    CStatus NewFrame( unsigned int in_uiWidth, unsigned int in_uiHeight );

    CStatus NewFragment( const RendererImageFragment &in_fragment );

    CStatus TriggerEvent( siEventID in_eEventID, siRenderingType in_eRenderingType, const CTime &in_rTime, const CStringArray &in_filenames, siRenderFieldType in_eFieldType, siRenderingErrorType in_eRenderErrorType );

    // For back-comp.
    CStatus TriggerEvent( siEventID in_eEventID, siRenderingType in_eRenderingType, const CTime &in_rTime, const CStringArray &in_filenames, siRenderFieldType in_eFieldType );

    Property GetRendererProperty( const CTime &in_rTime );

    Framebuffer GetDisplayFramebuffer( );

    CRefArray GetFramebuffers( );

    CStatus SetObjectClean( const CRef& in_ref );


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

};
#endif // __XSIRENDERERCONTEXT_H__