Avara3D 0.2.0
C++ API reference
a3d::OrthographicCamera Class Reference

Camera using a centered orthographic projection with a fixed vertical size. More...

#include <a3d/visual/camera/OrthographicCamera.h>

Inheritance diagram for a3d::OrthographicCamera:
[legend]

Public Member Functions

 OrthographicCamera ()
 Creates an unnamed camera with a 0.1 near plane, 1000 far plane, and vertical size of 2. More...
 
 OrthographicCamera (float zNear, float zFar, float ySize)
 Creates an unnamed orthographic camera with the supplied clipping distances and vertical size. More...
 
 OrthographicCamera (const std::string &name, float zNear, float zFar, float ySize)
 Creates a named orthographic camera with the supplied clipping distances and vertical size. More...
 
float zNear () const
 Returns the near clipping distance. More...
 
void zNear (float zNear)
 Sets the near clipping distance. More...
 
float zFar () const
 Returns the far clipping distance. More...
 
void zFar (float zFar)
 Sets the far clipping distance. More...
 
float ySize () const
 Returns the vertical size of the projection in scene units. More...
 
void ySize (float ySize)
 Sets the vertical size of the projection in scene units. More...
 
- Public Member Functions inherited from a3d::Camera
 Camera ()
 Creates an unnamed Camera. More...
 
 Camera (const std::string &name)
 Creates a Camera with name. More...
 
const std::optional< std::string > & name () const
 Returns the optional camera name. More...
 
void name (const std::string &name)
 Sets the camera name. More...
 

Detailed Description

Camera using a centered orthographic projection with a fixed vertical size.

Definition at line 20 of file OrthographicCamera.h.

Constructor & Destructor Documentation

◆ OrthographicCamera() [1/3]

a3d::OrthographicCamera::OrthographicCamera ( )

Creates an unnamed camera with a 0.1 near plane, 1000 far plane, and vertical size of 2.

◆ OrthographicCamera() [2/3]

a3d::OrthographicCamera::OrthographicCamera ( float  zNear,
float  zFar,
float  ySize 
)

Creates an unnamed orthographic camera with the supplied clipping distances and vertical size.

◆ OrthographicCamera() [3/3]

a3d::OrthographicCamera::OrthographicCamera ( const std::string &  name,
float  zNear,
float  zFar,
float  ySize 
)

Creates a named orthographic camera with the supplied clipping distances and vertical size.

Member Function Documentation

◆ ySize() [1/2]

float a3d::OrthographicCamera::ySize ( ) const

Returns the vertical size of the projection in scene units.

◆ ySize() [2/2]

void a3d::OrthographicCamera::ySize ( float  ySize)

Sets the vertical size of the projection in scene units.

◆ zFar() [1/2]

float a3d::OrthographicCamera::zFar ( ) const

Returns the far clipping distance.

◆ zFar() [2/2]

void a3d::OrthographicCamera::zFar ( float  zFar)

Sets the far clipping distance.

◆ zNear() [1/2]

float a3d::OrthographicCamera::zNear ( ) const

Returns the near clipping distance.

◆ zNear() [2/2]

void a3d::OrthographicCamera::zNear ( float  zNear)

Sets the near clipping distance.


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