neuray API Programmer's Manual

icamera.h File Reference

Description

Scene element Camera.

Code Example

icamera.h

‎//*****************************************************************************
// Copyright 1986, 2016 NVIDIA Corporation. All rights reserved.
//*****************************************************************************
//*****************************************************************************

#ifndef MI_NEURAYLIB_ICAMERA_H
#define MI_NEURAYLIB_ICAMERA_H

#include <mi/neuraylib/iscene_element.h>
#include <mi/neuraylib/typedefs.h>
#include <mi/neuraylib/version.h>

namespace mi {

namespace neuraylib {

class MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader);

































class ICamera :
    public base::Interface_declare<0xb23d7fee,0xffb9,0x4076,0xa0,0x3a,0x34,0xbb,0xa1,0x08,0x75,0x91,
                                   neuraylib::IScene_element>
{
public:


    virtual bool get_orthographic() const = 0;

    virtual void set_orthographic(bool orthographic) = 0;

    virtual Float64 
               get_focal() const = 0;

    virtual void set_focal(Float64 focal) = 0;

    virtual Float64 
               get_aperture() const = 0;

    virtual void set_aperture(Float64 aperture) = 0;

    virtual Float64 
               get_clip_min() const = 0;

    virtual void set_clip_min(Float64 clip_min) = 0;

    virtual Float64 
               get_clip_max() const = 0;

    virtual void set_clip_max(Float64 clip_max) = 0;

    virtual Float64 
               get_offset_x() const = 0;

    virtual void set_offset_x(Float64 offset_x) = 0;

    virtual Float64 
               get_offset_y() const = 0;

    virtual void set_offset_y(Float64 offset_y) = 0;

    virtual Uint32 
               get_resolution_x() const = 0;

    virtual void set_resolution_x(Uint32 resolution_x) = 0;

    virtual Uint32 
               get_resolution_y() const = 0;

    virtual void set_resolution_y(Uint32 resolution_y) = 0;

    virtual Uint32 
               get_window_xl() const = 0;

    virtual void set_window_xl(Uint32 window_xl) = 0;

    virtual Uint32 
               get_window_yl() const = 0;

    virtual void set_window_yl(Uint32 window_yl) = 0;

    virtual Uint32 
               get_window_xh() const = 0;

    virtual void set_window_xh(Uint32 window_xh) = 0;

    virtual Uint32 
               get_window_yh() const = 0;

    virtual void set_window_yh(Uint32 window_yh) = 0;

    virtual Float64 
               get_frame_time() const = 0;

    virtual void set_frame_time(Float64 frame_time) = 0;

    virtual Float64 
               get_aspect() const = 0;

    virtual void set_aspect(Float64 aspect) = 0;




    virtual Sint32 
               set_backplate_function( const char* name) = 0;

    virtual const char* get_backplate_function() const = 0;

    virtual void set_backplate_background_color( const Color_struct& color) = 0;

    virtual Color_struct 
               get_backplate_background_color() const = 0;

    virtual void set_backplate_tonemapping_enabled( bool flag) = 0;

    virtual bool get_backplate_tonemapping_enabled() const = 0;

    virtual void set_backplate_dof_enabled( bool flag) = 0;

    virtual bool get_backplate_dof_enabled() const = 0;

    virtual void set_backplate_lens_effects_enabled( bool flag) = 0;

    virtual bool get_backplate_lens_effects_enabled() const = 0;

    virtual Sint32 
               set_aperture_function( const char* name) = 0;

    virtual const char* get_aperture_function() const = 0;




    virtual Sint32 
               set_irradiance_probes( const char* probes) = 0;

    virtual const char* get_irradiance_probes() const = 0;


    virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_METASL(attach_shader)(
        Shader_type type, const char* name) = 0;

    virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_METASL(detach_shader)(
        Shader_type type) = 0;

    virtual const MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader)* access_shader(
        Shader_type type) const = 0;

    virtual MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader)* edit_shader(
        Shader_type type) const = 0;
};
 // end group mi_neuray_leaf_nodes

} // namespace neuraylib

#ifdef MI_NEURAYLIB_DEPRECATED_NAMESPACE_MI_TRANSITION
using neuraylib::ICamera;
using neuraylib::IScene_element;
using neuraylib::MI_NEURAYLIB_DEPRECATED_CLASS_METASL(IShader);
using neuraylib::Shader_type;
#endif // MI_NEURAYLIB_DEPRECATED_NAMESPACE_MI_TRANSITION

} // namespace mi

#endif // MI_NEURAYLIB_ICAMERA_H

Namespaces

namespace 
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH. More...
namespace 
Namespace for the neuray API. More...

Classes

class 
The camera defines the viewpoint from which the scene is rendered. More...