A canvas represents a logical 2D projection surface. More...

#include <canvas.h>

Inheritance diagram for eq::fabric::Canvas< CFG, C, S, L >:

Collaboration diagram for eq::fabric::Canvas< CFG, C, S, L >:

Classes
struct	BackupData
Public Member Functions
Data Access
CFG *	getConfig ()
const CFG *	getConfig () const
uint32_t	getActiveLayoutIndex () const
EQFABRIC_INL const L *	getActiveLayout () const
const Segments &	getSegments () const
S *	findSegment (const std::string &name)
	Find the first segment of a given name.
const Layouts &	getLayouts () const
EQFABRIC_INL void	addLayout (L *layout)
EQFABRIC_INL bool	removeLayout (L *layout)
virtual EQFABRIC_INL void	setWall (const Wall &wall)
virtual EQFABRIC_INL void	setProjection (const Projection &)
virtual EQFABRIC_INL void	unsetFrustum ()
Operations
virtual EQFABRIC_INL void	useLayout (const uint32_t index)
	Activate the given layout on this canvas.
EQFABRIC_INL VisitorResult	accept (Visitor &visitor)
	Traverse this canvas and all children using a canvas visitor.
EQFABRIC_INL VisitorResult	accept (Visitor &visitor) const
	Const-version of accept().
virtual EQFABRIC_INL void	backup ()
virtual EQFABRIC_INL void	restore ()
void	create (S **segment)
void	release (S *segment)
Public Types
typedef std::vector< S * >	Segments
	A vector of segments.
typedef std::vector< L * >	Layouts
	A vector of layouts.
typedef ElementVisitor< C, LeafVisitor< S > >	Visitor
	A Canvas visitor.
Protected Member Functions
EQFABRIC_INL	Canvas (CFG *config)
	Construct a new Canvas.
virtual EQFABRIC_INL	~Canvas ()
	Destruct this canvas.
virtual EQFABRIC_INL void	attach (const co::base::UUID &id, const uint32_t instanceID)
EQFABRIC_INL void	serialize (co::DataOStream &os, const uint64_t dirtyBits)
virtual EQFABRIC_INL void	deserialize (co::DataIStream &is, const uint64_t dirtyBits)
virtual EQFABRIC_INL void	notifyDetach ()
	Notify that this object will be deregistered or unmapped.
virtual EQFABRIC_INL void	setDirty (const uint64_t bits)
virtual void	activateLayout (const uint32_t index)
Friends
class	Segment
class	Object

Detailed Description

template<class CFG, class C, class S, class L>
class eq::fabric::Canvas< CFG, C, S, L >

A canvas represents a logical 2D projection surface.

Definition at line 36 of file fabric/canvas.h.

Member Function Documentation

template<class CFG, class C, class S, class L>

EQFABRIC_INL VisitorResult eq::fabric::Canvas< CFG, C, S, L >::accept ( Visitor & visitor )

Traverse this canvas and all children using a canvas visitor.

Parameters:

visitor the visitor.

Returns:: the result of the visitor traversal.

Version:: 1.0

template<class CFG, class C, class S, class L>

EQFABRIC_INL VisitorResult eq::fabric::Canvas< CFG, C, S, L >::accept ( Visitor & visitor ) const

Const-version of accept().

Version:: 1.0

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::deserialize	(	co::DataIStream &	is,
		const uint64_t	dirtyBits
	)		`[protected, virtual]`

See also:: Frustum::deserialize.

Reimplemented from eq::fabric::Object.

template<class CFG, class C, class S, class L>

EQFABRIC_INL const L* eq::fabric::Canvas< CFG, C, S, L >::getActiveLayout ( ) const

Returns:: the active layout.

Version:: 1.0

Referenced by eVolve::Config::handleEvent(), and eqPly::Config::handleEvent().

Here is the caller graph for this function:

template<class CFG, class C, class S, class L>

uint32_t eq::fabric::Canvas< CFG, C, S, L >::getActiveLayoutIndex ( ) const [inline]

Returns:: the index of the active layout.

Version:: 1.0

Definition at line 52 of file fabric/canvas.h.

template<class CFG, class C, class S, class L>

const CFG* eq::fabric::Canvas< CFG, C, S, L >::getConfig ( ) const [inline]

Returns:: the parent config.

Version:: 1.0

Definition at line 49 of file fabric/canvas.h.

template<class CFG, class C, class S, class L>

CFG* eq::fabric::Canvas< CFG, C, S, L >::getConfig ( ) [inline]

Returns:: the parent config.

Version:: 1.0

Definition at line 47 of file fabric/canvas.h.

template<class CFG, class C, class S, class L>

const Layouts& eq::fabric::Canvas< CFG, C, S, L >::getLayouts ( ) const [inline]

Returns:: the vector of possible layouts.

Version:: 1.0

Definition at line 64 of file fabric/canvas.h.

template<class CFG, class C, class S, class L>

const Segments& eq::fabric::Canvas< CFG, C, S, L >::getSegments ( ) const [inline]

Returns:: the vector of child segments.

Version:: 1.0

Definition at line 58 of file fabric/canvas.h.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::notifyDetach ( ) [protected, virtual]

Notify that this object will be deregistered or unmapped.

The method is called from the thread initiating the deregistration or unmapping, before the operation is executed.

See also:: isMaster()

Reimplemented from eq::fabric::Object.

template<class CFG, class C, class S, class L>

EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::serialize	(	co::DataOStream &	os,
		const uint64_t	dirtyBits
	)		`[protected, virtual]`

See also:: Frustum::serialize.

Reimplemented from eq::fabric::Object.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::setDirty ( const uint64_t bits ) [protected, virtual]

See also:: Serializable::setDirty()

Reimplemented from eq::fabric::Serializable.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::setProjection ( const Projection & ) [virtual]

See also:: Frustum::setProjection()

Reimplemented from eq::fabric::Frustum.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::setWall ( const Wall & wall ) [virtual]

See also:: Frustum::setWall()

Reimplemented from eq::fabric::Frustum.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::unsetFrustum ( ) [virtual]

See also:: Frustum::unsetFrustum()

Reimplemented from eq::fabric::Frustum.

template<class CFG, class C, class S, class L>

virtual EQFABRIC_INL void eq::fabric::Canvas< CFG, C, S, L >::useLayout ( const uint32_t index ) [virtual]

Activate the given layout on this canvas.

Version:: 1.0

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

fabric/canvas.h

eq::fabric::Canvas< CFG, C, S, L > Class Template Reference

Classes

Public Member Functions

Public Types

Protected Member Functions

Friends

Detailed Description

template<class CFG, class C, class S, class L> class eq::fabric::Canvas< CFG, C, S, L >

Member Function Documentation

template<class CFG, class C, class S, class L>
class eq::fabric::Canvas< CFG, C, S, L >