pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | Events | List of all members
X3g::Plugin::Renderer Class Referenceabstract

The base class for all renderer. More...

Public Member Functions

virtual void StartRendering (int pWidth, int pHeight)
 Starts rendering of frame. More...
 
virtual bool StartRendering (int pWidth, int pHeight, bool pSequenced)=0
 Starts rendering. More...
 
virtual void PauseRendering ()=0
 Pause rendering. More...
 
virtual void ContinueRendering ()=0
 Resumes rendering. More...
 
virtual void FinishRendering ()=0
 End all rendering or exporting. More...
 
virtual void ReadSettings (System::String^ pJson)=0
 Set the current settings. More...
 
virtual System::String^ WriteSettings ()=0
 Get the current settings. More...
 
virtual void ResetSettings ()=0
 This loads the default settings. More...
 
virtual void ExportRenderJob (int pWidth, int pHeight, ReadOnlyCollection< ICamera^ >^pCameras, System::String^ pFileName, System::String^ pEmail)=0
 This will export the current planning. More...
 

Properties

System::String^  Name [get]
 Unique name of the renderer. More...
 
System::String^  Description [get]
 Description of the renderer. More...
 
System::String^  ExportFormatExtension [get]
 Default file extension of export format. More...
 
ICamera^  Camera [get]
 Camera parameters. More...
 
IRenderCallback^  Callback
 Register a callback. More...
 

Events

RenderProgressChangedEventHandler^  PassProgressChanged
 Register an event to progress change. More...
 

Detailed Description

The base class for all renderer.

Member Function Documentation

virtual void X3g::Plugin::Renderer::ContinueRendering ( )
pure virtual

Resumes rendering.

Depending on the implementation it will just restart the rendering.

virtual void X3g::Plugin::Renderer::ExportRenderJob ( int  pWidth,
int  pHeight,
ReadOnlyCollection< ICamera^ >^  pCameras,
System::String^  pFileName,
System::String^  pEmail 
)
pure virtual

This will export the current planning.

Parameters
pWidthFrame width.
pHeightFrame height.
pCamerasA list of cameras to be rendered.
pFileNameFilename to write. This name should contain the render specific extension.
e.g.: An OSPRay export filename should end with .rjob
pEmailThe email of the User who exports the job.
virtual void X3g::Plugin::Renderer::FinishRendering ( )
pure virtual

End all rendering or exporting.

virtual void X3g::Plugin::Renderer::PauseRendering ( )
pure virtual

Pause rendering.

Depending on the implementation it will just stop the rendering.

virtual void X3g::Plugin::Renderer::ReadSettings ( System::String^  pJson)
pure virtual

Set the current settings.

virtual void X3g::Plugin::Renderer::ResetSettings ( )
pure virtual

This loads the default settings.

virtual void X3g::Plugin::Renderer::StartRendering ( int  pWidth,
int  pHeight 
)
virtual

Starts rendering of frame.

Parameters
pWidthFrame width.
pHeightFrame height.
Returns
Returns false if rendering has been aborted.
virtual bool X3g::Plugin::Renderer::StartRendering ( int  pWidth,
int  pHeight,
bool  pSequenced 
)
pure virtual

Starts rendering.

Parameters
pWidthFrame width.
pHeightFrame height.
pSequencedTrue if additional frames of same scene will follow.
Returns
Returns false if rendering has been aborted.
virtual System::String ^ X3g::Plugin::Renderer::WriteSettings ( )
pure virtual

Get the current settings.

Property Documentation

IRenderCallback^ X3g::Plugin::Renderer::Callback

Register a callback.

Remove callback by setting this to null.

ICamera^ X3g::Plugin::Renderer::Camera
get

Camera parameters.

It's not supported to assign another camera reference. Use ICamera::CopyFrom() instead.

System:: String^ X3g::Plugin::Renderer::Description
get

Description of the renderer.

System:: String^ X3g::Plugin::Renderer::ExportFormatExtension
get

Default file extension of export format.

System:: String^ X3g::Plugin::Renderer::Name
get

Unique name of the renderer.

Event Documentation

RenderProgressChangedEventHandler^ X3g::Plugin::Renderer::PassProgressChanged

Register an event to progress change.