IInteractiveRender::IProgressCallback Class Reference

This class represent a callback object which can be used with an interactive renderer. Information set via RendProgressCallback::SetCurField() or RendProgressCallback::SetSceneStats() will be ignored. If a title is set via the inherited method SetTitle(), it will appear in the main status bar, but will be replaced by the 'IRenderTitle' when necessary. An interactive renderer should abort if RendProgressCallback::Progress() returns RENDPROG_ABORT. More...

#include <IInteractiveRenderer.h>

Inheritance diagram for IInteractiveRender::IProgressCallback:

Public Types
enum	LineOrientation { LO_Horizontal = 0 , LO_Vertical }

Public Member Functions
virtual void	SetProgressLineOrientation (LineOrientation orientation)=0
virtual LineOrientation	GetProgressLineOrientation () const =0
virtual void	SetProgressLineColor (const Color &color)=0
virtual const Color &	GetProgressLineColor () const =0
virtual void	SetIRenderTitle (const MCHAR *pProgressTitle)=0
virtual const MCHAR *	GetIRenderTitle () const =0
Public Member Functions inherited from RendProgressCallback
virtual	~RendProgressCallback ()
	Destructor. More...
virtual void	SetTitle (const MCHAR *title)=0
	Allows the plug-in to set the string displayed in renderer dialog. More...
virtual int	Progress (int done, int total)=0
	Allows the plug-in to update the renderer progress display. More...
virtual void	SetCurField (int)
	Sets the field number display. More...
virtual void	SetSceneStats (int, int, int, int, int)
	The plug-in renderer should call this on every frame, passing in values for the various parameters. More...
virtual void	SetStep (int current, int total)=0
	Sets the current rendering process step. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

This class represent a callback object which can be used with an interactive renderer. Information set via RendProgressCallback::SetCurField() or RendProgressCallback::SetSceneStats() will be ignored. If a title is set via the inherited method SetTitle(), it will appear in the main status bar, but will be replaced by the 'IRenderTitle' when necessary. An interactive renderer should abort if RendProgressCallback::Progress() returns RENDPROG_ABORT.

See also

Class IInteractiveRender, Class RendProgressCallback, Class Color

Member Enumeration Documentation

LineOrientation

enum LineOrientation

Enumerator
LO_Horizontal
LO_Vertical

{ LO_Horizontal = 0, LO_Vertical };

Member Function Documentation

SetProgressLineOrientation()

virtual void SetProgressLineOrientation ( LineOrientation  orientation )

pure virtual

Remarks

This method allows you to set the orientation of the progress line shown during rendering.

Parameters:

LineOrientation orientation

The line orientation which is one of the following; LO_Horizontal or LO_Vertical.

GetProgressLineOrientation()

virtual LineOrientation GetProgressLineOrientation ( ) const

pure virtual

Remarks

This method allows you to retrieve the orientation of the progress line shown during rendering.

Returns

The line orientation which is one of the following; LO_Horizontal or LO_Vertical.

SetProgressLineColor()

virtual void SetProgressLineColor ( const Color &  color )

pure virtual

Remarks

This method allows you to set the color of the progress line shown during rendering.

Parameters:

const Color& color

The color to set the progress line to.

GetProgressLineColor()

virtual const Color& GetProgressLineColor ( ) const

pure virtual

Remarks

This method returns the color of the progress line shown during rendering.

SetIRenderTitle()

virtual void SetIRenderTitle ( const MCHAR *  pProgressTitle )

pure virtual

Remarks

This method allows you to set the current title. This will appear in the main status bar as "'Title': xx% complete". If no title is provided, 'ActiveShade' will be used instead.

Parameters:

const MCHAR *pProgressTitle

The progress title string.

GetIRenderTitle()

virtual const MCHAR* GetIRenderTitle ( ) const

pure virtual

Remarks

This method returns the current title.