ParCompMark::Process

ParCompMark::Process Class Reference

#include <PCMProcess.h>

Inheritance diagram for ParCompMark::Process:

Inheritance graph
[legend]
Collaboration diagram for ParCompMark::Process:

Collaboration graph
[legend]
List of all members.

Detailed Description

Entity that composite or render something.

Definition at line 91 of file PCMProcess.h.


Methods

virtual void threadInitialize ()
 Some init step as thread.
virtual void threadFinalize ()
 Some finitiate step as thread.
virtual void start ()
 Start the process.
virtual u32 stop ()
 Stop the process.
virtual Context * addContext ()
 Create and add a context to the context list.
virtual void initPC ()
 Intialize PC functionality.
virtual void openRenderWindow (const std::string caption="PCM Framework", const std::string &displayName="", const bool &fullScreen=true, const u32 &colourDepth=0, const u32 &width=GLXRenderWindow::MAXIMALSIZE, const u32 &height=GLXRenderWindow::MAXIMALSIZE, const s32 &left=GLXRenderWindow::CENTERED, const s32 &top=GLXRenderWindow::CENTERED, const u32 &fsaaSamples=0)
 Open GLX render window for rendering.
virtual void actualizeRenderWindow ()
 Actualize GLX render window on PC information (frame sizes etc).
virtual void setViewportForRendering ()
 Setup viewport for the rendering process based on the context properties.
virtual void displayFrameletIcon ()
 Display small icon on to top-left corner of the GLX window indicating the frame/framelet relationship for this process.
virtual void initProcess ()
 This is an initializing method.
virtual void runningProcess ()
 This method achieves the "real functionality" of the process.
virtual void setProcessTypeSq (const int processType)
 Alternate squirrel setter of mProcessType.
virtual int getProcessTypeSq ()
 Alternate squirrel setter of mProcessType.
virtual void setBufferByName (const char *name)
 Set mBuffer by name.
virtual void setFinito (const u32 &frameID)
 Set parameters to finite pc.
virtual void task ()
 What we do during rendering/compositing.
virtual void refreshSortOrder ()
 Refresh the sort order of the framelet produced by this process.
virtual void gatherStatistics ()
 Gather rendering statistics for the current frame.

Public Types

typedef Pointer< Process,
Mutex > 		Pointer
 Type for pointer on this class.
typedef std::list< Context::Pointer > ContextList
 Type for context list.
typedef ContextList::iterator ContextListIterator
 Type for context list iterator.
 COMPOSITE = 0
 Process composite and provides frame and requires framelets.
 RENDER = 1
 Process provides framelets.
enum  ProcessType { COMPOSITE = 0, RENDER = 1 }
 The control type of PC context (Local, Global). More...

Public Member Functions

Constructors & destructor
 Process ()
 Default constructor for Squirrel compatibility.
 Process (const std::string &name, Node *parent)
 Creates a process with a specified name.
virtual ~Process ()
 The destructor.
Getters & setters
Process::ContextList & getContexts ()
 Getter of mContexts.
Process::ProcessType & getProcessType ()
 Getter of mProcessType.
void setProcessType (const Process::ProcessType &processtype)
 Setter of mProcessType.
Node * getParent () const
 Getter of mParent.
GLXRenderWindow::Pointer & getRenderWindow ()
 Getter of mRenderWindow.
OpenGLRenderingEngine::Pointer & getRenderingEngine ()
 Getter of mRenderingEngine.
char * getInitProcCode ()
 Getter of mInitProcCode.
void setInitProcCode (const char *initproccode)
 Setter of mInitProcCode.
char * getRunningProcCode ()
 Getter of mRunningProcCode.
void setRunningProcCode (const char *runningproccode)
 Setter of mRunningProcCode.
Buffer::Pointer & getBuffer ()
 Getter of mBuffer.
const bool & getInitialized () const
 Getter of mInitialized.
PCuint & getSortOrder ()
 Getter of mSortOrder.
void setSortOrder (const PCuint sortorder)
 Setter of mSortOrder.
PCid & getStopID ()
 Getter of mStopID.
void setStopID (const PCid stopid)
 Setter of mStopID.
bool & getOperate ()
 Getter of mOperate.
void setOperate (const bool operate)
 Setter of mOperate.
bool & getDisplayOutput ()
 Getter of mDisplayOutput.
void setDisplayOutput (const bool displayoutput)
 Setter of mDisplayOutput.
bool & getGatherStatistics ()
 Getter of mGatherStatistics.
void setGatherStatistics (const bool gatherstatistics)
 Setter of mGatherStatistics.
const u32 & getFrameNumber () const
 Getter of mFrameNumber.
const Real & getFrameTime () const
 Getter of mFrameTime.
const Real & getStartTime () const
 Getter of mStartTime.
void setStartTime (const Real &starttime)
 Setter of mStartTime.
const bool & getStop () const
 Getter of mStop.
void setStop (const bool &stop)
 Setter of mStop.
const bool & getStopAble () const
 Getter of mStopAble.
void setStopAble (const bool &stopable)
 Setter of mStopAble.
const bool & getCountedStop () const
 Getter of mCountedStop.
void setCountedStop (const bool &countedstop)
 Setter of mCountedStop.
OutputNode::Pointer & getOutputDocument ()
 Getter of mOutputDocument.
const bool & getShowFrameletIcon () const
 Getter of mShowFrameletIcon.
int & getExportFrameStep ()
 Getter of mExportFrameStep.
void setExportFrameStep (const int exportframestep)
 Setter of mExportFrameStep.
char * getFrameFilenamePattern ()
 Getter of mFrameFilenamePattern.
void setFrameFilenamePattern (const char *framefilenamepattern)
 Setter of mFrameFilenamePattern.

Static Public Member Functions

Scripting binding
static void squirrelGlue ()
 Static glue code method for Squirrel-C++ binding.

Static Public Attributes

Class constants
static const std::string PROCESSINITNUT = "scripts/framework/process-init.nut"
 Process initializer Squirrel script file (relative to the data directory).
static const std::string DEFAULTEXPORTPATTERN = "%06d.png"
 Default filename pattern for exporting frames.

Protected Attributes

Variables
ContextList mContexts
 List of contexts.
ProcessType mProcessType
 Composite or render process.
Node * mParent
 Parent node of the process.
GLXRenderWindow::Pointer mRenderWindow
 Renderwindow of this process.
OpenGLRenderingEngine::Pointer mRenderingEngine
 Rendering engine of this process.
SqVM::Pointer mSqVM
 Squirrel virtual machine.
char * mInitProcCode
 Squirrel initialization code (C string for squirrel compatibility).
char * mRunningProcCode
 Squirrel running code (C string for squirrel compatibility).
Buffer::Pointer mBuffer
 Graphics memory buffer on which the process operates.
bool mInitialized
 The process is initialized.
PCuint mSortOrder
 Value for alpha sorting.
PCid mStopID
 Stop id where composite is ended.
bool mOperate
 Flag indicates that the process operates, ie.
bool mDisplayOutput
 Flag indicates that the output of the compositing process is rendered on the screen.
bool mGatherStatistics
 This flag indicates that the process has to gather rendering statistics.
u32 mFrameNumber
 Number of current frame.
Real mFrameTime
 Time elapsed between the start of the benchmark and the start of the current frame.
Real mStartTime
 Local (uncorrected) time at the start of the benchmark for this process.
bool mStop
 Indicates that process must be stopped.
bool mStopAble
 Indicates that process can be stopped during compositing.
bool mCountedStop
 Indicates that process can call application that the compositing is ended.
OutputNode::Pointer mOutputDocument
 Process output document.
bool mShowFrameletIcon
 Show little framelet icon on rendering windows.
int mExportFrameStep
 The process will export any (mExportFrameStep)th frame in mFrameFilenamePattern format.
char * mFrameFilenamePattern
 Filename pattern for exporting frames (C string for squirrel compatibility).

Member Typedef Documentation

typedef std::list< Context::Pointer > ParCompMark::Process::ContextList

Type for context list.

One process can render in several context.

Definition at line 176 of file PCMProcess.h.

typedef ContextList::iterator ParCompMark::Process::ContextListIterator

Type for context list iterator.

Definition at line 179 of file PCMProcess.h.

typedef Pointer< Process, Mutex > ParCompMark::Process::Pointer

Type for pointer on this class.

Definition at line 173 of file PCMProcess.h.

Member Enumeration Documentation

enum ParCompMark::Process::ProcessType

The control type of PC context (Local, Global).

Enumerator:
COMPOSITE  Process composite and provides frame and requires framelets.
RENDER  Process provides framelets.

Definition at line 155 of file PCMProcess.h.

Constructor & Destructor Documentation

ParCompMark::Process::Process (  ) 

Default constructor for Squirrel compatibility.

Calling this constructor always raises an exception.

Definition at line 60 of file PCMProcess.cpp.

References Except.

ParCompMark::Process::Process ( const std::string &  name,
Node *  parent 
)

Creates a process with a specified name.

Parameters:
[in] name Name of the host.
[in] parent Parent node

Definition at line 97 of file PCMProcess.cpp.

References Assert, DEFAULTEXPORTPATTERN, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Timer::getSystemTime(), ParCompMark::OutputNode::INFORMATION, mCountedStop, mDisplayOutput, mExportFrameStep, mFrameFilenamePattern, mFrameNumber, mFrameTime, mGatherStatistics, mInitialized, mInitProcCode, ParCompMark::Name::mName, mOperate, mOutputDocument, mProcessType, mRunningProcCode, mShowFrameletIcon, mStartTime, mStop, mStopAble, mStopID, ParCompMark::Logger::NOTICE, and RENDER.

Here is the call graph for this function:

ParCompMark::Process::~Process (  )  [virtual]

The destructor.

This class has virtual destructor.

Definition at line 182 of file PCMProcess.cpp.

References DEFAULTEXPORTPATTERN, ParCompMark::Singleton< T >::getInstance(), mFrameFilenamePattern, mInitProcCode, ParCompMark::Name::mName, mRunningProcCode, and ParCompMark::Logger::NOTICE.

Here is the call graph for this function:

Member Function Documentation

void ParCompMark::Process::actualizeRenderWindow (  )  [virtual]

Actualize GLX render window on PC information (frame sizes etc).

Definition at line 412 of file PCMProcess.cpp.

References ParCompMark::GLXRenderWindow::CENTERED, ParCompMark::Pointer< T, Lock >::lock(), mBuffer, mRenderingEngine, mRenderWindow, and ParCompMark::Pointer< T, Lock >::unlock().

Referenced by threadInitialize().

Here is the call graph for this function:

Context * ParCompMark::Process::addContext (  )  [virtual]

Create and add a context to the context list.

Returns:
The new context

Definition at line 328 of file PCMProcess.cpp.

References ParCompMark::Pointer< T, Lock >::getPtr(), and mContexts.

Referenced by squirrelGlue().

Here is the call graph for this function:

void ParCompMark::Process::displayFrameletIcon (  )  [virtual]

Display small icon on to top-left corner of the GLX window indicating the frame/framelet relationship for this process.

Definition at line 452 of file PCMProcess.cpp.

References mBuffer, mContexts, mRenderingEngine, and mRenderWindow.

Referenced by task().

void ParCompMark::Process::gatherStatistics (  )  [protected, virtual]

Gather rendering statistics for the current frame.

Definition at line 820 of file PCMProcess.cpp.

References ParCompMark::GLXRenderWindow::WindowStatistics::avgFPS, ParCompMark::GLXRenderWindow::WindowStatistics::avgTriangleCount, ParCompMark::GLXRenderWindow::WindowStatistics::bestFPS, ParCompMark::GLXRenderWindow::WindowStatistics::bestFrameTime, ParCompMark::StringConverter::DEFAULTFIELDWIDTH, Except, ParCompMark::GLXRenderWindow::WindowStatistics::frameBeginTime, ParCompMark::GLXRenderWindow::WindowStatistics::frameEndTime, ParCompMark::GLXRenderWindow::WindowStatistics::lastFPS, ParCompMark::GLXRenderWindow::WindowStatistics::lastFrameTime, ParCompMark::GLXRenderWindow::WindowStatistics::lastTriangleCount, ParCompMark::GLXRenderWindow::WindowStatistics::maxTriangleCount, mContexts, ParCompMark::GLXRenderWindow::WindowStatistics::minTriangleCount, mOutputDocument, mRenderWindow, ParCompMark::GLXRenderWindow::WindowStatistics::renderingTime, ParCompMark::OutputNode::STATISTICS, ParCompMark::StringConverter::toString(), ParCompMark::GLXRenderWindow::WindowStatistics::worstFPS, and ParCompMark::GLXRenderWindow::WindowStatistics::worstFrameTime.

Referenced by task().

Here is the call graph for this function:

Buffer::Pointer & ParCompMark::Process::getBuffer (  )  [inline]

Getter of mBuffer.

Returns value of mBuffer.

Returns:
The value of mBuffer

Definition at line 950 of file PCMProcess.h.

Process::ContextList & ParCompMark::Process::getContexts (  )  [inline]

Getter of mContexts.

Returns value of mContexts.

Returns:
The value of mContexts

Definition at line 876 of file PCMProcess.h.

Referenced by ParCompMark::GLXRenderWindow::_setCaption().

const bool & ParCompMark::Process::getCountedStop (  )  const [inline]

Getter of mCountedStop.

Returns value of mCountedStop.

Returns:
The value of mCountedStop

Definition at line 1090 of file PCMProcess.h.

bool & ParCompMark::Process::getDisplayOutput (  )  [inline]

Getter of mDisplayOutput.

Returns value of mDisplayOutput.

Returns:
The value of mDisplayOutput

Definition at line 1006 of file PCMProcess.h.

Referenced by squirrelGlue().

int & ParCompMark::Process::getExportFrameStep (  )  [inline]

Getter of mExportFrameStep.

Returns value of mExportFrameStep.

Returns:
The value of mExportFrameStep

Definition at line 1118 of file PCMProcess.h.

Referenced by squirrelGlue().

char * ParCompMark::Process::getFrameFilenamePattern (  )  [inline]

Getter of mFrameFilenamePattern.

Returns value of mFrameFilenamePattern.

Returns:
The value of mFrameFilenamePattern

Definition at line 1132 of file PCMProcess.h.

Referenced by squirrelGlue().

const u32 & ParCompMark::Process::getFrameNumber (  )  const [inline]

Getter of mFrameNumber.

Returns value of mFrameNumber.

Returns:
The value of mFrameNumber

Definition at line 1034 of file PCMProcess.h.

const Real & ParCompMark::Process::getFrameTime (  )  const [inline]

Getter of mFrameTime.

Returns value of mFrameTime.

Returns:
The value of mFrameTime

Definition at line 1041 of file PCMProcess.h.

bool & ParCompMark::Process::getGatherStatistics (  )  [inline]

Getter of mGatherStatistics.

Returns value of mGatherStatistics.

Returns:
The value of mGatherStatistics

Definition at line 1020 of file PCMProcess.h.

Referenced by squirrelGlue().

const bool & ParCompMark::Process::getInitialized (  )  const [inline]

Getter of mInitialized.

Returns value of mInitialized.

Returns:
The value of mInitialized

Definition at line 957 of file PCMProcess.h.

char * ParCompMark::Process::getInitProcCode (  )  [inline]

Getter of mInitProcCode.

Returns value of mInitProcCode.

Returns:
The value of mInitProcCode

Definition at line 918 of file PCMProcess.h.

Referenced by squirrelGlue().

bool & ParCompMark::Process::getOperate (  )  [inline]

Getter of mOperate.

Returns value of mOperate.

Returns:
The value of mOperate

Definition at line 992 of file PCMProcess.h.

Referenced by squirrelGlue().

OutputNode::Pointer & ParCompMark::Process::getOutputDocument (  )  [inline]

Getter of mOutputDocument.

Returns value of mOutputDocument.

Returns:
The value of mOutputDocument

Definition at line 1104 of file PCMProcess.h.

Node * ParCompMark::Process::getParent (  )  const [inline]

Getter of mParent.

Returns value of mParent.

Returns:
The value of mParent

Definition at line 897 of file PCMProcess.h.

Referenced by ParCompMark::RendererPlugin::_bufferGetter(), and openRenderWindow().

Process::ProcessType & ParCompMark::Process::getProcessType (  )  [inline]

Getter of mProcessType.

Returns value of mProcessType.

Returns:
The value of mProcessType

Definition at line 883 of file PCMProcess.h.

int ParCompMark::Process::getProcessTypeSq (  )  [inline, virtual]

Alternate squirrel setter of mProcessType.

Returns:
Process type int value (0 means COMPOSITE, 1 means RENDER).

Definition at line 1157 of file PCMProcess.h.

Referenced by squirrelGlue().

OpenGLRenderingEngine::Pointer & ParCompMark::Process::getRenderingEngine (  )  [inline]

Getter of mRenderingEngine.

Returns value of mRenderingEngine.

Returns:
The value of mRenderingEngine

Definition at line 911 of file PCMProcess.h.

GLXRenderWindow::Pointer & ParCompMark::Process::getRenderWindow (  )  [inline]

Getter of mRenderWindow.

Returns value of mRenderWindow.

Returns:
The value of mRenderWindow

Definition at line 904 of file PCMProcess.h.

Referenced by ParCompMark::OpenGLRenderingEngine::_reportTriangles(), ParCompMark::OpenGLRenderingEngine::createCustomRenderer(), ParCompMark::OpenGLRenderingEngine::executeDisplayList(), ParCompMark::OpenGLRenderingEngine::perspective(), and ParCompMark::OpenGLRenderingEngine::viewport().

char * ParCompMark::Process::getRunningProcCode (  )  [inline]

Getter of mRunningProcCode.

Returns value of mRunningProcCode.

Returns:
The value of mRunningProcCode

Definition at line 934 of file PCMProcess.h.

Referenced by squirrelGlue().

const bool & ParCompMark::Process::getShowFrameletIcon (  )  const [inline]

Getter of mShowFrameletIcon.

Returns value of mShowFrameletIcon.

Returns:
The value of mShowFrameletIcon

Definition at line 1111 of file PCMProcess.h.

PCuint & ParCompMark::Process::getSortOrder (  )  [inline]

Getter of mSortOrder.

Returns value of mSortOrder.

Returns:
The value of mSortOrder

Definition at line 964 of file PCMProcess.h.

Referenced by squirrelGlue().

const Real & ParCompMark::Process::getStartTime (  )  const [inline]

Getter of mStartTime.

Returns value of mStartTime.

Returns:
The value of mStartTime

Definition at line 1048 of file PCMProcess.h.

Referenced by ParCompMark::Context::initialize().

const bool & ParCompMark::Process::getStop (  )  const [inline]

Getter of mStop.

Returns value of mStop.

Returns:
The value of mStop

Definition at line 1062 of file PCMProcess.h.

const bool & ParCompMark::Process::getStopAble (  )  const [inline]

Getter of mStopAble.

Returns value of mStopAble.

Returns:
The value of mStopAble

Definition at line 1076 of file PCMProcess.h.

PCid & ParCompMark::Process::getStopID (  )  [inline]

Getter of mStopID.

Returns value of mStopID.

Returns:
The value of mStopID

Definition at line 978 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::initPC (  )  [virtual]

Intialize PC functionality.

Definition at line 341 of file PCMProcess.cpp.

References Assert, COMPOSITE, Except, mBuffer, mContexts, mProcessType, and mSortOrder.

Referenced by threadInitialize().

void ParCompMark::Process::initProcess (  )  [virtual]

This is an initializing method.

Called at the start of the working process. Starts a Squirrel VM and executes the initialization code.

Definition at line 530 of file PCMProcess.cpp.

References ParCompMark::Logger::DEBUG, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Pointer< T, Lock >::isNotNull(), ParCompMark::Pointer< T, Lock >::lock(), mInitProcCode, ParCompMark::Name::mName, mRenderWindow, mSqVM, and ParCompMark::Pointer< T, Lock >::unlock().

Referenced by threadInitialize().

Here is the call graph for this function:

void ParCompMark::Process::openRenderWindow ( const std::string  caption = "PCM Framework",
const std::string &  displayName = "",
const bool &  fullScreen = true,
const u32 &  colourDepth = 0,
const u32 &  width = GLXRenderWindow::MAXIMALSIZE,
const u32 &  height = GLXRenderWindow::MAXIMALSIZE,
const s32 &  left = GLXRenderWindow::CENTERED,
const s32 &  top = GLXRenderWindow::CENTERED,
const u32 &  fsaaSamples = 0 
) [virtual]

Open GLX render window for rendering.

Parameters:
[in] caption Window caption
[in] displayName X display name
[in] fullScreen The window appears in full screen mode
[in] colourDepth Colour depth of the window
[in] width Horizontal size
[in] height Vertical size
[in] left Horizontal position
[in] top Vertical position
[in] fsaaSamples Number of fullscreen antialasing samples (Do not use FSAA samples other than 0 now with nVidia cards!)

Definition at line 378 of file PCMProcess.cpp.

References ParCompMark::Logger::DEBUG, ParCompMark::Singleton< T >::getInstance(), getParent(), ParCompMark::Pointer< T, Lock >::lock(), ParCompMark::Name::mName, mRenderWindow, ParCompMark::Timer::sleep(), ParCompMark::Pointer< T, Lock >::unlock(), and ParCompMark::Logger::WARNING.

Referenced by threadInitialize().

Here is the call graph for this function:

void ParCompMark::Process::refreshSortOrder (  )  [protected, virtual]

Refresh the sort order of the framelet produced by this process.

Definition at line 809 of file PCMProcess.cpp.

References mRenderingEngine, and mSortOrder.

Referenced by task().

void ParCompMark::Process::runningProcess (  )  [virtual]

This method achieves the "real functionality" of the process.

Called at every frame. Starts a Squirrel VM and executes the initialization code.

Definition at line 546 of file PCMProcess.cpp.

References COMPOSITE, ParCompMark::Timer::getSystemTime(), ParCompMark::Pointer< T, Lock >::lock(), mBuffer, mDisplayOutput, mFrameNumber, mFrameTime, mProcessType, mRenderingEngine, mRenderWindow, mRunningProcCode, mSqVM, mStartTime, RENDER, setViewportForRendering(), ParCompMark::StringConverter::toString(), and ParCompMark::Pointer< T, Lock >::unlock().

Referenced by task().

Here is the call graph for this function:

void ParCompMark::Process::setBufferByName ( const char *  name  )  [virtual]

Set mBuffer by name.

mBuffer will be retrieved from the buffer container of the parent node by the name of the buffer.

Parameters:
[in] name Name of the buffer (C string for squirrel compatibility).

Definition at line 615 of file PCMProcess.cpp.

References ParCompMark::Node::getBuffer(), mBuffer, and mParent.

Referenced by squirrelGlue().

Here is the call graph for this function:

void ParCompMark::Process::setCountedStop ( const bool &  countedstop  )  [inline]

Setter of mCountedStop.

Sets value of mCountedStop.

Parameters:
[in] countedstop The value of mCountedStop

Definition at line 1097 of file PCMProcess.h.

void ParCompMark::Process::setDisplayOutput ( const bool  displayoutput  )  [inline]

Setter of mDisplayOutput.

Sets value of mDisplayOutput.

Parameters:
[in] displayoutput The value of mDisplayOutput

Definition at line 1013 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setExportFrameStep ( const int  exportframestep  )  [inline]

Setter of mExportFrameStep.

Sets value of mExportFrameStep.

Parameters:
[in] exportframestep The value of mExportFrameStep

Definition at line 1125 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setFinito ( const u32 &  frameID  )  [virtual]

Set parameters to finite pc.

Parameters:
[in] frameID StopID.

Definition at line 622 of file PCMProcess.cpp.

References mStop, and mStopID.

void ParCompMark::Process::setFrameFilenamePattern ( const char *  framefilenamepattern  )  [inline]

Setter of mFrameFilenamePattern.

Sets value of mFrameFilenamePattern.

Parameters:
[in] framefilenamepattern The value of mFrameFilenamePattern

Definition at line 1139 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setGatherStatistics ( const bool  gatherstatistics  )  [inline]

Setter of mGatherStatistics.

Sets value of mGatherStatistics.

Parameters:
[in] gatherstatistics The value of mGatherStatistics

Definition at line 1027 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setInitProcCode ( const char *  initproccode  )  [inline]

Setter of mInitProcCode.

Sets value of mInitProcCode.

Parameters:
[in] initproccode The value of mInitProcCode

Definition at line 925 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setOperate ( const bool  operate  )  [inline]

Setter of mOperate.

Sets value of mOperate.

Parameters:
[in] operate The value of mOperate

Definition at line 999 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setProcessType ( const Process::ProcessType &  processtype  )  [inline]

Setter of mProcessType.

Sets value of mProcessType.

Parameters:
[in] processtype The value of mProcessType

Definition at line 890 of file PCMProcess.h.

void ParCompMark::Process::setProcessTypeSq ( const int  processType  )  [inline, virtual]

Alternate squirrel setter of mProcessType.

Parameters:
[in] processType Process type int value (0 means COMPOSITE, 1 means RENDER).

Definition at line 1150 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setRunningProcCode ( const char *  runningproccode  )  [inline]

Setter of mRunningProcCode.

Sets value of mRunningProcCode.

Parameters:
[in] runningproccode The value of mRunningProcCode

Definition at line 941 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setSortOrder ( const PCuint  sortorder  )  [inline]

Setter of mSortOrder.

Sets value of mSortOrder.

Parameters:
[in] sortorder The value of mSortOrder

Definition at line 971 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setStartTime ( const Real &  starttime  )  [inline]

Setter of mStartTime.

Sets value of mStartTime.

Parameters:
[in] starttime The value of mStartTime

Definition at line 1055 of file PCMProcess.h.

Referenced by ParCompMark::Context::initialize().

void ParCompMark::Process::setStop ( const bool &  stop  )  [inline]

Setter of mStop.

Sets value of mStop.

Parameters:
[in] stop The value of mStop

Definition at line 1069 of file PCMProcess.h.

void ParCompMark::Process::setStopAble ( const bool &  stopable  )  [inline]

Setter of mStopAble.

Sets value of mStopAble.

Parameters:
[in] stopable The value of mStopAble

Definition at line 1083 of file PCMProcess.h.

void ParCompMark::Process::setStopID ( const PCid  stopid  )  [inline]

Setter of mStopID.

Sets value of mStopID.

Parameters:
[in] stopid The value of mStopID

Definition at line 985 of file PCMProcess.h.

Referenced by squirrelGlue().

void ParCompMark::Process::setViewportForRendering (  )  [virtual]

Setup viewport for the rendering process based on the context properties.

Definition at line 426 of file PCMProcess.cpp.

References mBuffer, mContexts, and mRenderingEngine.

Referenced by runningProcess().

static void ParCompMark::Process::squirrelGlue (  )  [inline, static]

Static glue code method for Squirrel-C++ binding.

This method should be call from each Squirrel virtual machines to generate the proper Squirrel glue code. To content of this method is fully autogenerated in the header implementation file, you should not modify it.

Definition at line 116 of file PCMProcess.h.

References addContext(), COMPOSITE, getDisplayOutput(), getExportFrameStep(), getFrameFilenamePattern(), getGatherStatistics(), getInitProcCode(), getOperate(), getProcessTypeSq(), getRunningProcCode(), getSortOrder(), getStopID(), RENDER, setBufferByName(), setDisplayOutput(), setExportFrameStep(), setFrameFilenamePattern(), setGatherStatistics(), setInitProcCode(), setOperate(), setProcessTypeSq(), setRunningProcCode(), setSortOrder(), and setStopID().

Referenced by ParCompMark::squirrelClassBindings().

Here is the call graph for this function:

void ParCompMark::Process::start (  )  [virtual]

Start the process.

Definition at line 305 of file PCMProcess.cpp.

References ParCompMark::Thread::startThread().

Here is the call graph for this function:

u32 ParCompMark::Process::stop (  )  [virtual]

Stop the process.

Returns:
frameID

Definition at line 312 of file PCMProcess.cpp.

References mContexts, mStop, mStopAble, and ParCompMark::Thread::wait().

Here is the call graph for this function:

void ParCompMark::Process::task (  )  [protected, virtual]

What we do during rendering/compositing.

Reimplemented from ParCompMark::Thread.

Definition at line 642 of file PCMProcess.cpp.

References Assert, COMPOSITE, displayFrameletIcon(), Except, gatherStatistics(), ParCompMark::Thread::go(), ParCompMark::Pointer< T, Lock >::lock(), mBuffer, mContexts, mExportFrameStep, mFrameFilenamePattern, mFrameNumber, mGatherStatistics, ParCompMark::Name::mName, mOperate, mProcessType, mRenderWindow, mShowFrameletIcon, mSortOrder, mStop, mStopAble, mStopID, refreshSortOrder(), RENDER, runningProcess(), ParCompMark::Thread::stopThread(), ParCompMark::Pointer< T, Lock >::unlock(), and ParCompMark::Thread::wait().

Here is the call graph for this function:

void ParCompMark::Process::threadFinalize (  )  [virtual]

Some finitiate step as thread.

Reimplemented from ParCompMark::Thread.

Definition at line 273 of file PCMProcess.cpp.

References ParCompMark::Application::_pseudoStop(), ParCompMark::Logger::DEBUG, ParCompMark::Host::getEndProcessCount(), ParCompMark::Singleton< T >::getInstance(), ParCompMark::Application::getInstance(), ParCompMark::Host::getInstance(), ParCompMark::Host::getProcessCount(), ParCompMark::Pointer< T, Lock >::getPtr(), ParCompMark::Pointer< T, Lock >::kill(), ParCompMark::Pointer< T, Lock >::lock(), mContexts, mCountedStop, mInitialized, ParCompMark::Name::mName, mRenderingEngine, mRenderWindow, mSqVM, and ParCompMark::Pointer< T, Lock >::unlock().

Here is the call graph for this function:

void ParCompMark::Process::threadInitialize (  )  [virtual]

Some init step as thread.

Reimplemented from ParCompMark::Thread.

Definition at line 202 of file PCMProcess.cpp.

References actualizeRenderWindow(), Assert, COMPOSITE, ParCompMark::Logger::DEBUG, ParCompMark::GLXRenderWindow::DEFAULTWINDOWHEIGHT, ParCompMark::GLXRenderWindow::DEFAULTWINDOWWIDTH, ParCompMark::Singleton< T >::getInstance(), ParCompMark::Application::getInstance(), ParCompMark::FileSystemManager::getInstance(), ParCompMark::Pointer< T, Lock >::getPtr(), initPC(), initProcess(), ParCompMark::OpenGLExtensionLoader::loadDelayed(), ParCompMark::Pointer< T, Lock >::lock(), mCountedStop, mInitialized, ParCompMark::Name::mName, mProcessType, mRenderingEngine, mRenderWindow, mShowFrameletIcon, mSqVM, mStopAble, mStopID, ParCompMark::Thread::mThreadName, ParCompMark::SqVM::NOMAINMETHOD, openRenderWindow(), ParCompMark::Application::PARCOMPMARKNUT, ParCompMark::Application::PCAPINUT, PROCESSINITNUT, ParCompMark::StringConverter::toString(), ParCompMark::Pointer< T, Lock >::unlock(), and ParCompMark::Application::UTILSNUT.

Here is the call graph for this function:

Member Data Documentation

const std::string ParCompMark::Process::DEFAULTEXPORTPATTERN = "%06d.png" [static]

Default filename pattern for exporting frames.

Remarks:
This is own attribute of this class.

Definition at line 202 of file PCMProcess.h.

Referenced by Process(), and ~Process().

Buffer::Pointer ParCompMark::Process::mBuffer [protected]

Graphics memory buffer on which the process operates.

The buffer belongs the to parent node.

Remarks:
This is own attribute of this class.

Definition at line 276 of file PCMProcess.h.

Referenced by actualizeRenderWindow(), displayFrameletIcon(), initPC(), runningProcess(), setBufferByName(), setViewportForRendering(), and task().

ContextList ParCompMark::Process::mContexts [protected]

List of contexts.

Remarks:
This is own attribute of this class.

Definition at line 220 of file PCMProcess.h.

Referenced by addContext(), displayFrameletIcon(), gatherStatistics(), initPC(), setViewportForRendering(), stop(), task(), and threadFinalize().

bool ParCompMark::Process::mCountedStop [protected]

Indicates that process can call application that the compositing is ended.

Remarks:
This is own attribute of this class.

Definition at line 364 of file PCMProcess.h.

Referenced by Process(), threadFinalize(), and threadInitialize().

bool ParCompMark::Process::mDisplayOutput [protected]

Flag indicates that the output of the compositing process is rendered on the screen.

This flag is dontcare on rendering processes.

Remarks:
This is own attribute of this class.

Definition at line 315 of file PCMProcess.h.

Referenced by Process(), and runningProcess().

int ParCompMark::Process::mExportFrameStep [protected]

The process will export any (mExportFrameStep)th frame in mFrameFilenamePattern format.

Zero value disables frame exporing.

Remarks:
This is own attribute of this class.

Definition at line 385 of file PCMProcess.h.

Referenced by Process(), and task().

char* ParCompMark::Process::mFrameFilenamePattern [protected]

Filename pattern for exporting frames (C string for squirrel compatibility).

The filename pattern can contain special formatting characters to include the frame number. For details see the man page of the

Remarks:
This is own attribute of this class.

Definition at line 393 of file PCMProcess.h.

Referenced by Process(), task(), and ~Process().

u32 ParCompMark::Process::mFrameNumber [protected]

Number of current frame.

Remarks:
This is own attribute of this class.

Definition at line 329 of file PCMProcess.h.

Referenced by Process(), runningProcess(), and task().

Real ParCompMark::Process::mFrameTime [protected]

Time elapsed between the start of the benchmark and the start of the current frame.

Remarks:
This is own attribute of this class.

Definition at line 336 of file PCMProcess.h.

Referenced by Process(), and runningProcess().

bool ParCompMark::Process::mGatherStatistics [protected]

This flag indicates that the process has to gather rendering statistics.

Remarks:
This is own attribute of this class.

Definition at line 322 of file PCMProcess.h.

Referenced by Process(), and task().

bool ParCompMark::Process::mInitialized [protected]

The process is initialized.

Remarks:
This is own attribute of this class.

Definition at line 283 of file PCMProcess.h.

Referenced by Process(), threadFinalize(), and threadInitialize().

char* ParCompMark::Process::mInitProcCode [protected]

Squirrel initialization code (C string for squirrel compatibility).

Remarks:
This is own attribute of this class.

Definition at line 262 of file PCMProcess.h.

Referenced by initProcess(), Process(), and ~Process().

bool ParCompMark::Process::mOperate [protected]

Flag indicates that the process operates, ie.

renders the framelet or composites the specified output. This flag is useful for dynamic rendering defined by Squirrel task script or plugins.

Remarks:
This is own attribute of this class.

Definition at line 306 of file PCMProcess.h.

Referenced by Process(), and task().

OutputNode::Pointer ParCompMark::Process::mOutputDocument [protected]

Process output document.

Remarks:
This is own attribute of this class.

Definition at line 371 of file PCMProcess.h.

Referenced by gatherStatistics(), and Process().

Node* ParCompMark::Process::mParent [protected]

Parent node of the process.

(Parent reference is standard pointer to avoid circular reference)

Remarks:
This attribute references an attribute.

Definition at line 234 of file PCMProcess.h.

Referenced by setBufferByName().

ProcessType ParCompMark::Process::mProcessType [protected]

Composite or render process.

Remarks:
This is own attribute of this class.

Definition at line 227 of file PCMProcess.h.

Referenced by initPC(), Process(), runningProcess(), task(), and threadInitialize().

OpenGLRenderingEngine::Pointer ParCompMark::Process::mRenderingEngine [protected]

Rendering engine of this process.

Remarks:
This is own attribute of this class.

Definition at line 248 of file PCMProcess.h.

Referenced by actualizeRenderWindow(), displayFrameletIcon(), refreshSortOrder(), runningProcess(), setViewportForRendering(), threadFinalize(), and threadInitialize().

GLXRenderWindow::Pointer ParCompMark::Process::mRenderWindow [protected]

Renderwindow of this process.

Each process can have zero or one renderwindow.

Remarks:
This is own attribute of this class.

Definition at line 241 of file PCMProcess.h.

Referenced by actualizeRenderWindow(), displayFrameletIcon(), gatherStatistics(), initProcess(), openRenderWindow(), runningProcess(), task(), threadFinalize(), and threadInitialize().

char* ParCompMark::Process::mRunningProcCode [protected]

Squirrel running code (C string for squirrel compatibility).

Remarks:
This is own attribute of this class.

Definition at line 269 of file PCMProcess.h.

Referenced by Process(), runningProcess(), and ~Process().

bool ParCompMark::Process::mShowFrameletIcon [protected]

Show little framelet icon on rendering windows.

Remarks:
This is own attribute of this class.

Definition at line 378 of file PCMProcess.h.

Referenced by Process(), task(), and threadInitialize().

PCuint ParCompMark::Process::mSortOrder [protected]

Value for alpha sorting.

Remarks:
This is own attribute of this class.

Definition at line 290 of file PCMProcess.h.

Referenced by initPC(), refreshSortOrder(), and task().

SqVM::Pointer ParCompMark::Process::mSqVM [protected]

Squirrel virtual machine.

Remarks:
This is own attribute of this class.

Definition at line 255 of file PCMProcess.h.

Referenced by initProcess(), runningProcess(), threadFinalize(), and threadInitialize().

Real ParCompMark::Process::mStartTime [protected]

Local (uncorrected) time at the start of the benchmark for this process.

Remarks:
This is own attribute of this class.

Definition at line 343 of file PCMProcess.h.

Referenced by Process(), and runningProcess().

bool ParCompMark::Process::mStop [protected]

Indicates that process must be stopped.

Remarks:
This is own attribute of this class.

Definition at line 350 of file PCMProcess.h.

Referenced by Process(), setFinito(), stop(), and task().

bool ParCompMark::Process::mStopAble [protected]

Indicates that process can be stopped during compositing.

Remarks:
This is own attribute of this class.

Definition at line 357 of file PCMProcess.h.

Referenced by Process(), stop(), task(), and threadInitialize().

PCid ParCompMark::Process::mStopID [protected]

Stop id where composite is ended.

Remarks:
This is own attribute of this class.

Definition at line 297 of file PCMProcess.h.

Referenced by Process(), setFinito(), task(), and threadInitialize().

const std::string ParCompMark::Process::PROCESSINITNUT = "scripts/framework/process-init.nut" [static]

Process initializer Squirrel script file (relative to the data directory).

Remarks:
This is own attribute of this class.

Definition at line 195 of file PCMProcess.h.

Referenced by threadInitialize().

The documentation for this class was generated from the following files: