NDEVR
API Documentation
CameraAnimation

A container for information relating to a Camera 3D animation such as zooming or rotating around a target. More...

Collaboration diagram for CameraAnimation:
[legend]

Public Member Functions

 CameraAnimation ()
 Constructs a CameraAnimation with all values initialized to invalid or default states.
bool operator!= (const CameraAnimation &animation) const
 Checks whether two CameraAnimation instances differ in any byte.
bool operator== (const CameraAnimation &animation) const
 Checks whether two CameraAnimation instances are byte-for-byte equal.

Public Attributes

bool is_active
 Whether this animation is currently active and should be processed.
uint01 is_orthographic
 Whether the camera should be orthographic. Uses uint01 with invalid sentinel to represent unset state.
Vertex< 3, fltp08 > location
 The target camera position in 3D world space.
Vector< 3, Angle< fltp08 > > orientation
 The camera orientation as pitch, yaw, and roll angles.
fltp08 orthographic_fov
 The orthographic field-of-view size. Invalid if not set.
Vector< 3, fltp08 > target
 The point in 3D world space that the camera looks at.
TimeSpan time = TimeSpan(0.0)
 The duration over which the animation should play.
fltp08 zoom_extent_mult
 A multiplier applied to the zoom extent when framing objects. Invalid if not set.

Detailed Description

A container for information relating to a Camera 3D animation such as zooming or rotating around a target.

Definition at line 12 of file ViewportAnimation.h.

Constructor & Destructor Documentation

◆ CameraAnimation()

CameraAnimation::CameraAnimation ( )
inline

Constructs a CameraAnimation with all values initialized to invalid or default states.

Members are set to invalid sentinel values so that downstream logic can detect which fields have been explicitly set for this animation.

Definition at line 19 of file ViewportAnimation.h.

References is_active, is_orthographic, location, orientation, orthographic_fov, target, time, and zoom_extent_mult.

Referenced by operator!=(), and operator==().

Member Function Documentation

◆ operator!=()

bool CameraAnimation::operator!= ( const CameraAnimation & animation) const
inline

Checks whether two CameraAnimation instances differ in any byte.

Parameters
[in]animationThe CameraAnimation to compare against.
Returns
True if any field differs, false otherwise.

Definition at line 41 of file ViewportAnimation.h.

References CameraAnimation().

◆ operator==()

bool CameraAnimation::operator== ( const CameraAnimation & animation) const
inline

Checks whether two CameraAnimation instances are byte-for-byte equal.

Parameters
[in]animationThe CameraAnimation to compare against.
Returns
True if all fields are identical, false otherwise.

Definition at line 33 of file ViewportAnimation.h.

References CameraAnimation().

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