NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
icamera.h
Go to the documentation of this file.
1 //*****************************************************************************
2 // Copyright 1986, 2016 NVIDIA Corporation. All rights reserved.
3 //*****************************************************************************
6 //*****************************************************************************
7 
8 #ifndef MI_NEURAYLIB_ICAMERA_H
9 #define MI_NEURAYLIB_ICAMERA_H
10 
11 #include <mi/neuraylib/iscene_element.h>
12 #include <mi/neuraylib/typedefs.h>
13 #include <mi/neuraylib/version.h>
14 
15 namespace mi {
16 
17 namespace neuraylib {
18 
19 class MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader);
20 
25 class ICamera :
58  public base::Interface_declare<0xb23d7fee,0xffb9,0x4076,0xa0,0x3a,0x34,0xbb,0xa1,0x08,0x75,0x91,
59  neuraylib::IScene_element>
60 {
61 public:
63 
64 
68  virtual bool get_orthographic() const = 0;
69 
74  virtual void set_orthographic(bool orthographic) = 0;
75 
77  virtual Float64 get_focal() const = 0;
78 
80  virtual void set_focal(Float64 focal) = 0;
81 
83  virtual Float64 get_aperture() const = 0;
84 
86  virtual void set_aperture(Float64 aperture) = 0;
87 
89  virtual Float64 get_clip_min() const = 0;
90 
92  virtual void set_clip_min(Float64 clip_min) = 0;
93 
95  virtual Float64 get_clip_max() const = 0;
96 
98  virtual void set_clip_max(Float64 clip_max) = 0;
99 
101  virtual Float64 get_offset_x() const = 0;
102 
104  virtual void set_offset_x(Float64 offset_x) = 0;
105 
107  virtual Float64 get_offset_y() const = 0;
108 
110  virtual void set_offset_y(Float64 offset_y) = 0;
111 
113  virtual Uint32 get_resolution_x() const = 0;
114 
116  virtual void set_resolution_x(Uint32 resolution_x) = 0;
117 
119  virtual Uint32 get_resolution_y() const = 0;
120 
122  virtual void set_resolution_y(Uint32 resolution_y) = 0;
123 
125  virtual Uint32 get_window_xl() const = 0;
126 
128  virtual void set_window_xl(Uint32 window_xl) = 0;
129 
131  virtual Uint32 get_window_yl() const = 0;
132 
134  virtual void set_window_yl(Uint32 window_yl) = 0;
135 
137  virtual Uint32 get_window_xh() const = 0;
138 
140  virtual void set_window_xh(Uint32 window_xh) = 0;
141 
143  virtual Uint32 get_window_yh() const = 0;
144 
146  virtual void set_window_yh(Uint32 window_yh) = 0;
147 
149  virtual Float64 get_frame_time() const = 0;
150 
152  virtual void set_frame_time(Float64 frame_time) = 0;
153 
155  virtual Float64 get_aspect() const = 0;
156 
158  virtual void set_aspect(Float64 aspect) = 0;
159 
161 
163 
178  virtual Sint32 set_backplate_function( const char* name) = 0;
179 
189  virtual const char* get_backplate_function() const = 0;
190 
195  virtual void set_backplate_background_color( const Color_struct& color) = 0;
196 
201  virtual Color_struct get_backplate_background_color() const = 0;
202 
206  virtual void set_backplate_tonemapping_enabled( bool flag) = 0;
207 
209  virtual bool get_backplate_tonemapping_enabled() const = 0;
210 
214  virtual void set_backplate_dof_enabled( bool flag) = 0;
215 
217  virtual bool get_backplate_dof_enabled() const = 0;
218 
222  virtual void set_backplate_lens_effects_enabled( bool flag) = 0;
223 
225  virtual bool get_backplate_lens_effects_enabled() const = 0;
226 
240  virtual Sint32 set_aperture_function( const char* name) = 0;
241 
250  virtual const char* get_aperture_function() const = 0;
251 
253 
255 
269  virtual Sint32 set_irradiance_probes( const char* probes) = 0;
270 
277  virtual const char* get_irradiance_probes() const = 0;
278 
280 
281  virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_METASL(attach_shader)(
282  Shader_type type, const char* name) = 0;
283 
284  virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_METASL(detach_shader)(
285  Shader_type type) = 0;
286 
287  virtual const MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader)* access_shader(
288  Shader_type type) const = 0;
289 
290  virtual MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader)* edit_shader(
291  Shader_type type) const = 0;
292 };
293  // end group mi_neuray_leaf_nodes
295 
296 } // namespace neuraylib
297 
298 #ifdef MI_NEURAYLIB_DEPRECATED_NAMESPACE_MI_TRANSITION
299 using neuraylib::ICamera;
300 using neuraylib::IScene_element;
301 using neuraylib::MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader);
302 using neuraylib::Shader_type;
303 #endif // MI_NEURAYLIB_DEPRECATED_NAMESPACE_MI_TRANSITION
304 
305 } // namespace mi
306 
307 #endif // MI_NEURAYLIB_ICAMERA_H