seq::ViewData Class Reference

Stores per-view data. More...

#include <viewData.h>

Inheritance diagram for seq::ViewData:

Collaboration diagram for seq::ViewData:

Public Member Functions
SEQ_API	ViewData (View &view)
	Construct a new view data. More...
virtual SEQ_API	~ViewData ()
	Destruct this view data. More...
bool	useOrtho () const
Operations
virtual SEQ_API bool	handleEvent (eq::EventType type, const SizeEvent &)
	Handle the given event command. More...
virtual SEQ_API bool	handleEvent (eq::EventType type, const PointerEvent &)
virtual SEQ_API bool	handleEvent (eq::EventType type, const KeyEvent &)
virtual SEQ_API bool	handleEvent (const AxisEvent &)
virtual SEQ_API bool	handleEvent (const ButtonEvent &)
SEQ_API void	spinModel (const float x, const float y, const float z)
	Rotate the model matrix by the given increments. More...
SEQ_API void	moveModel (const float x, const float y, const float z)
	Move the model matrix by the given increments. More...
SEQ_API void	showStatistics (const bool on)
	Enable or disable statistics rendering. More...
SEQ_API void	setOrtho (const bool on)
	Enable or disable orthographic rendering. More...
virtual SEQ_API bool	update ()
	Update the view data. More...
Data Access.
SEQ_API void	setModelMatrix (const Matrix4f &matrix)
	Set the current model matrix (global camera). More...
const Matrix4f &	getModelMatrix () const
bool	getStatistics () const

Protected Types
enum	DirtyBits { DIRTY_MODELMATRIX = co::Serializable::DIRTY_CUSTOM << 0, DIRTY_STATISTICS = co::Serializable::DIRTY_CUSTOM << 1, DIRTY_ORTHO = co::Serializable::DIRTY_CUSTOM << 2, DIRTY_CUSTOM = co::Serializable::DIRTY_CUSTOM << 3 }
	The changed parts of the object since the last serialize(). More...

Protected Member Functions
SEQ_API void	serialize (co::DataOStream &os, const uint64_t dirtyBits) override
SEQ_API void	deserialize (co::DataIStream &is, const uint64_t dirtyBits) override

Detailed Description

Stores per-view data.

Definition at line 30 of file viewData.h.

Member Enumeration Documentation

enum seq::ViewData::DirtyBits

protected

The changed parts of the object since the last serialize().

Definition at line 118 of file viewData.h.

Constructor & Destructor Documentation

SEQ_API seq::ViewData::ViewData ( View &  view )

explicit

Construct a new view data.

Version

1.0

virtual SEQ_API seq::ViewData::~ViewData ( )

virtual

Destruct this view data.

Version

1.0

Member Function Documentation

const Matrix4f& seq::ViewData::getModelMatrix ( ) const

inline

Returns

the current model matrix (global camera).

Version

1.0

Definition at line 102 of file viewData.h.

bool seq::ViewData::getStatistics ( ) const

inline

Returns

true is statistics are rendered.

Version

1.0

Definition at line 104 of file viewData.h.

virtual SEQ_API bool seq::ViewData::handleEvent ( eq::EventType  type, const SizeEvent &    )

virtual

Handle the given event command.

The default implementation provides a pointer-based camera model and some key event handling, all of which can be modified by overwriting this method and handling the appropriate events.

Version

1.5.1

SEQ_API void seq::ViewData::moveModel	(	const float	x,
		const float	y,
		const float	z
	)

Move the model matrix by the given increments.

Version

1.0

SEQ_API void seq::ViewData::setModelMatrix

(

const Matrix4f &

matrix

)

Set the current model matrix (global camera).

Version

1.11

SEQ_API void seq::ViewData::setOrtho

(

const bool

on

)

Enable or disable orthographic rendering.

The default event handler of this view toggles the orthographic rendering state when 'o' is pressed.

Parameters

on	the state of the orthographic rendering.

Version

1.2

SEQ_API void seq::ViewData::showStatistics

(

const bool

on

)

Enable or disable statistics rendering.

The statistics are rendered in the views where they are enabled. The default event handler of this view toggles the statistics rendering state when 's' is pressed.

Parameters

on	the state of the statistics rendering.

Version

1.0

SEQ_API void seq::ViewData::spinModel	(	const float	x,
		const float	y,
		const float	z
	)

Rotate the model matrix by the given increments.

Version

1.0

virtual SEQ_API bool seq::ViewData::update ( )

virtual

Update the view data.

Called once at the end of each frame to trigger animations. The default implementation updates the camera data.

Returns

true to request a redraw.

Version

1.0

bool seq::ViewData::useOrtho ( ) const

inline

Returns

true when orthographic rendering is enabled.

Version

1.2

Definition at line 108 of file viewData.h.

---

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

• viewData.h