seq::Application Class Reference

The main application object. More...

#include <application.h>

Inheritance diagram for seq::Application:

Collaboration diagram for seq::Application:

List of all members.

Public Member Functions
	Application ()
	Construct a new application instance.
virtual	~Application ()
	Destruct this application instance.
Data Access
co::NodePtr	getMasterNode ()
Operations
virtual bool	init (const int argc, char **argv, co::Object *initData)
	Initialize the application instance.
virtual bool	run (co::Object *frameData)
	Run the application main loop.
virtual bool	exit ()
	Exit this application instance.
void	stopRunning ()
	Request that the application leaves its run loop.
Callbacks
virtual bool	clientInit (co::Object *initData)
	Initialize a render client.
virtual bool	clientExit ()
	Exit a render client.
virtual Renderer *	createRenderer ()=0
	Create a new renderer instance.
virtual void	destroyRenderer (Renderer *renderer)
	Delete the given renderer.
virtual ViewData *	createViewData ()
	Create a new per-view data instance.
virtual void	destroyViewData (ViewData *viewData)
	Delete the given view data.
Internal
eq::Config *	getConfig ()
detail::Application *	getImpl ()

---

Detailed Description

The main application object.

Definition at line 28 of file include/seq/application.h.

---

Constructor & Destructor Documentation

seq::Application::Application

(

)

Construct a new application instance.

Version:

1.0

Reimplemented in seqPly::Application.

virtual seq::Application::~Application

(

)

[virtual]

Destruct this application instance.

Version:

1.0

Reimplemented in seqPly::Application, and eqHello::Application.

---

Member Function Documentation

virtual bool seq::Application::clientExit

(

)

[inline, virtual]

Exit a render client.

Version:

1.0

Definition at line 104 of file include/seq/application.h.

virtual bool seq::Application::clientInit

(

co::Object *

initData

)

[inline, virtual]

Initialize a render client.

Also called on the master application node if it contributes to the rendering.

Parameters:

initData

A slave instance of the object passed to init().

Returns:

true on success, false on error.

Version:

1.0

Definition at line 101 of file include/seq/application.h.

virtual Renderer* seq::Application::createRenderer

(

)

[pure virtual]

Create a new renderer instance.

Called once per rendering thread, potentially in parallel, during initialization.

Returns:

the new renderer

Version:

1.0

Implemented in seqPly::Application, and eqHello::Application.

virtual ViewData* seq::Application::createViewData

(

)

[virtual]

Create a new per-view data instance.

Called once for each view in the current configuration. Creates the view data objects used by the application to set parameters for the renderers.

Returns:

the new view data

Version:

1.0

virtual void seq::Application::destroyRenderer

(

Renderer *

renderer

)

[virtual]

Delete the given renderer.

Version:

1.0

virtual void seq::Application::destroyViewData

(

ViewData *

viewData

)

[virtual]

Delete the given view data.

Version:

1.0

virtual bool seq::Application::exit

(

)

[virtual]

Exit this application instance.

Returns:

true on success, false otherwise.

Version:

1.0

Reimplemented in seqPly::Application.

co::NodePtr seq::Application::getMasterNode

(

)

Returns:

the node running the main instance.

Version:

1.3.1

virtual bool seq::Application::init	(	const int	argc,
		char **	argv,
		co::Object *	initData
	)		[virtual]

Initialize the application instance.

The initData object is registered and is passed to all initialization callbacks on all processes. The object may be 0, if the application does not want to use an object during initialization.

Parameters:

argc	the command line argument count.
argv	the command line arguments.
initData	a distributable object for initialization data.

Returns:

true on success, false otherwise.

Version:

1.0

virtual bool seq::Application::run

(

co::Object *

frameData

)

[virtual]

Run the application main loop.

The frameData object is registered and is passed to all rendering callbacks on all processes. It is automatically committed at the beginning of each frame. The instance passed to the render callbacks is automatically synchronized to the version belonging to the frame rendered. The object may be 0, if the application does not want to use a per-frame object.

Returns:

true on success, false otherwise.

Parameters:

frameData

a distributed object holding frame-specific data.

Version:

1.0

void seq::Application::stopRunning

(

)

Request that the application leaves its run loop.

Version:

1.1.6

---

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

• include/seq/application.h