eq::Layout Class Reference
A layout groups one or more View which logically belong together. More...
#include <layout.h>
Public Member Functions | |
| Layout () | |
| Construct a new layout. | |
| virtual | ~Layout () |
| Destruct this layout. | |
Data Access | |
| const ViewVector & | getViews () const |
| Get the list of views. | |
| Config * | getConfig () |
| const Config * | getConfig () const |
Operations | |
| VisitorResult | accept (LayoutVisitor &visitor) |
| Traverse this layout and all children using a layout visitor. | |
| VisitorResult | accept (LayoutVisitor &visitor) const |
| Const-version of accept(). | |
Protected Types | |
| enum | DirtyBits { DIRTY_VIEWS = Object::DIRTY_CUSTOM << 0, DIRTY_FILL1 = Object::DIRTY_CUSTOM << 1, DIRTY_FILL2 = Object::DIRTY_CUSTOM << 2, DIRTY_CUSTOM = Object::DIRTY_CUSTOM << 3 } |
The changed parts of the object since the last pack(). More... | |
Protected Member Functions | |
| virtual void | deserialize (net::DataIStream &is, const uint64_t dirtyBits) |
Friends | |
| class | server::Layout |
| class | Config |
Detailed Description
A layout groups one or more View which logically belong together.
A layout belongs to Canvases. The layout assignment can be changed at run-time by the application, out of a pre-defined set of layouts for each Canvas.
The intersection between views and segments defines which output (sub-)channels are available. Neither the views nor the segments have to cover the full layout or canvas, respectively. These channels are typically used as a destination Channel in a compound. They are automatically created when the configuration is loaded.
Definition at line 49 of file lib/client/layout.h.
Member Enumeration Documentation
enum eq::Layout::DirtyBits [protected] |
The changed parts of the object since the last pack().
Subclasses should define their own bits, starting at DIRTY_CUSTOM.
Reimplemented from eq::Object.
Definition at line 91 of file lib/client/layout.h.
Constructor & Destructor Documentation
| eq::Layout::Layout | ( | ) |
Construct a new layout.
Definition at line 34 of file lib/client/layout.cpp.
| eq::Layout::~Layout | ( | ) | [virtual] |
Destruct this layout.
Definition at line 39 of file lib/client/layout.cpp.
Member Function Documentation
| const ViewVector& eq::Layout::getViews | ( | ) | const [inline] |
Get the list of views.
Definition at line 61 of file lib/client/layout.h.
| Config* eq::Layout::getConfig | ( | ) | [inline] |
- Returns:
- the current Config.
Definition at line 64 of file lib/client/layout.h.
Referenced by eq::View::getConfig().
| const Config* eq::Layout::getConfig | ( | ) | const [inline] |
- Returns:
- the current Config.
Definition at line 67 of file lib/client/layout.h.
| VisitorResult eq::Layout::accept | ( | LayoutVisitor & | visitor | ) |
Traverse this layout and all children using a layout visitor.
- Parameters:
-
visitor the visitor.
- Returns:
- the result of the visitor traversal.
Definition at line 146 of file lib/client/layout.cpp.
| VisitorResult eq::Layout::accept | ( | LayoutVisitor & | visitor | ) | const |
Const-version of accept().
Definition at line 151 of file lib/client/layout.cpp.
| void eq::Layout::deserialize | ( | net::DataIStream & | is, | |
| const uint64_t | dirtyBits | |||
| ) | [protected, virtual] |
- See also:
- Object::deserialize
Reimplemented from eq::Object.
Definition at line 52 of file lib/client/layout.cpp.
References eq::net::Object::becomeMaster(), eq::NodeFactory::createView(), eq::Config::getLatency(), eq::Global::getNodeFactory(), eq::net::Session::mapObject(), and eq::net::Object::setAutoObsolete().
The documentation for this class was generated from the following files:
