The camera defines the viewpoint from which the scene is rendered. More...
Public Member Functions | |
General methods | |
| virtual bool | get_orthographic () const =0 |
| Returns the projection mode of the camera. More... |
|
| virtual void | set_orthographic (bool orthographic)=0 |
| Sets the projection mode of the camera. More... |
|
| virtual Float64 | get_focal () const =0 |
| Returns the focal length. More... |
|
| virtual void | set_focal (Float64 focal)=0 |
| Sets the focal length. More... |
|
| virtual Float64 | get_aperture () const =0 |
| Returns the aperture width. More... |
|
| virtual void | set_aperture (Float64 aperture)=0 |
| Sets the aperture width. More... |
|
| virtual Float64 | get_clip_min () const =0 |
| Returns the hither clipping distance. More... |
|
| virtual void | set_clip_min (Float64 clip_min)=0 |
| Sets the hither clipping distance. More... |
|
| virtual Float64 | get_clip_max () const =0 |
| Returns the yon clipping distance. More... |
|
| virtual void | set_clip_max (Float64 clip_max)=0 |
| Sets the yon clipping distance. More... |
|
| virtual Float64 | get_offset_x () const =0 |
| Returns the horizontal image plane shift. More... |
|
| virtual void | set_offset_x (Float64 offset_x)=0 |
| Sets the horizontal image plane shift. More... |
|
| virtual Float64 | get_offset_y () const =0 |
| Returns the vertical image plane shift. More... |
|
| virtual void | set_offset_y (Float64 offset_y)=0 |
| Sets the vertical image plane shift. More... |
|
| virtual Uint32 | get_resolution_x () const =0 |
| Returns the raster space X resolution. More... |
|
| virtual void | set_resolution_x (Uint32 resolution_x)=0 |
| Sets the raster space X resolution. More... |
|
| virtual Uint32 | get_resolution_y () const =0 |
| Returns the raster space Y resolution. More... |
|
| virtual void | set_resolution_y (Uint32 resolution_y)=0 |
| Sets the raster space Y resolution. More... |
|
| virtual Uint32 | get_window_xl () const =0 |
| Returns the x-coordinate of the lower left corner of the render subwindow in raster space. More... |
|
| virtual void | set_window_xl (Uint32 window_xl)=0 |
| Sets the x-coordinate of the lower left corner of the render subwindow in raster space. More... |
|
| virtual Uint32 | get_window_yl () const =0 |
| Returns the y-coordinate of the lower left corner of the render subwindow in raster space. More... |
|
| virtual void | set_window_yl (Uint32 window_yl)=0 |
| Sets the y-coordinate of the lower left corner of the render subwindow in raster space. More... |
|
| virtual Uint32 | get_window_xh () const =0 |
| Returns the x-coordinate of the upper right corner of the render subwindow in raster space. More... |
|
| virtual void | set_window_xh (Uint32 window_xh)=0 |
| Sets the x-coordinate of the upper right corner of the render subwindow in raster space. More... |
|
| virtual Uint32 | get_window_yh () const =0 |
| Returns the y-coordinate of the upper right corner of the render subwindow in raster space. More... |
|
| virtual void | set_window_yh (Uint32 window_yh)=0 |
| Sets the y-coordinate of the upper right corner of the render subwindow in raster space. More... |
|
| virtual Float64 | get_frame_time () const =0 |
| Returns the frame time in seconds. More... |
|
| virtual void | set_frame_time (Float64 frame_time)=0 |
| Sets the frame time in seconds. More... |
|
| virtual Float64 | get_aspect () const =0 |
| Returns the aspect ratio. More... |
|
| virtual void | set_aspect (Float64 aspect)=0 |
| Sets the aspect ratio. More... |
|
Methods related to MDL | |
| virtual Sint32 | set_backplate_function (const char *name)=0 |
| Sets the backplate function. More... |
|
| virtual const char * | get_backplate_function () const =0 |
| Returns the backplate function. More... |
|
| virtual void | set_backplate_background_color (const Color_struct &color)=0 |
| Sets the background color of the backplate. More... |
|
| virtual Color_struct | get_backplate_background_color () const =0 |
| Returns the background color of the backplate. More... |
|
| virtual void | set_backplate_tonemapping_enabled (bool flag)=0 |
| Enables or disables tonemapping of the backplate. More... |
|
| virtual bool | get_backplate_tonemapping_enabled () const =0 |
| Indicates whether tonemapping of the backplate is enabled. More... |
|
| virtual void | set_backplate_dof_enabled (bool flag)=0 |
| Enables or disables depth of field of the backplate. More... |
|
| virtual bool | get_backplate_dof_enabled () const =0 |
| Indicates whether depth of field of the backplate is enabled. More... |
|
| virtual void | set_backplate_lens_effects_enabled (bool flag)=0 |
| Enables or disables lens effects on the backplate. More... |
|
| virtual bool | get_backplate_lens_effects_enabled () const =0 |
| Indicates whether lens effects on the backplate are enabled. More... |
|
| virtual Sint32 | set_aperture_function (const char *name)=0 |
| Sets the aperture function. More... |
|
| virtual const char * | get_aperture_function () const =0 |
| Returns the aperture function. More... |
|
Methods related to irradiance probes | |
| virtual Sint32 | set_irradiance_probes (const char *probes)=0 |
| Sets the scene element containing the irradiance probes. More... |
|
| virtual const char * | get_irradiance_probes () const =0 |
| Returns the scene element containing the irradiance probes. More... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0xb23d7fee, 0xffb9, 0x4076, 0xa0, 0x3a, 0x34, 0xbb, 0xa1, 0x08, 0x75, 0x91, neuraylib::IScene_element >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, neuraylib::IScene_element > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0xb23d7fee, 0xffb9, 0x4076, 0xa0, 0x3a, 0x34, 0xbb, 0xa1, 0x08, 0x75, 0x91, neuraylib::IScene_element >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
The camera defines the viewpoint from which the scene is rendered.
Multiple cameras can be defined but only one can be used for rendering at a time, which is the camera referenced by mi::neuraylib::IScene::get_camera_instance().
The camera defines various characteristics such as focal length, aperture, and aspect ratio, as well as the sizes of rendered frame buffers.
The camera is fixed at the origin, looking down the negative Z-axis, with up being the positive Y-axis. The camera can be placed anywhere in world space using a transformation in an mi::neuraylib::IInstance class, in the same way that objects are placed anywhere in world space.
To specify the environment via MDL use the attribute environment_function on mi::neuraylib::IOptions. See Section Environment dome and implicit groundplane of the Iray Programmer's Manual.
While this camera interface has no built-in support for stereo cameras, it is flexible enough to support such a setup. Suppose the camera for both views is separated by the horizontal distance eye_distance and the distance to the screen is given by screen_distance. The difference between the offset_x values of both views is then given by
So when rendering the view for the left eye you should increase offset_x by delta/2, and decrease it by delta/2 for the right eye. If no explicit distance to the screen is known, the focal length might be used instead.
|
pure virtual |
Returns the aperture width.
|
pure virtual |
Returns the aperture function.
The aperture function is of type mi::neuraylib::IMdl_function_call.
NULL if no aperture function is attached.
|
pure virtual |
Returns the aspect ratio.
|
pure virtual |
Returns the background color of the backplate.
|
pure virtual |
Indicates whether depth of field of the backplate is enabled.
|
pure virtual |
Returns the backplate function.
The backplate function is of type mi::neuraylib::IMdl_function_call.
NULL if no backplate function is attached.
|
pure virtual |
Indicates whether lens effects on the backplate are enabled.
|
pure virtual |
Indicates whether tonemapping of the backplate is enabled.
|
pure virtual |
Returns the yon clipping distance.
|
pure virtual |
Returns the hither clipping distance.
|
pure virtual |
Returns the focal length.
|
pure virtual |
Returns the frame time in seconds.
|
pure virtual |
Returns the scene element containing the irradiance probes.
The irradiance probes backplate function is of type mi::neuraylib::IIrradiance_probes.
NULL if no irradiance probes are attached to the camera.
|
pure virtual |
Returns the horizontal image plane shift.
|
pure virtual |
Returns the vertical image plane shift.
|
pure virtual |
Returns the projection mode of the camera.
true for orthographic cameras, false for perspective cameras (default).
|
pure virtual |
Returns the raster space X resolution.
|
pure virtual |
Returns the raster space Y resolution.
|
pure virtual |
Returns the x-coordinate of the upper right corner of the render subwindow in raster space.
|
pure virtual |
Returns the x-coordinate of the lower left corner of the render subwindow in raster space.
|
pure virtual |
Returns the y-coordinate of the upper right corner of the render subwindow in raster space.
|
pure virtual |
Returns the y-coordinate of the lower left corner of the render subwindow in raster space.
|
pure virtual |
Sets the aperture width.
|
pure virtual |
Sets the aperture function.
| name | The name of the aperture function, or NULL to remove the current aperture function. |
|
pure virtual |
Sets the aspect ratio.
|
pure virtual |
Sets the background color of the backplate.
|
pure virtual |
Enables or disables depth of field of the backplate.
By default, depth of field of the backplate is disabled.
|
pure virtual |
Sets the backplate function.
| name | The name of the backplate function, or NULL to remove the current backplate function. |
|
pure virtual |
Enables or disables lens effects on the backplate.
By default, lens effects on the backplate is disabled.
|
pure virtual |
Enables or disables tonemapping of the backplate.
By default, tonemapping of the backplate is disabled.
|
pure virtual |
Sets the yon clipping distance.
|
pure virtual |
Sets the hither clipping distance.
|
pure virtual |
Sets the focal length.
|
pure virtual |
Sets the frame time in seconds.
|
pure virtual |
Sets the scene element containing the irradiance probes.
| probes | The name of the irradiance probes, or NULL to remove the current irradiance probes from the camera. |
|
pure virtual |
Sets the horizontal image plane shift.
|
pure virtual |
Sets the vertical image plane shift.
|
pure virtual |
Sets the projection mode of the camera.
| orthographic |
true for orthographic cameras, false for perspective cameras (default) |
|
pure virtual |
Sets the raster space X resolution.
|
pure virtual |
Sets the raster space Y resolution.
|
pure virtual |
Sets the x-coordinate of the upper right corner of the render subwindow in raster space.
|
pure virtual |
Sets the x-coordinate of the lower left corner of the render subwindow in raster space.
|
pure virtual |
Sets the y-coordinate of the upper right corner of the render subwindow in raster space.
|
pure virtual |
Sets the y-coordinate of the lower left corner of the render subwindow in raster space.