eq::View Class Reference

A View is a 2D area of a Layout. More...

#include <view.h>

Inheritance diagram for eq::View:

Collaboration diagram for eq::View:

List of all members.

Public Member Functions
	View (Layout *parent)
	Construct a new view.
virtual	~View ()
	Destruct this view.
Data Access.
Config *	getConfig ()
const Config *	getConfig () const
ServerPtr	getServer ()
Operations
virtual bool	handleEvent (const Event &event)
	Handle a received (view) event.
Protected Member Functions
virtual void	deserialize (co::DataIStream &is, const uint64_t dirtyBits)
	Worker for unpack() and applyInstanceData().
const Frustum &	getBaseFrustum () const
virtual void	detach ()
Friends
class	Pipe

---

Detailed Description

A View is a 2D area of a Layout.

It is a view of the application's data on a model, in the sense used by the MVC pattern. It can be a scene, viewing mode, viewing position, or any other representation of the application's data.

Warning:

Never commit a View. Equalizer does take care of this to correctly associate view version with rendering frames.

See also:

fabric::View

Definition at line 42 of file include/eq/view.h.

---

Constructor & Destructor Documentation

eq::View::View

(

Layout *

parent

)

Construct a new view.

Version:

1.0

Reimplemented in eqPly::View.

virtual eq::View::~View

(

)

[virtual]

Destruct this view.

Version:

1.0

Reimplemented from eq::fabric::View< Layout, View, Observer >.

Reimplemented in eqPly::View.

---

Member Function Documentation

virtual void eq::View::deserialize	(	co::DataIStream &	,
		const uint64_t
	)		[protected, virtual]

Worker for unpack() and applyInstanceData().

This function is called with the dirty bits send by the master instance. The dirty bits are received beforehand, and do not need to be deserialized by the overriding method.

See also:

serialize()

Version:

1.0

Reimplemented from eq::fabric::View< Layout, View, Observer >.

const Frustum& eq::View::getBaseFrustum

(

)

const [inline, protected]

Returns:

the initial frustum value of this view.

Definition at line 85 of file include/eq/view.h.

const Config* eq::View::getConfig

(

)

const

Returns:

the config of this view.

Version:

1.0

Config* eq::View::getConfig

(

)

Returns:

the config of this view.

Version:

1.0

ServerPtr eq::View::getServer

(

)

Returns:

the Server of this view.

Version:

1.0

virtual bool eq::View::handleEvent

(

const Event &

event

)

[virtual]

Handle a received (view) event.

The task of this method is to update the view as necessary. It is called by Config::handleEvent on the application main thread for all view events.

Parameters:

event

the received view event.

Returns:

true when the event was handled, false if not.

Version:

1.0

---

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

• include/eq/view.h