Interface class for a camera implementing the orthographic camera model.
More...
#include <icamera.h>
Inherits mi::base::Interface_declare< 0xd7d339b2, ... >.
|
| virtual void | assign (const IOrthographic_camera *other)=0 |
| | Assign all camera parameters from the source object to this camera. More...
|
| |
| virtual mi::Float64 | get_aperture () const =0 |
| | Returns the aperture width. More...
|
| |
| virtual void | set_aperture (mi::Float64 aperture_width)=0 |
| | Sets the aperture width. More...
|
| |
| virtual mi::Float64 | get_aspect () const =0 |
| | Returns the aspect ratio, defined as width/height. More...
|
| |
| virtual void | set_aspect (mi::Float64 aspect_ratio)=0 |
| | Sets the aspect ratio. More...
|
| |
| virtual mi::Float64 | get_clip_min () const =0 |
| | Returns the distance to the near clipping plane (hither). More...
|
| |
| virtual void | set_clip_min (mi::Float64 clip_min)=0 |
| | Sets the distance to the near clipping plane (hither). More...
|
| |
| virtual mi::Float64 | get_clip_max () const =0 |
| | Returns the distance to the far clipping plane (yon). More...
|
| |
| virtual void | set_clip_max (mi::Float64 clip_max)=0 |
| | Sets the distance to the far clipping plane (yon). More...
|
| |
Interface class for a camera implementing the orthographic camera model.
When orthographic projection is used, only the width and height of the viewing plane are relevant. The size of the viewing plane is controlled through the width of the aperture and the aspect ratio.
Other attributes stored in the IOrthographic_camera class include the near and far clipping planes and the canvas resolution (width and height).
◆ assign()
Assign all camera parameters from the source object to this camera.
- Parameters
-
◆ get_aperture()
| virtual mi::Float64 nv::index::IOrthographic_camera::get_aperture |
( |
| ) |
const |
|
pure virtual |
Returns the aperture width.
- Returns
- aperture width
◆ get_aspect()
| virtual mi::Float64 nv::index::IOrthographic_camera::get_aspect |
( |
| ) |
const |
|
pure virtual |
Returns the aspect ratio, defined as width/height.
- Note
- This does not take the canvas size controlled by
set_resolution_x() and set_resolution_y() into account.
- Returns
- aspect ratio
◆ get_clip_max()
| virtual mi::Float64 nv::index::IOrthographic_camera::get_clip_max |
( |
| ) |
const |
|
pure virtual |
Returns the distance to the far clipping plane (yon).
- Returns
- far clipping plane distance
◆ get_clip_min()
| virtual mi::Float64 nv::index::IOrthographic_camera::get_clip_min |
( |
| ) |
const |
|
pure virtual |
Returns the distance to the near clipping plane (hither).
- Returns
- near clipping plane distance
◆ set_aperture()
| virtual void nv::index::IOrthographic_camera::set_aperture |
( |
mi::Float64 |
aperture_width | ) |
|
|
pure virtual |
Sets the aperture width.
- Parameters
-
| [in] | aperture_width | Aperture width |
◆ set_aspect()
| virtual void nv::index::IOrthographic_camera::set_aspect |
( |
mi::Float64 |
aspect_ratio | ) |
|
|
pure virtual |
Sets the aspect ratio.
It is defined a width/height.
- Parameters
-
| [in] | aspect_ratio | Aspect ratio, must be positive |
◆ set_clip_max()
| virtual void nv::index::IOrthographic_camera::set_clip_max |
( |
mi::Float64 |
clip_max | ) |
|
|
pure virtual |
Sets the distance to the far clipping plane (yon).
- Parameters
-
◆ set_clip_min()
| virtual void nv::index::IOrthographic_camera::set_clip_min |
( |
mi::Float64 |
clip_min | ) |
|
|
pure virtual |
Sets the distance to the near clipping plane (hither).
- Parameters
-
The documentation for this class was generated from the following file:
