IRenderProgressCallback Class Reference
 
 
 
IRenderProgressCallback Class Reference

#include <interactiverender.h>

Inheritance diagram for IRenderProgressCallback:
RendProgressCallback MaxHeapOperators

Class 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

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

Member Enumeration Documentation


Member Function Documentation

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.
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.
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.
virtual const Color& GetProgressLineColor ( ) const [pure virtual]
Remarks:
This method returns the color of the progress line shown during rendering.
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.
virtual const MCHAR* GetIRenderTitle ( ) const [pure virtual]
Remarks:
This method returns the current title.