eq::server::Canvas Class Reference

The canvas. More...

#include <canvas.h>

Inheritance diagram for eq::server::Canvas:

Inheritance graph
[legend]
Collaboration diagram for eq::server::Canvas:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Canvas ()
 Constructs a new Canvas.
 Canvas (const Canvas &from, Config *config)
 Creates a new, deep copy of a canvas.
virtual ~Canvas ()
 Destruct this canvas.
Data Access
ConfiggetConfig ()
const ConfiggetConfig () const
void addSegment (Segment *segment)
 Add a new segment to this canvas.
const SegmentVector & getSegments () const
SegmentfindSegment (const std::string &name)
 Find the first segment of a given name.
SegmentgetSegment (const SegmentPath &path)
void addLayout (Layout *layout)
 Add a new allowed layout to this canvas, can be 0.
const LayoutVector & getLayouts () const
 Get the vector of allowed layouts for this canvas.
CanvasPath getPath () const
Operations
void init ()
void exit ()
VisitorResult accept (CanvasVisitor &visitor)
 Traverse this canvas and all children using a canvas visitor.
VisitorResult accept (ConstCanvasVisitor &visitor) const
void unmap ()
 Unmap this canvas and all its children.

Protected Member Functions

virtual void serialize (net::DataOStream &os, const uint64_t dirtyBits)
virtual void deserialize (net::DataIStream &is, const uint64_t dirtyBits)

Friends

class Config


Detailed Description

The canvas.

See also:
eq::Canvas

Definition at line 41 of file server/canvas.h.


Constructor & Destructor Documentation

eq::server::Canvas::Canvas ( const Canvas from,
Config config 
)

Creates a new, deep copy of a canvas.

Definition at line 48 of file server/canvas.cpp.

References _layouts, _segments, eq::server::Config::addCanvas(), addLayout(), addSegment(), eq::server::Config::getLayout(), and eq::server::Layout::getPath().

Here is the call graph for this function:

eq::server::Canvas::~Canvas (  )  [virtual]

Destruct this canvas.

Definition at line 78 of file server/canvas.cpp.

References eq::server::Segment::_canvas, and eq::server::Config::removeCanvas().

Here is the call graph for this function:


Member Function Documentation

void eq::server::Canvas::addSegment ( Segment segment  ) 

const SegmentVector& eq::server::Canvas::getSegments (  )  const [inline]

Returns:
the vector of child segments.

Definition at line 66 of file server/canvas.h.

Referenced by eq::server::Config::addCanvas(), and eq::server::Segment::getPath().

Here is the caller graph for this function:

Segment * eq::server::Canvas::findSegment ( const std::string &  name  ) 

Find the first segment of a given name.

Parameters:
name the name of the segment to find
Returns:
the first segment with the name, or 0 if no segment with the name exists.

Definition at line 220 of file server/canvas.cpp.

References accept().

Here is the call graph for this function:

Segment * eq::server::Canvas::getSegment ( const SegmentPath &  path  ) 

Returns:
the segment of the given path.

Definition at line 154 of file server/canvas.cpp.

void eq::server::Canvas::addLayout ( Layout layout  ) 

Add a new allowed layout to this canvas, can be 0.

Definition at line 227 of file server/canvas.cpp.

Referenced by Canvas().

Here is the caller graph for this function:

const LayoutVector& eq::server::Canvas::getLayouts (  )  const [inline]

Get the vector of allowed layouts for this canvas.

Definition at line 84 of file server/canvas.h.

Referenced by eq::server::Config::addCanvas().

Here is the caller graph for this function:

CanvasPath eq::server::Canvas::getPath (  )  const

Returns:
the index path to this canvas.

Definition at line 165 of file server/canvas.cpp.

References eq::server::Config::getCanvases().

Referenced by eq::server::Segment::getPath().

Here is the call graph for this function:

Here is the caller graph for this function:

VisitorResult eq::server::Canvas::accept ( CanvasVisitor visitor  ) 

Traverse this canvas and all children using a canvas visitor.

Parameters:
visitor the visitor.
Returns:
the result of the visitor traversal.

Definition at line 431 of file server/canvas.cpp.

Referenced by findSegment().

Here is the caller graph for this function:

void eq::server::Canvas::unmap (  ) 

Unmap this canvas and all its children.

Definition at line 441 of file server/canvas.cpp.

References eq::net::Object::getID(), eq::net::Object::getSession(), and eq::net::Session::unmapObject().

Here is the call graph for this function:

void eq::server::Canvas::serialize ( net::DataOStream os,
const uint64_t  dirtyBits 
) [protected, virtual]

See also:
Frustum::serialize

Reimplemented from eq::Frustum.

Definition at line 108 of file server/canvas.cpp.

References eq::net::Object::getID().

Here is the call graph for this function:

void eq::server::Canvas::deserialize ( net::DataIStream is,
const uint64_t  dirtyBits 
) [protected, virtual]

See also:
Frustum::deserialize

Reimplemented from eq::Frustum.

Definition at line 142 of file server/canvas.cpp.


The documentation for this class was generated from the following files:
Generated on Mon Aug 10 18:58:45 2009 for Equalizer 0.9 by  doxygen 1.5.8