A View is a 2D area of a Layout. More...
#include <view.h>
Inheritance diagram for eq::View:
Collaboration diagram for eq::View:
Public Member Functions | |
| View (Layout *parent) | |
| Construct a new view. | |
| virtual | ~View () |
| Destruct this view. | |
Data Access. | |
| Pipe * | getPipe () |
| const Pipe * | getPipe () const |
| Config * | getConfig () |
| const Config * | getConfig () const |
| ServerPtr | getServer () |
Operations | |
| virtual bool | handleEvent (const Event &event) |
| Handle a received (view) event. | |
| void | freezeLoadBalancing (const bool onOff) |
Protected Member Functions | |
| virtual void | deserialize (co::DataIStream &is, const uint64_t dirtyBits) |
| Worker for unpack() and applyInstanceData(). | |
| const Frustum & | getBaseFrustum () const |
| virtual void | detach () |
Friends | |
| class | Pipe |
Detailed Description
A View is a 2D area of a Layout.
It is a view of the application's data on a model, in the sense used by the MVC pattern. It can be a scene, viewing mode, viewing position, or any other representation of the application's data.
- Warning:
- Never commit a View. Equalizer does take care of this to correctly associate view version with rendering frames.
- See also:
- fabric::View
Definition at line 40 of file include/eq/client/view.h.
Constructor & Destructor Documentation
| eq::View::View | ( | Layout * | parent | ) |
| virtual eq::View::~View | ( | ) | [virtual] |
Destruct this view.
- Version:
- 1.0
Reimplemented from eq::fabric::View< Layout, View, Observer >.
Reimplemented in eqPly::View.
Member Function Documentation
| virtual void eq::View::deserialize | ( | co::DataIStream & | , |
| const uint64_t | |||
| ) | [protected, virtual] |
Worker for unpack() and applyInstanceData().
This function is called with the dirty bits send by the master instance. The dirty bits are received beforehand, and do not need to be deserialized by the overriding method.
- See also:
- serialize()
- Version:
- 1.0
Reimplemented from eq::fabric::View< Layout, View, Observer >.
| void eq::View::freezeLoadBalancing | ( | const bool | onOff | ) |
- Warning:
- Experimental - may not be supported in the future
| const Frustum& eq::View::getBaseFrustum | ( | ) | const [inline, protected] |
- Returns:
- the initial frustum value of this view.
Definition at line 98 of file include/eq/client/view.h.
- Returns:
- the config of this view.
- Version:
- 1.0
| const Config* eq::View::getConfig | ( | ) | const |
- Returns:
- the config of this view.
- Version:
- 1.0
| Pipe* eq::View::getPipe | ( | ) | [inline] |
- Returns:
- the parent pipe of this view, 0 for non-render client views.
- Version:
- 1.1.2
Definition at line 55 of file include/eq/client/view.h.
| const Pipe* eq::View::getPipe | ( | ) | const [inline] |
- Returns:
- the parent pipe of this view, 0 for non-render client views.
- Version:
- 1.1.2
Definition at line 61 of file include/eq/client/view.h.
- Returns:
- the Server of this view.
- Version:
- 1.0
| virtual bool eq::View::handleEvent | ( | const Event & | event | ) | [virtual] |
Handle a received (view) event.
The task of this method is to update the view as necessary. It is called by Config::handleEvent on the application main thread for all view events.
- Parameters:
-
event the received view event.
- Returns:
- true when the event was handled, false if not.
- Version:
- 1.0
The documentation for this class was generated from the following file:
