Workspace 6.21.5
Public Member Functions | List of all members
CameraUpdateEvent Class Reference

Event raised to update one or more specific properties of a camera. More...

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

Inheritance diagram for CameraUpdateEvent:
[legend]

Public Member Functions

 CameraUpdateEvent (double near_p, double far_p, double fov, double orthoViewVolume)
 
double getFar () const
 
double getFov () const
 
double getNear () const
 
double getOrthoViewVolume () const
 
- Public Member Functions inherited from ObservableEventType< CameraUpdateEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > & eventID ()
 
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > & eventID ()
 
const EventIDSingleton< CameraUpdateEvent > & getEventID () const override
 
- Public Member Functions inherited from ObservableEvent
virtual ~ObservableEvent ()=default
 
virtual const EventIDgetEventID () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from ObservableEventType< CameraUpdateEvent >
static const EventIDSingleton< CameraUpdateEvent > & eventID ()
 
- Protected Member Functions inherited from ObservableEventType< CameraUpdateEvent >
 ObservableEventType ()=default
 

Detailed Description

Note
does not update the transform matrix.

This event is separated from the CameraInteractionEvent, which handles transforms, because the CameraInteractionEvent can be handled by TransformBuilders and other classes. The data contained within this event is specific to the Camera class itself.

Constructor & Destructor Documentation

◆ CameraUpdateEvent()

CameraUpdateEvent ( double  near_p,
double  far_p,
double  fov,
double  orthoViewVolume 
)
inline
Parameters
near_pThe updated near clip distance
far_pThe updated far clip distance
fovThe updated field of view (degrees)
orthoViewVolumeThe updated size of the view volume for an orthographic camera

Member Function Documentation

◆ getFar()

double getFar ( ) const
inline
Returns
The new value to be assigned to the camera's far clip distance.

◆ getFov()

double getFov ( ) const
inline
Returns
The new value to be assigned to the camera's field of view.

◆ getNear()

double getNear ( ) const
inline
Returns
The new value to be assigned to the camera's near clip distance.

◆ getOrthoViewVolume()

double getOrthoViewVolume ( ) const
inline
Returns
The new value to be assigned to the camera's orthoViewVolume property.