CameraInteractionEvent Class Reference

Event raised during camera interaction. More...

#include <Rendering/SceneComponents/Cameras/cameraevents.h>

Inheritance diagram for CameraInteractionEvent:

Public Member Functions
	CameraInteractionEvent (const Mesh::TransformMatrix &matrix, const Mesh::Vector3d &orbitDelta=Mesh::Vector3d(0, 0, 0), bool combineWithExistingMatrix=true)
bool	getCombineWithExistingMatrix () const
const Mesh::TransformMatrix &	getMatrix () const
const Mesh::Vector3d &	getOrbitDelta () const
Public Member Functions inherited from ObservableEventType< CameraInteractionEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > &	eventID ()
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > &	eventID ()
const EventIDSingleton< CameraInteractionEvent > &	getEventID () const override
Public Member Functions inherited from ObservableEvent
virtual	~ObservableEvent ()=default
virtual const EventID &	getEventID () const =0

Additional Inherited Members
Static Public Member Functions inherited from ObservableEventType< CameraInteractionEvent >
static const EventIDSingleton< CameraInteractionEvent > &	eventID ()
Protected Member Functions inherited from ObservableEventType< CameraInteractionEvent >
	ObservableEventType ()=default

Detailed Description

Instances of this class are created by the CameraInteraction class to indicate a transform to be applied from a camera's point of view. Normally, this transform will be applied to the camera's own transform, but it may be desirable to apply it to a root or parent transform instead so that other objects can move with the camera too (such as lights).

Constructor & Destructor Documentation

CameraInteractionEvent()

CameraInteractionEvent ( const Mesh::TransformMatrix &  matrix, const Mesh::Vector3d &  orbitDelta = Mesh::Vector3d(0, 0, 0), bool  combineWithExistingMatrix = true  )

inline

Parameters

matrix	The transform matrix for the interaction being applied.
orbitDelta	The Orbit Delta to use - default is zero.
combineWithExistingMatrix	A boolean indicating if combination should occur default is true.

Member Function Documentation

getCombineWithExistingMatrix()

bool getCombineWithExistingMatrix ( ) const

inline

Returns

Whether or not to combine the interaction with the existing one

getMatrix()

const Mesh::TransformMatrix & getMatrix ( ) const

inline

Returns

The transform matrix to be applied for this interaction.

getOrbitDelta()

const Mesh::Vector3d & getOrbitDelta ( ) const

inline

Returns

The center of orbit for the camera interaction.