Iray SDK API nvidia_logo_transpbg.gif Up
icamera.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_ICAMERA_H
8#define MI_NEURAYLIB_ICAMERA_H
9
12
13namespace mi {
14
15namespace neuraylib {
16
53class ICamera :
54 public base::Interface_declare<0xb23d7fee,0xffb9,0x4076,0xa0,0x3a,0x34,0xbb,0xa1,0x08,0x75,0x91,
55 neuraylib::IScene_element>
56{
57public:
59
60
64 virtual bool get_orthographic() const = 0;
65
70 virtual void set_orthographic(bool orthographic) = 0;
71
73 virtual Float64 get_focal() const = 0;
74
76 virtual void set_focal(Float64 focal) = 0;
77
79 virtual Float64 get_aperture() const = 0;
80
82 virtual void set_aperture(Float64 aperture) = 0;
83
85 virtual Float64 get_clip_min() const = 0;
86
88 virtual void set_clip_min(Float64 clip_min) = 0;
89
91 virtual Float64 get_clip_max() const = 0;
92
94 virtual void set_clip_max(Float64 clip_max) = 0;
95
97 virtual Float64 get_offset_x() const = 0;
98
100 virtual void set_offset_x(Float64 offset_x) = 0;
101
103 virtual Float64 get_offset_y() const = 0;
104
106 virtual void set_offset_y(Float64 offset_y) = 0;
107
109 virtual Uint32 get_resolution_x() const = 0;
110
112 virtual void set_resolution_x(Uint32 resolution_x) = 0;
113
115 virtual Uint32 get_resolution_y() const = 0;
116
118 virtual void set_resolution_y(Uint32 resolution_y) = 0;
119
121
133
134
136 virtual Uint32 get_window_xl() const = 0;
137
139 virtual void set_window_xl(Uint32 window_xl) = 0;
140
142 virtual Uint32 get_window_yl() const = 0;
143
145 virtual void set_window_yl(Uint32 window_yl) = 0;
146
148 virtual Uint32 get_window_xh() const = 0;
149
151 virtual void set_window_xh(Uint32 window_xh) = 0;
152
154 virtual Uint32 get_window_yh() const = 0;
155
157 virtual void set_window_yh(Uint32 window_yh) = 0;
158
160
162
164 virtual Float64 get_frame_time() const = 0;
165
167 virtual void set_frame_time(Float64 frame_time) = 0;
168
170 virtual Float64 get_aspect() const = 0;
171
173 virtual void set_aspect(Float64 aspect) = 0;
174
176
178
193 virtual Sint32 set_backplate_function( const char* name) = 0;
194
204 virtual const char* get_backplate_function() const = 0;
205
210 virtual void set_backplate_background_color( const Color_struct& color) = 0;
211
217
221 virtual void set_backplate_tonemapping_enabled( bool flag) = 0;
222
224 virtual bool get_backplate_tonemapping_enabled() const = 0;
225
229 virtual void set_backplate_lens_effects_enabled( bool flag) = 0;
230
232 virtual bool get_backplate_lens_effects_enabled() const = 0;
233
247 virtual Sint32 set_aperture_function( const char* name) = 0;
248
257 virtual const char* get_aperture_function() const = 0;
258
260
262
276 virtual Sint32 set_irradiance_probes( const char* probes) = 0;
277
284 virtual const char* get_irradiance_probes() const = 0;
285
287};
288 // end group mi_neuray_leaf_nodes
290
291} // namespace neuraylib
292
293} // namespace mi
294
295#endif // MI_NEURAYLIB_ICAMERA_H
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
The camera defines the viewpoint from which the scene is rendered.
Definition: icamera.h:56
virtual bool get_backplate_tonemapping_enabled() const =0
Indicates whether tonemapping of the backplate is enabled.
virtual void set_window_xh(Uint32 window_xh)=0
Sets the x-coordinate of the upper right corner of the subwindow in raster space.
virtual Float64 get_aperture() const =0
Returns the aperture width.
virtual void set_aspect(Float64 aspect)=0
Sets the aspect ratio.
virtual void set_resolution_y(Uint32 resolution_y)=0
Sets the raster space Y resolution.
virtual Uint32 get_resolution_y() const =0
Returns the raster space Y resolution.
virtual Float64 get_offset_x() const =0
Returns the horizontal image plane shift.
virtual void set_window_yl(Uint32 window_yl)=0
Sets the y-coordinate of the lower left corner of the subwindow in raster space.
virtual Sint32 set_aperture_function(const char *name)=0
Sets the aperture function.
virtual void set_clip_min(Float64 clip_min)=0
Sets the hither clipping distance.
virtual Uint32 get_window_yh() const =0
Returns the y-coordinate of the upper right corner of the subwindow in raster space.
virtual void set_backplate_tonemapping_enabled(bool flag)=0
Enables or disables tonemapping of the backplate.
virtual const char * get_aperture_function() const =0
Returns the aperture function.
virtual const char * get_backplate_function() const =0
Returns the backplate function.
virtual Uint32 get_window_xh() const =0
Returns the x-coordinate of the upper right corner of the subwindow in raster space.
virtual void set_backplate_lens_effects_enabled(bool flag)=0
Enables or disables lens effects on the backplate.
virtual void set_backplate_background_color(const Color_struct &color)=0
Sets the background color of the backplate.
virtual Float64 get_aspect() const =0
Returns the aspect ratio.
virtual void set_offset_x(Float64 offset_x)=0
Sets the horizontal image plane shift.
virtual Sint32 set_irradiance_probes(const char *probes)=0
Sets the scene element containing the irradiance probes.
virtual void set_clip_max(Float64 clip_max)=0
Sets the yon clipping distance.
virtual void set_window_yh(Uint32 window_yh)=0
Sets the y-coordinate of the upper right corner of the subwindow in raster space.
virtual void set_window_xl(Uint32 window_xl)=0
Sets the x-coordinate of the lower left corner of the subwindow in raster space.
virtual void set_orthographic(bool orthographic)=0
Sets the projection mode of the camera.
virtual Float64 get_frame_time() const =0
Returns the frame time in seconds.
virtual Uint32 get_window_xl() const =0
Returns the x-coordinate of the lower left corner of the subwindow in raster space.
virtual bool get_backplate_lens_effects_enabled() const =0
Indicates whether lens effects on the backplate are enabled.
virtual void set_aperture(Float64 aperture)=0
Sets the aperture width.
virtual void set_offset_y(Float64 offset_y)=0
Sets the vertical image plane shift.
virtual Uint32 get_resolution_x() const =0
Returns the raster space X resolution.
virtual const char * get_irradiance_probes() const =0
Returns the scene element containing the irradiance probes.
virtual Uint32 get_window_yl() const =0
Returns the y-coordinate of the lower left corner of the subwindow in raster space.
virtual void set_resolution_x(Uint32 resolution_x)=0
Sets the raster space X resolution.
virtual Sint32 set_backplate_function(const char *name)=0
Sets the backplate function.
virtual Float64 get_focal() const =0
Returns the focal length.
virtual Float64 get_offset_y() const =0
Returns the vertical image plane shift.
virtual Float64 get_clip_min() const =0
Returns the hither clipping distance.
virtual bool get_orthographic() const =0
Returns the projection mode of the camera.
virtual Float64 get_clip_max() const =0
Returns the yon clipping distance.
virtual Color_struct get_backplate_background_color() const =0
Returns the background color of the backplate.
virtual void set_frame_time(Float64 frame_time)=0
Sets the frame time in seconds.
virtual void set_focal(Float64 focal)=0
Sets the focal length.
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
double Float64
64-bit float.
Definition: types.h:52
signed int Sint32
32-bit signed integer.
Definition: types.h:46
Base class for all scene elements.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: neuraylib.h:179
Generic storage class template for an RGBA color representation storing four floating points elements...
Definition: vector.h:67
Typedefs for types from the math API.