Class IRenderProgressCallback
See Also: Class IInteractiveRender, Class RendProgressCallback , Class Color
class IRenderProgressCallback : public RendProgressCallback
Description:
This class is available in release 4.0 and later only.
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.
Methods:
public:
Prototype:
virtual void SetProgressLineOrientation(LineOrientation orientation) = 0;
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.
Prototype:
virtual LineOrientation GetProgressLineOrientation() const = 0;
Remarks:
This method allows you to retrieve the orientation of the progress line shown during rendering.
Return Value:
The line orientation which is one of the following; LO_Horizontal or LO_Vertical.
Prototype:
virtual void SetProgressLineColor(const Color& color) = 0;
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.
Prototype:
virtual const Color& GetProgressLineColor() const = 0;
Remarks:
This method returns the color of the progress line shown during rendering.
Prototype:
virtual void SetIRenderTitle(const TCHAR *pProgressTitle) = 0;
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 TCHAR *pProgressTitle
The progress title string.
Prototype:
virtual const TCHAR *GetIRenderTitle() const = 0;
Remarks:
This method returns the current title.