eq::server::Segment Class Reference

The segment. More...

#include <segment.h>

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

List of all members.

Public Member Functions

 Segment ()
 Constructs a new Segment.
 Segment (const Segment &from, Config *config)
 Creates a new, deep copy of a segment.
virtual ~Segment ()
 Destruct this segment.
Data Access



ConfiggetConfig ()
const ConfiggetConfig () const
SegmentPath getPath () const
void setChannel (Channel *channel)
 Set the channel of this segment.
ChannelgetChannel ()
 Return the output channel of this segment.
const ChannelgetChannel () const
CanvasgetCanvas ()
 Return the parent canvas of this segment.
const CanvasgetCanvas () const
void setViewport (const eq::Viewport &vp)
 Set the segment's viewport wrt its canvas.
const eq::ViewportgetViewport () const
void addDestinationChannel (Channel *channel)
 Add a destination (View) channel.
bool removeDestinationChannel (Channel *channel)
 Remove a destination (View) channel.
const ChannelVector & getDestinationChannels () const



VisitorResult accept (SegmentVisitor &visitor)
 Operations.
VisitorResult accept (SegmentVisitor &visitor) const

Friends

class Canvas

Detailed Description

The segment.

See also:
eq::Segment

Definition at line 37 of file server/segment.h.


Constructor & Destructor Documentation

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

Creates a new, deep copy of a segment.

Definition at line 42 of file server/segment.cpp.

References EQINFO, eq::server::View::getPath(), eq::server::Channel::getPath(), and eq::server::Channel::getView().

Here is the call graph for this function:

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

Destruct this segment.

Reimplemented from eq::Segment.

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

References EQINFO, and eq::server::Channel::unsetOutput().

Here is the call graph for this function:


Member Function Documentation

Config * eq::server::Segment::getConfig (  ) 
Returns:
the config of this view.

Reimplemented from eq::Segment.

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

const Config * eq::server::Segment::getConfig (  )  const
Returns:
the config of this view.

Reimplemented from eq::Segment.

Definition at line 115 of file server/segment.cpp.

SegmentPath eq::server::Segment::getPath (  )  const
Returns:
the index path to this segment.

Definition at line 153 of file server/segment.cpp.

References eq::server::Canvas::getPath(), and eq::server::Canvas::getSegments().

Here is the call graph for this function:

void eq::server::Segment::setChannel ( Channel channel  )  [inline]

Set the channel of this segment.

The channel defines the output area for this segment, typically a rendering area covering a graphics card output.

Parameters:
channel the channel.

Definition at line 72 of file server/segment.h.

Channel* eq::server::Segment::getChannel (  )  [inline]

Return the output channel of this segment.

Definition at line 75 of file server/segment.h.

Referenced by eq::server::Config::addCanvas(), and eq::server::Compound::updateFrustum().

Here is the caller graph for this function:

Canvas* eq::server::Segment::getCanvas (  )  [inline]

Return the parent canvas of this segment.

Definition at line 79 of file server/segment.h.

void eq::server::Segment::setViewport ( const eq::Viewport vp  ) 

Set the segment's viewport wrt its canvas.

The viewport defines which 2D area of the canvas is covered by this segment. Destination channels are created on the intersection of segment viewports and the views of the layout used by the canvas.

Parameters:
vp the fractional viewport.

Definition at line 121 of file server/segment.cpp.

References eq::Object::setDirty().

Here is the call graph for this function:

const eq::Viewport& eq::server::Segment::getViewport (  )  const [inline]
Returns:
the segment's viewport.

Reimplemented from eq::Segment.

Definition at line 94 of file server/segment.h.

Referenced by eq::server::Config::addCanvas(), eq::server::Canvas::addSegment(), and eq::server::Compound::updateFrustum().

Here is the caller graph for this function:

void eq::server::Segment::addDestinationChannel ( Channel channel  ) 

Add a destination (View) channel.

Definition at line 127 of file server/segment.cpp.

Referenced by eq::server::Channel::setOutput().

Here is the caller graph for this function:

bool eq::server::Segment::removeDestinationChannel ( Channel channel  ) 

Remove a destination (View) channel.

Definition at line 136 of file server/segment.cpp.

Referenced by eq::server::Channel::unsetOutput().

Here is the caller graph for this function:

const ChannelVector& eq::server::Segment::getDestinationChannels (  )  const [inline]
Returns:
the vector of channels resulting from the segment/view intersection.

Definition at line 104 of file server/segment.h.

VisitorResult eq::server::Segment::accept ( SegmentVisitor visitor  )  [inline]

Operations.

Traverse this segment using a segment visitor.

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

Definition at line 116 of file server/segment.h.

References eq::server::SegmentVisitor::visit().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Generated on Sat Feb 6 13:14:33 2010 for Equalizer 0.9.1 by  doxygen 1.6.1