opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
osc::Camera Class Reference

#include <camera.h>

Inheritance diagram for osc::Camera:
[legend]

Public Member Functions

 Camera ()
 
void reset ()
 
CameraProjection projection () const
 
void set_projection (CameraProjection)
 
float orthographic_size () const
 
void set_orthographic_size (float)
 
Radians vertical_field_of_view () const
 
void set_vertical_field_of_view (Radians)
 
Radians horizontal_field_of_view (float aspect_ratio) const
 
CameraClippingPlanes clipping_planes () const
 
void set_clipping_planes (CameraClippingPlanes)
 
float near_clipping_plane () const
 
void set_near_clipping_plane (float)
 
float far_clipping_plane () const
 
void set_far_clipping_plane (float)
 
Vector3 position () const
 
void set_position (const Vector3 &)
 
Quaternion rotation () const
 
void set_rotation (const Quaternion &)
 
Vector3 direction () const
 
void set_direction (const Vector3 &)
 
Vector3 forward () const
 
void set_forward (const Vector3 &direction)
 
Vector3 up () const
 
void set_up (const Vector3 &)
 
Ray principal_ray () const
 
Matrix4x4 view_matrix () const
 
Matrix4x4 inverse_view_matrix () const
 
std::optional< Matrix4x4 > view_matrix_override () const
 
void set_view_matrix_override (std::optional< Matrix4x4 >)
 
Matrix4x4 projection_matrix (float aspect_ratio) const
 
std::optional< Matrix4x4 > projection_matrix_override () const
 
void set_projection_matrix_override (std::optional< Matrix4x4 >)
 
Matrix4x4 view_projection_matrix (float aspect_ratio) const
 
Matrix4x4 inverse_view_projection_matrix (float aspect_ratio) const
 
Vector2 world_to_ui (const Vector3 &world_position, const Rect &ui_rect) const
 
Ray ui_to_world (const Vector2 &ui_position, const Rect &ui_rect) const
 
float view_volume_height_at_depth (float depth) const
 

Friends

bool operator== (const Camera &, const Camera &)
 

Detailed Description

Represents a camera at position in world space, pointing in direction, and oriented such that the top of its viewing plane points up.

Constructor & Destructor Documentation

◆ Camera()

osc::Camera::Camera ( )

Member Function Documentation

◆ clipping_planes()

CameraClippingPlanes osc::Camera::clipping_planes ( ) const

◆ direction()

Vector3 osc::Camera::direction ( ) const

◆ far_clipping_plane()

float osc::Camera::far_clipping_plane ( ) const

◆ forward()

Vector3 osc::Camera::forward ( ) const

◆ horizontal_field_of_view()

Radians osc::Camera::horizontal_field_of_view ( float  aspect_ratio) const

◆ inverse_view_matrix()

Matrix4x4 osc::Camera::inverse_view_matrix ( ) const

◆ inverse_view_projection_matrix()

Matrix4x4 osc::Camera::inverse_view_projection_matrix ( float  aspect_ratio) const

◆ near_clipping_plane()

float osc::Camera::near_clipping_plane ( ) const

◆ orthographic_size()

float osc::Camera::orthographic_size ( ) const

◆ position()

Vector3 osc::Camera::position ( ) const

◆ principal_ray()

Ray osc::Camera::principal_ray ( ) const

◆ projection()

CameraProjection osc::Camera::projection ( ) const

◆ projection_matrix()

Matrix4x4 osc::Camera::projection_matrix ( float  aspect_ratio) const

◆ projection_matrix_override()

std::optional< Matrix4x4 > osc::Camera::projection_matrix_override ( ) const

◆ reset()

void osc::Camera::reset ( )

◆ rotation()

Quaternion osc::Camera::rotation ( ) const

◆ set_clipping_planes()

void osc::Camera::set_clipping_planes ( CameraClippingPlanes  )

◆ set_direction()

void osc::Camera::set_direction ( const Vector3 &  )

◆ set_far_clipping_plane()

void osc::Camera::set_far_clipping_plane ( float  )

◆ set_forward()

void osc::Camera::set_forward ( const Vector3 &  direction)

◆ set_near_clipping_plane()

void osc::Camera::set_near_clipping_plane ( float  )

◆ set_orthographic_size()

void osc::Camera::set_orthographic_size ( float  )

◆ set_position()

void osc::Camera::set_position ( const Vector3 &  )

◆ set_projection()

void osc::Camera::set_projection ( CameraProjection  )

◆ set_projection_matrix_override()

void osc::Camera::set_projection_matrix_override ( std::optional< Matrix4x4 >  )

◆ set_rotation()

void osc::Camera::set_rotation ( const Quaternion &  )

◆ set_up()

void osc::Camera::set_up ( const Vector3 &  )

◆ set_vertical_field_of_view()

void osc::Camera::set_vertical_field_of_view ( Radians  )

◆ set_view_matrix_override()

void osc::Camera::set_view_matrix_override ( std::optional< Matrix4x4 >  )

◆ ui_to_world()

Ray osc::Camera::ui_to_world ( const Vector2 &  ui_position,
const Rect &  ui_rect 
) const

◆ up()

Vector3 osc::Camera::up ( ) const

◆ vertical_field_of_view()

Radians osc::Camera::vertical_field_of_view ( ) const

◆ view_matrix()

Matrix4x4 osc::Camera::view_matrix ( ) const

◆ view_matrix_override()

std::optional< Matrix4x4 > osc::Camera::view_matrix_override ( ) const

◆ view_projection_matrix()

Matrix4x4 osc::Camera::view_projection_matrix ( float  aspect_ratio) const

◆ view_volume_height_at_depth()

float osc::Camera::view_volume_height_at_depth ( float  depth) const

◆ world_to_ui()

Vector2 osc::Camera::world_to_ui ( const Vector3 &  world_position,
const Rect &  ui_rect 
) const

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const Camera &  ,
const Camera &   
)
friend

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