A segment covers a sub-area of a Canvas. More...

#include <segment.h>

Inheritance diagram for eq::Segment:

Collaboration diagram for eq::Segment:

Public Member Functions
EQ_API	Segment (Canvas *parent)
	Construct a new segment. More...

virtual EQ_API	~Segment ()
	Destruct a segment. More...

Data Access
EQ_API Config *	getConfig ()

EQ_API const Config *	getConfig () const

EQ_API ServerPtr	getServer ()

Public Member Functions inherited from eq::fabric::Segment< Canvas, Segment, Channel >
const Canvas *	getCanvas () const

Canvas *	getCanvas ()

const Viewport &	getViewport () const

EQFABRIC_INL void	setViewport (const Viewport &vp)

void	setChannel (Channel *channel)

Channel *	getChannel ()
	Return the output channel of this segment. More...

const Channel *	getChannel () const
	Return the output channel of this segment. More...

virtual EQFABRIC_INL void	setWall (const Wall &wall)

virtual EQFABRIC_INL void	setProjection (const Projection &)

virtual EQFABRIC_INL void	unsetFrustum ()

uint32_t	getEyes () const

EQFABRIC_INL void	setEyes (const uint32_t eyes)

void	enableEye (const uint32_t eyes)

EQFABRIC_INL void	setSwapBarrier (SwapBarrierPtr barrier)

SwapBarrierConstPtr	getSwapBarrier () const

SwapBarrierPtr	getSwapBarrier ()

EQFABRIC_INL VisitorResult	accept (Visitor &visitor)
	Traverse this segment using a segment visitor. More...

EQFABRIC_INL VisitorResult	accept (Visitor &visitor) const
	Const-version of accept(). More...

void	inheritFrustum ()

virtual void	backup ()

virtual void	restore ()

virtual uint128_t	commit (const uint32_t incarnation=CO_COMMIT_NEXT)

Public Member Functions inherited from eq::fabric::Object
virtual EQFABRIC_API bool	isDirty () const

virtual EQFABRIC_API void	setName (const std::string &name)
	Set the name of the object. More...

EQFABRIC_API const std::string &	getName () const

EQFABRIC_API void	setUserData (co::Object *userData)
	Set user-specific data. More...

EQFABRIC_API co::Object *	getUserData ()

EQFABRIC_API const co::Object *	getUserData () const

EQFABRIC_API uint32_t	getTasks () const
	Return the set of tasks this channel might execute in the worst case. More...

EQFABRIC_API uint32_t	getSerial () const

Public Member Functions inherited from eq::fabric::Frustum
EQFABRIC_API	Frustum ()
	Construct a new frustum. More...

virtual EQFABRIC_API	~Frustum ()
	Destruct the frustum. More...

EQFABRIC_API void	setWall (const Wall &wall)
	Set the frustum using a wall description. More...

EQFABRIC_API void	setProjection (const Projection &projection)
	Set the frustum using a projection description. More...

const Wall &	getWall () const

const Projection &	getProjection () const

Type	getCurrentType () const

EQFABRIC_API void	unsetFrustum ()
	Set the last specified frustum to TYPE_NONE. More...

EQFABRIC_API void	serialize (co::DataOStream &os)

EQFABRIC_API void	deserialize (co::DataIStream &is)

Additional Inherited Members
Public Types inherited from eq::fabric::Segment< Canvas, Segment, Channel >
typedef LeafVisitor< Segment >	Visitor
	The segment visitor type. More...

Public Types inherited from eq::fabric::Object
enum	DirtyBits { DIRTY_NAME = Serializable::DIRTY_CUSTOM << 0, DIRTY_USERDATA = Serializable::DIRTY_CUSTOM << 1, DIRTY_TASKS = Serializable::DIRTY_CUSTOM << 2, DIRTY_REMOVED = Serializable::DIRTY_CUSTOM << 3, DIRTY_SERIAL = Serializable::DIRTY_CUSTOM << 4, DIRTY_CUSTOM = Serializable::DIRTY_CUSTOM << 6, DIRTY_OBJECT_BITS = DIRTY_NAME \| DIRTY_USERDATA }
	The changed parts of the object since the last pack(). More...

Public Types inherited from eq::fabric::Frustum
enum	Type { TYPE_NONE, TYPE_WALL, TYPE_PROJECTION }
	The type of the last specified frustum. More...

Protected Types inherited from eq::fabric::Segment< Canvas, Segment, Channel >
enum	DirtyBits

Protected Member Functions inherited from eq::fabric::Segment< Canvas, Segment, Channel >
EQFABRIC_INL	Segment (Canvas *canvas)

virtual EQFABRIC_INL void	serialize (co::DataOStream &os, const uint64_t dirtyBits)

virtual EQFABRIC_INL void	deserialize (co::DataIStream &is, const uint64_t dirtyBits)

virtual void	setDirty (const uint64_t bits)

virtual uint64_t	getRedistributableBits () const

virtual void	notifyFrustumChanged ()

Protected Member Functions inherited from eq::fabric::Object
EQFABRIC_API	Object ()
	Construct a new Object. More...

EQFABRIC_API	Object (const Object &)
	Construct an unmapped, unregistered copy of an object. More...

virtual EQFABRIC_API	~Object ()
	Destruct the object. More...

EQFABRIC_API Object &	operator= (const Object &from)
	NOP assignment operator. More...

virtual bool	hasMasterUserData ()

virtual uint32_t	getUserDataLatency () const

EQFABRIC_API void	setTasks (const uint32_t tasks)

virtual EQFABRIC_API void	notifyDetach ()

EQFABRIC_API void	postRemove (Object *child)

virtual void	removeChild (const uint128_t &)

template<class C , class S >
void	commitChild (C child, S sender, uint32_t cmd, const uint32_t incarnation)

template<class C >
void	commitChild (C *child, const uint32_t incarnation)

template<class C , class S >
void	commitChildren (const std::vector< C * > &children, S *sender, uint32_t cmd, const uint32_t incarnation)

template<class C >
void	commitChildren (const std::vector< C * > &children, uint32_t cmd, const uint32_t incarnation)

template<class C >
void	commitChildren (const std::vector< C * > &children, const uint32_t incarnation)

template<class C >
void	syncChildren (const std::vector< C * > &children)

template<class P , class C >
void	releaseChildren (const std::vector< C * > &children)

EQFABRIC_API bool	_cmdSync (co::ICommand &command)

Protected Member Functions inherited from eq::fabric::Frustum
virtual void	updateFrustum ()

Detailed Description

A segment covers a sub-area of a Canvas.

It has a Frustum, and defines one output Channel of the whole projection area, typically a projector or screen.

See Also: fabric::Segment

Definition at line 35 of file client/segment.h.

Constructor & Destructor Documentation

EQ_API eq::Segment::Segment ( Canvas * parent )

Construct a new segment.

Version: 1.0

virtual EQ_API eq::Segment::~Segment ( )

virtual

Destruct a segment.

Version: 1.0

Reimplemented from eq::fabric::Segment< Canvas, Segment, Channel >.

Member Function Documentation

EQ_API Config* eq::Segment::getConfig ( )

Returns: the config of this segment.

Version: 1.0

EQ_API const Config* eq::Segment::getConfig ( ) const

Returns: the config of this segment.

Version: 1.0

EQ_API ServerPtr eq::Segment::getServer ( )

Returns: the Server of this segment.

Version: 1.0

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

client/segment.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation