VRay SDK for C++
Loading...
Searching...
No Matches
VRay::Plugins::CameraPhysical Class Reference

Defines a physical camera when present in the scene. Affects DoF, exposure, motion blur etc. [gpuSupport=(partial)]. More...

#include <vrayplugins.hpp>

Inheritance diagram for VRay::Plugins::CameraPhysical:
VRay::Plugin

Public Member Functions

float get_anisotropy (double time=TiMe::Default()) const
 
bool get_blades_enable (double time=TiMe::Default()) const
 
int get_blades_num (double time=TiMe::Default()) const
 
float get_blades_rotation (double time=TiMe::Default()) const
 
bool get_bmpaperture_affects_exposure (double time=TiMe::Default()) const
 
bool get_bmpaperture_enable (double time=TiMe::Default()) const
 
int get_bmpaperture_resolution (double time=TiMe::Default()) const
 
Value get_bmpaperture_tex (double time=TiMe::Default()) const
 
Value get_camera_shader_tex (double time=TiMe::Default()) const
 
float get_center_bias (double time=TiMe::Default()) const
 
float get_distortion (double time=TiMe::Default()) const
 
Value get_distortion_tex (double time=TiMe::Default()) const
 
int get_distortion_type (double time=TiMe::Default()) const
 
float get_dof_display_threshold (double time=TiMe::Default()) const
 
bool get_dont_affect_settings (double time=TiMe::Default()) const
 
bool get_enable_thin_lens_equation (double time=TiMe::Default()) const
 
int get_exposure (double time=TiMe::Default()) const
 
float get_exposure_value (double time=TiMe::Default()) const
 
float get_f_number (double time=TiMe::Default()) const
 
float get_film_width (double time=TiMe::Default()) const
 
float get_focal_length (double time=TiMe::Default()) const
 
float get_focus_distance (double time=TiMe::Default()) const
 
float get_fov (double time=TiMe::Default()) const
 
float get_horizontal_offset (double time=TiMe::Default()) const
 
float get_horizontal_shift (double time=TiMe::Default()) const
 
float get_ISO (double time=TiMe::Default()) const
 
float get_latency (double time=TiMe::Default()) const
 
std::string get_lens_file (double time=TiMe::Default()) const
 
float get_lens_shift (double time=TiMe::Default()) const
 
float get_optical_vignetting (double time=TiMe::Default()) const
 
float get_rolling_shutter_duration (double time=TiMe::Default()) const
 
int get_rolling_shutter_mode (double time=TiMe::Default()) const
 
std::string get_scene_name (double time=TiMe::Default()) const
 
float get_shutter_angle (double time=TiMe::Default()) const
 
float get_shutter_offset (double time=TiMe::Default()) const
 
float get_shutter_speed (double time=TiMe::Default()) const
 
bool get_specify_focus (double time=TiMe::Default()) const
 
bool get_specify_fov (double time=TiMe::Default()) const
 
int get_subdivs (double time=TiMe::Default()) const
 
float get_target_distance (double time=TiMe::Default()) const
 
bool get_targeted (double time=TiMe::Default()) const
 
int get_type (double time=TiMe::Default()) const
 
bool get_use_dof (double time=TiMe::Default()) const
 
bool get_use_moblur (double time=TiMe::Default()) const
 
float get_vertical_offset (double time=TiMe::Default()) const
 
float get_vignetting (double time=TiMe::Default()) const
 
Color get_white_balance (double time=TiMe::Default()) const
 
float get_zoom_factor (double time=TiMe::Default()) const
 
 operator SettingsPluginCategory ()
 
bool set_anisotropy (float val, double time=TiMe::Default())
 
bool set_blades_enable (bool val, double time=TiMe::Default())
 
bool set_blades_num (int val, double time=TiMe::Default())
 
bool set_blades_rotation (float val, double time=TiMe::Default())
 
bool set_bmpaperture_affects_exposure (bool val, double time=TiMe::Default())
 
bool set_bmpaperture_enable (bool val, double time=TiMe::Default())
 
bool set_bmpaperture_resolution (int val, double time=TiMe::Default())
 
bool set_bmpaperture_tex (const AColor &texture, double time=TiMe::Default())
 
bool set_bmpaperture_tex (const PluginRef &texture, double time=TiMe::Default())
 
bool set_camera_shader_tex (const AColor &texture, double time=TiMe::Default())
 
bool set_camera_shader_tex (const PluginRef &texture, double time=TiMe::Default())
 
bool set_center_bias (float val, double time=TiMe::Default())
 
bool set_distortion (float val, double time=TiMe::Default())
 
bool set_distortion_tex (const AColor &texture, double time=TiMe::Default())
 
bool set_distortion_tex (const PluginRef &texture, double time=TiMe::Default())
 
bool set_distortion_type (int val, double time=TiMe::Default())
 
bool set_dof_display_threshold (float val, double time=TiMe::Default())
 
bool set_dont_affect_settings (bool val, double time=TiMe::Default())
 
bool set_enable_thin_lens_equation (bool val, double time=TiMe::Default())
 
bool set_exposure (int val, double time=TiMe::Default())
 
bool set_exposure_value (float val, double time=TiMe::Default())
 
bool set_f_number (float val, double time=TiMe::Default())
 
bool set_film_width (float val, double time=TiMe::Default())
 
bool set_focal_length (float val, double time=TiMe::Default())
 
bool set_focus_distance (float val, double time=TiMe::Default())
 
bool set_fov (float val, double time=TiMe::Default())
 
bool set_horizontal_offset (float val, double time=TiMe::Default())
 
bool set_horizontal_shift (float val, double time=TiMe::Default())
 
bool set_ISO (float val, double time=TiMe::Default())
 
bool set_latency (float val, double time=TiMe::Default())
 
bool set_lens_file (const char *str, double time=TiMe::Default())
 
bool set_lens_file (const std::string &str, double time=TiMe::Default())
 
bool set_lens_shift (float val, double time=TiMe::Default())
 
bool set_optical_vignetting (float val, double time=TiMe::Default())
 
bool set_rolling_shutter_duration (float val, double time=TiMe::Default())
 
bool set_rolling_shutter_mode (int val, double time=TiMe::Default())
 
bool set_scene_name (const char *str, double time=TiMe::Default())
 
bool set_scene_name (const std::string &str, double time=TiMe::Default())
 
bool set_shutter_angle (float val, double time=TiMe::Default())
 
bool set_shutter_offset (float val, double time=TiMe::Default())
 
bool set_shutter_speed (float val, double time=TiMe::Default())
 
bool set_specify_focus (bool val, double time=TiMe::Default())
 
bool set_specify_fov (bool val, double time=TiMe::Default())
 
bool set_subdivs (int val, double time=TiMe::Default())
 
bool set_target_distance (float val, double time=TiMe::Default())
 
bool set_targeted (bool val, double time=TiMe::Default())
 
bool set_type (int val, double time=TiMe::Default())
 
bool set_use_dof (bool val, double time=TiMe::Default())
 
bool set_use_moblur (bool val, double time=TiMe::Default())
 
bool set_vertical_offset (float val, double time=TiMe::Default())
 
bool set_vignetting (float val, double time=TiMe::Default())
 
bool set_white_balance (const Color &color, double time=TiMe::Default())
 
bool set_zoom_factor (float val, double time=TiMe::Default())
 
- Public Member Functions inherited from VRay::Plugin
 Plugin () noexcept
 Default construct an invalid Plugin - not referencing a V-Ray scene object.
 
 Plugin (const Plugin &plugin) noexcept
 Copy construct from another Plugin. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
 
AColor getAColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
AColor getAColor (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as AColor.
 
AColor getAColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
AColor getAColor (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool getBool (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
bool getBool (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as bool.
 
bool getBool (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool getBool (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PluginCategories getCategories () const
 
VUtils::CharString getCharString (const char *propertyName)
 
VUtils::CharString getCharString (const char *propertyName, bool &ok)
 
VUtils::CharString getCharString (const std::string &propertyName)
 
VUtils::CharString getCharString (const std::string &propertyName, bool &ok)
 
VUtils::CharString getCharStringAtTime (const char *propertyName, double time)
 
VUtils::CharString getCharStringAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::CharString getCharStringAtTime (const std::string &propertyName, double time)
 
VUtils::CharString getCharStringAtTime (const std::string &propertyName, double time, bool &ok)
 
Color getColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
Color getColor (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as Color.
 
Color getColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Color getColor (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
ColorList getColorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
ColorList getColorList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as ColorList.
 
ColorList getColorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
ColorList getColorList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::ColorRefList getColorRefList (const char *propertyName)
 
VUtils::ColorRefList getColorRefList (const char *propertyName, bool &ok)
 
VUtils::ColorRefList getColorRefList (const std::string &propertyName)
 
VUtils::ColorRefList getColorRefList (const std::string &propertyName, bool &ok)
 
VUtils::ColorRefList getColorRefListAtTime (const char *propertyName, double time)
 
VUtils::ColorRefList getColorRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::ColorRefList getColorRefListAtTime (const std::string &propertyName, double time)
 
VUtils::ColorRefList getColorRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
double getDouble (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
double getDouble (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as double.
 
double getDouble (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
double getDouble (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
float getFloat (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
float getFloat (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as float.
 
float getFloat (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
float getFloat (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
FloatList getFloatList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
FloatList getFloatList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as FloatList.
 
FloatList getFloatList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
FloatList getFloatList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::FloatRefList getFloatRefList (const char *propertyName)
 
VUtils::FloatRefList getFloatRefList (const char *propertyName, bool &ok)
 
VUtils::FloatRefList getFloatRefList (const std::string &propertyName)
 
VUtils::FloatRefList getFloatRefList (const std::string &propertyName, bool &ok)
 
VUtils::FloatRefList getFloatRefListAtTime (const char *propertyName, double time)
 
VUtils::FloatRefList getFloatRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::FloatRefList getFloatRefListAtTime (const std::string &propertyName, double time)
 
VUtils::FloatRefList getFloatRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
int getInt (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
int getInt (const char *propertyName, double time=TiMe::Default()) const
 
int getInt (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
int getInt (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
unsigned long long getIntegerID () const noexcept
 Returns the ID of the plugin instance. The ID is unique per scene contained in a VRayRenderer instance. Can be used as a hash value.
 
IntList getIntList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
IntList getIntList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as IntList.
 
IntList getIntList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
IntList getIntList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::IntRefList getIntRefList (const char *propertyName)
 
VUtils::IntRefList getIntRefList (const char *propertyName, bool &ok)
 
VUtils::IntRefList getIntRefList (const std::string &propertyName)
 
VUtils::IntRefList getIntRefList (const std::string &propertyName, bool &ok)
 
VUtils::IntRefList getIntRefListAtTime (const char *propertyName, double time)
 
VUtils::IntRefList getIntRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::IntRefList getIntRefListAtTime (const std::string &propertyName, double time)
 
VUtils::IntRefList getIntRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
std::vector< double > getKeyframeTimes (const char *propertyName) const
 
std::vector< double > getKeyframeTimes (const char *propertyName, bool &ok) const
 
std::vector< double > getKeyframeTimes (const std::string &propertyName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
std::vector< double > getKeyframeTimes (const std::string &propertyName, bool &ok) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Matrix getMatrix (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
Matrix getMatrix (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as Matrix.
 
Matrix getMatrix (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Matrix getMatrix (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PluginMeta getMeta () const
 
const char * getName () const
 
PluginRefT< PlugingetPlugin (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
PluginRefT< PlugingetPlugin (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as a Plugin reference.
 
PluginRefT< PlugingetPlugin (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PluginRefT< PlugingetPlugin (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PluginList getPluginList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
PluginList getPluginList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as PluginList.
 
PluginList getPluginList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PluginList getPluginList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
PropertyRuntimeMeta getPropertyRuntimeMeta (const char *propertyName) const
 
PropertyRuntimeMeta getPropertyRuntimeMeta (const std::string &propertyName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VRayRenderergetRenderer () const noexcept
 Return the renderer this Plugin is associated with, can be null on empty plugins.
 
std::string getString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
std::string getString (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as string.
 
std::string getString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
std::string getString (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
StringList getStringList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
StringList getStringList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as StringList.
 
StringList getStringList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
StringList getStringList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::CharStringRefList getStringRefList (const char *propertyName)
 
VUtils::CharStringRefList getStringRefList (const char *propertyName, bool &ok)
 
VUtils::CharStringRefList getStringRefList (const std::string &propertyName)
 
VUtils::CharStringRefList getStringRefList (const std::string &propertyName, bool &ok)
 
VUtils::CharStringRefList getStringRefListAtTime (const char *propertyName, double time)
 
VUtils::CharStringRefList getStringRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::CharStringRefList getStringRefListAtTime (const std::string &propertyName, double time)
 
VUtils::CharStringRefList getStringRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
Transform getTransform (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
Transform getTransform (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as Transform.
 
Transform getTransform (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Transform getTransform (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
TransformList getTransformList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
TransformList getTransformList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as TransformList.
 
TransformList getTransformList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
TransformList getTransformList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const char * getType () const
 Returns the type of this plugin as string.
 
PluginTypeId getTypeId () const noexcept
 Returns the type id of this plugin as long.
 
Value getValue (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
Value getValue (const char *propertyName, double time=TiMe::Default()) const
 
Value getValue (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Value getValue (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
std::string getValueAsString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
std::string getValueAsString (const char *propertyName, double time=TiMe::Default()) const
 
std::string getValueAsString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
std::string getValueAsString (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
ValueList getValueList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
ValueList getValueList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as ValueList. Works only if it really is a generic list.
 
ValueList getValueList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
ValueList getValueList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::ValueRefList getValueRefList (const char *propertyName)
 
VUtils::ValueRefList getValueRefList (const char *propertyName, bool &ok)
 
VUtils::ValueRefList getValueRefList (const std::string &propertyName)
 
VUtils::ValueRefList getValueRefList (const std::string &propertyName, bool &ok)
 
VUtils::ValueRefList getValueRefListAtTime (const char *propertyName, double time)
 
VUtils::ValueRefList getValueRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::ValueRefList getValueRefListAtTime (const std::string &propertyName, double time)
 
VUtils::ValueRefList getValueRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
Vector getVector (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
Vector getVector (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as Vector.
 
Vector getVector (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Vector getVector (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VectorList getVectorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
VectorList getVectorList (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as VectorList.
 
VectorList getVectorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VectorList getVectorList (const std::string &propertyName, double time=TiMe::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
VUtils::VectorRefList getVectorRefList (const char *propertyName)
 
VUtils::VectorRefList getVectorRefList (const char *propertyName, bool &ok)
 
VUtils::VectorRefList getVectorRefList (const std::string &propertyName)
 
VUtils::VectorRefList getVectorRefList (const std::string &propertyName, bool &ok)
 
VUtils::VectorRefList getVectorRefListAtTime (const char *propertyName, double time)
 
VUtils::VectorRefList getVectorRefListAtTime (const char *propertyName, double time, bool &ok)
 
VUtils::VectorRefList getVectorRefListAtTime (const std::string &propertyName, double time)
 
VUtils::VectorRefList getVectorRefListAtTime (const std::string &propertyName, double time, bool &ok)
 
bool isEmpty () const noexcept
 
bool isNotEmpty () const noexcept
 
bool isPropertyAnimated (const char *propertyName) const
 
bool isPropertyAnimated (const std::string &propertyName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool isValid () const
 
bool operator!= (const Plugin &plugin) const noexcept
 Returns false if both Plugins belong to the same renderer and point to the same scene object instance.
 
Pluginoperator= (const Plugin &plugin) noexcept
 Assign from another Plugin. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
 
bool operator== (const Plugin &plugin) const noexcept
 Returns true if both Plugins belong to the same renderer and point to the same scene object instance.
 
bool setArray (const char *propertyName, const char *const data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const char *propertyName, const Color data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const double data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const float data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const int data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const std::string data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const Transform data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const Value values[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, const Vector data[], size_t count, double time=TiMe::Default())
 
bool setArray (const char *propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
 
bool setArray (const std::string &propertyName, const char *const data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const Color data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const double data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const float data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const int data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const std::string data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const Transform data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const Value values[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, const Vector data[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArray (const std::string &propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setArrayAtTime (const char *propertyName, const Color data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const double data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const float data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const int data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const Plugin data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const std::string data[], size_t count, double time)
 
bool setArrayAtTime (const char *propertyName, const Vector data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const Color data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const double data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const float data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const int data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const Plugin data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const std::string data[], size_t count, double time)
 
bool setArrayAtTime (const std::string &propertyName, const Vector data[], size_t count, double time)
 
bool setName (const char *newName)
 
bool setName (const std::string &newName)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, ColorList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, const AColor &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const bool value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const char *str, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const Color &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const ColorList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const double value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const float value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const FloatList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const int value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const IntList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const Matrix &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const PluginList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const std::string &str, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const StringList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const Transform &transform, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const TransformList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const Value &value, double time=TiMe::Default())
 
template<size_t count>
bool setValue (const char *propertyName, const Value(&arr)[count], double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, const ValueList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const Vector &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const VectorList &value, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const void *data, size_t size, double time=TiMe::Default())
 
bool setValue (const char *propertyName, const VUtils::CharString &str)
 
bool setValue (const char *propertyName, const VUtils::CharStringRefList &stringList)
 
bool setValue (const char *propertyName, const VUtils::ColorRefList &colorList)
 
bool setValue (const char *propertyName, const VUtils::FloatRefList &floatList)
 
bool setValue (const char *propertyName, const VUtils::IntRefList &intList)
 
bool setValue (const char *propertyName, const VUtils::TransformRefList &transformList)
 
bool setValue (const char *propertyName, const VUtils::ValueRefList &valueList)
 
bool setValue (const char *propertyName, const VUtils::VectorRefList &vectorList)
 
bool setValue (const char *propertyName, FloatList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, IntList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, Value &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<size_t count>
bool setValue (const char *propertyName, Value(&&arr)[count], double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, ValueList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const char *propertyName, VectorList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, ColorList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const AColor &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const bool value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const char *str, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const Color &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const ColorList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const double value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const float value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const FloatList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const int value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const IntList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const Matrix &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const PluginList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const std::string &str, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const StringList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const Transform &transform, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const TransformList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const Value &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<size_t count>
bool setValue (const std::string &propertyName, const Value(&arr)[count], double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const ValueList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const Vector &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const VectorList &value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const void *data, size_t size, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, const VUtils::CharString &str)
 
bool setValue (const std::string &propertyName, const VUtils::CharStringRefList &stringList)
 
bool setValue (const std::string &propertyName, const VUtils::ColorRefList &colorList)
 
bool setValue (const std::string &propertyName, const VUtils::FloatRefList &floatList)
 
bool setValue (const std::string &propertyName, const VUtils::IntRefList &intList)
 
bool setValue (const std::string &propertyName, const VUtils::TransformRefList &transformList)
 
bool setValue (const std::string &propertyName, const VUtils::ValueRefList &valueList)
 
bool setValue (const std::string &propertyName, const VUtils::VectorRefList &vectorList)
 
bool setValue (const std::string &propertyName, FloatList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, IntList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, Value &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<size_t count>
bool setValue (const std::string &propertyName, Value(&&arr)[count], double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, ValueList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValue (const std::string &propertyName, VectorList &&value, double time=TiMe::Default())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValueAsString (const char *propertyName, const char *value)
 
bool setValueAsString (const char *propertyName, const std::string &value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValueAsString (const std::string &propertyName, const char *value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValueAsString (const std::string &propertyName, const std::string &value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool setValueAsStringAtTime (const char *propertyName, const char *value, double time)
 
bool setValueAsStringAtTime (const char *propertyName, const std::string &value, double time)
 
bool setValueAsStringAtTime (const std::string &propertyName, const char *value, double time)
 
bool setValueAsStringAtTime (const std::string &propertyName, const std::string &value, double time)
 
bool setValueAtTime (const char *propertyName, const AColor &value, double time)
 
bool setValueAtTime (const char *propertyName, const bool value, double time)
 
bool setValueAtTime (const char *propertyName, const char *str, double time)
 
bool setValueAtTime (const char *propertyName, const Color &value, double time)
 
bool setValueAtTime (const char *propertyName, const ColorList &value, double time)
 
bool setValueAtTime (const char *propertyName, const double value, double time)
 
bool setValueAtTime (const char *propertyName, const float value, double time)
 
bool setValueAtTime (const char *propertyName, const FloatList &value, double time)
 
bool setValueAtTime (const char *propertyName, const int value, double time)
 
bool setValueAtTime (const char *propertyName, const IntList &value, double time)
 
bool setValueAtTime (const char *propertyName, const Matrix &value, double time)
 
bool setValueAtTime (const char *propertyName, const PluginList &value, double time)
 
bool setValueAtTime (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time)
 
bool setValueAtTime (const char *propertyName, const std::string &str, double time)
 
bool setValueAtTime (const char *propertyName, const StringList &value, double time)
 
bool setValueAtTime (const char *propertyName, const Transform &transform, double time)
 
bool setValueAtTime (const char *propertyName, const Value &value, double time)
 
bool setValueAtTime (const char *propertyName, const ValueList &value, double time)
 
bool setValueAtTime (const char *propertyName, const Vector &value, double time)
 
bool setValueAtTime (const char *propertyName, const VectorList &value, double time)
 
bool setValueAtTime (const char *propertyName, const void *data, size_t size, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::CharString &str, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::CharStringRefList &stringList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::ColorRefList &colorList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::FloatRefList &floatList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::IntRefList &intList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::TransformRefList &transformList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::ValueRefList &valueList, double time)
 
bool setValueAtTime (const char *propertyName, const VUtils::VectorRefList &vectorList, double time)
 
bool setValueAtTime (const std::string &propertyName, const AColor &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const bool value, double time)
 
bool setValueAtTime (const std::string &propertyName, const char *str, double time)
 
bool setValueAtTime (const std::string &propertyName, const Color &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const ColorList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const double value, double time)
 
bool setValueAtTime (const std::string &propertyName, const float value, double time)
 
bool setValueAtTime (const std::string &propertyName, const FloatList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const int value, double time)
 
bool setValueAtTime (const std::string &propertyName, const IntList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const Matrix &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const PluginList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time)
 
bool setValueAtTime (const std::string &propertyName, const std::string &str, double time)
 
bool setValueAtTime (const std::string &propertyName, const StringList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const Transform &transform, double time)
 
bool setValueAtTime (const std::string &propertyName, const Value &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const ValueList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const Vector &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const VectorList &value, double time)
 
bool setValueAtTime (const std::string &propertyName, const void *data, size_t size, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::CharString &str, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::CharStringRefList &stringList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::ColorRefList &colorList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::FloatRefList &floatList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::IntRefList &intList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::TransformRefList &transformList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::ValueRefList &valueList, double time)
 
bool setValueAtTime (const std::string &propertyName, const VUtils::VectorRefList &vectorList, double time)
 
void swap (Plugin &plugin) noexcept
 Swaps the underlying scene object instance reference and associated renderer reference.
 
std::string toString () const
 Returns a string representation of the plugin which currently is the name of the plugin.
 

Static Public Member Functions

static constexpr const char * getType ()
 Return the name of the plugin type.
 
static constexpr const PluginTypeId getTypeId ()
 Plugin type ID.
 

Additional Inherited Members

- Protected Member Functions inherited from VRay::Plugin
 Plugin (VRayRenderer &renderer, const char *name)
 
 Plugin (VRayRenderer &renderer, InstanceId id) noexcept
 
 Plugin (VRayRenderer &renderer, InstanceId id, int typeIdIdx) noexcept
 
 Plugin (VRayRenderer &renderer, InstanceId id, PluginTypeId typeId) noexcept
 
InstanceId id () const
 
template<typename T , int TYPE>
bool setArrayAtTimeTemplate (const char *propertyName, size_t count, const T &value, double time)
 
template<typename LengthFn , typename PointerFn >
bool setStringArrayTemplate (const char *propertyName, size_t count, LengthFn lengthAt, PointerFn pointerAt, double time)
 
template<typename T , int TYPE>
bool setValueAtTimeTemplate (const char *propertyName, const T &value, double time)
 
- Protected Attributes inherited from VRay::Plugin
InstanceId internalId
 
const VRayRendererpRenderer
 

Detailed Description

Defines a physical camera when present in the scene. Affects DoF, exposure, motion blur etc. [gpuSupport=(partial)].

Member Function Documentation

◆ get_anisotropy()

float VRay::Plugins::CameraPhysical::get_anisotropy ( double  time = TiMe::Default()) const
inline

Bokeh anisotropy [UI Guides] minValue=-1, maxValue=1, gpuSupport=full [Default value] 0

◆ get_blades_enable()

bool VRay::Plugins::CameraPhysical::get_blades_enable ( double  time = TiMe::Default()) const
inline

Set to true to enable Bokeh effects [UI Guides] gpuSupport=full [Default value] 0

◆ get_blades_num()

int VRay::Plugins::CameraPhysical::get_blades_num ( double  time = TiMe::Default()) const
inline

Number of blades - 0 disables Bokeh [UI Guides] enableIf: ?blades_enable=1, minValue=2, maxValue=20, gpuSupport=full [Default value] 5

◆ get_blades_rotation()

float VRay::Plugins::CameraPhysical::get_blades_rotation ( double  time = TiMe::Default()) const
inline

Blade rotation in radians [UI Guides] gpuSupport=full [Default value] 0

◆ get_bmpaperture_affects_exposure()

bool VRay::Plugins::CameraPhysical::get_bmpaperture_affects_exposure ( double  time = TiMe::Default()) const
inline

This will make the Bitmap Aperture's size and shape affect the exposure [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap affects exposure, gpuSupport=full [Default value] 1

◆ get_bmpaperture_enable()

bool VRay::Plugins::CameraPhysical::get_bmpaperture_enable ( double  time = TiMe::Default()) const
inline

Set to true to enable the use of bitmap aperture [UI Guides] displayName=Bitmap aperture, minValue=1, maxValue=2048, gpuSupport=full [Default value] 0

◆ get_bmpaperture_resolution()

int VRay::Plugins::CameraPhysical::get_bmpaperture_resolution ( double  time = TiMe::Default()) const
inline

Texture sampling resolution for the importance sampling [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap resolution, gpuSupport=full [Default value] 512

◆ get_bmpaperture_tex()

Value VRay::Plugins::CameraPhysical::get_bmpaperture_tex ( double  time = TiMe::Default()) const
inline

Aperture texture to use when bmpaperture_enable=1. The aperture is open where the texture is white. [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap aperture texture, attributes=textureSlot, gpuSupport=full

◆ get_camera_shader_tex()

Value VRay::Plugins::CameraPhysical::get_camera_shader_tex ( double  time = TiMe::Default()) const
inline

Camera shader [UI Guides] displayName=Camera shader texture, attributes=textureSlot, gpuSupport=full

◆ get_center_bias()

float VRay::Plugins::CameraPhysical::get_center_bias ( double  time = TiMe::Default()) const
inline

Bias toward the center of the lens for DOF sampling [UI Guides] minValue=-100, maxValue=100, gpuSupport=full [Default value] 0

◆ get_distortion()

float VRay::Plugins::CameraPhysical::get_distortion ( double  time = TiMe::Default()) const
inline

Distortion amount [UI Guides] enableIf: ?distortion_type=0; ?distortion_type=1, gpuSupport=full [Default value] 0

◆ get_distortion_tex()

Value VRay::Plugins::CameraPhysical::get_distortion_tex ( double  time = TiMe::Default()) const
inline

Distortion texture to use when distortion_type=3. Values are in image space - (0,0) maps to bottom left, (1,1) maps to top right. [UI Guides] displayName=Distortion texture, enableIf: ?distortion_type=3, gpuSupport=none

◆ get_distortion_type()

int VRay::Plugins::CameraPhysical::get_distortion_type ( double  time = TiMe::Default()) const
inline

Type of optical distortion (0 - Quadratic, 1 - Cubic, 2 - Lens file, 3 - Texture) [UI Guides] enum=0:Quadratic;1:Cubic;2:Lens file;3:Texture, gpuSupport=partial [Default value] 0

◆ get_dof_display_threshold()

float VRay::Plugins::CameraPhysical::get_dof_display_threshold ( double  time = TiMe::Default()) const
inline

Display threshold for depth-of-field [UI Guides] gpuSupport=none [Default value] 0.001

◆ get_dont_affect_settings()

bool VRay::Plugins::CameraPhysical::get_dont_affect_settings ( double  time = TiMe::Default()) const
inline

This is here so we can suppress a PhysicalCamera node from affecting the main VRayRenderer sequence and frame data. [UI Guides] gpuSupport=full [Default value] 0

◆ get_enable_thin_lens_equation()

bool VRay::Plugins::CameraPhysical::get_enable_thin_lens_equation ( double  time = TiMe::Default()) const
inline

Determine if the focus distance will affect the fov or focal length calculation due to thin lens equation [UI Guides] displayName=Enable thin lens equation, gpuSupport=none [Default value] 1

◆ get_exposure()

int VRay::Plugins::CameraPhysical::get_exposure ( double  time = TiMe::Default()) const
inline

0 - disable exposure color correction; 1 - physical exposure color correction; 2 - exposure color correction from exposure value [UI Guides] enum=0:No exposure;1:Physical Exposure;2:Exposure Value, gpuSupport=full [Default value] 1

◆ get_exposure_value()

float VRay::Plugins::CameraPhysical::get_exposure_value ( double  time = TiMe::Default()) const
inline

Exposure value to use with exposure mode 2 [UI Guides] displayName=Exposure value, enableIf: ?exposure=2, gpuSupport=full [Default value] 0

◆ get_f_number()

float VRay::Plugins::CameraPhysical::get_f_number ( double  time = TiMe::Default()) const
inline

F-stop [UI Guides] displayName=F-stop, minValue=0.01, gpuSupport=full [Default value] 8

◆ get_film_width()

float VRay::Plugins::CameraPhysical::get_film_width ( double  time = TiMe::Default()) const
inline

Film gate in mm [UI Guides] minValue=0, gpuSupport=full [Default value] 36

◆ get_focal_length()

float VRay::Plugins::CameraPhysical::get_focal_length ( double  time = TiMe::Default()) const
inline

Focal length in mm [UI Guides] minValue=0, gpuSupport=full [Default value] 40

◆ get_focus_distance()

float VRay::Plugins::CameraPhysical::get_focus_distance ( double  time = TiMe::Default()) const
inline

Focus distance in world units (if specify_focus=1). Affects the lens light attenuation and thin lens model. [UI Guides] enableIf: ?specify_focus=1, quantityType=distance, minValue=0, gpuSupport=full [Default value] 200

◆ get_fov()

float VRay::Plugins::CameraPhysical::get_fov ( double  time = TiMe::Default()) const
inline

The FOV value (in radians) to use when specify_fov is true [UI Guides] enableIf: ?specify_fov=1, gpuSupport=full [Default value] 1.5708

◆ get_horizontal_offset()

float VRay::Plugins::CameraPhysical::get_horizontal_offset ( double  time = TiMe::Default()) const
inline

The horizontal offset [UI Guides] displayName=Horizontal shift, gpuSupport=full [Default value] 0

◆ get_horizontal_shift()

float VRay::Plugins::CameraPhysical::get_horizontal_shift ( double  time = TiMe::Default()) const
inline

The horizontal lens shift [UI Guides] displayName=Horizontal tilt, gpuSupport=full [Default value] 0

◆ get_ISO()

float VRay::Plugins::CameraPhysical::get_ISO ( double  time = TiMe::Default()) const
inline

Sensor sensitivity (unbounded) [UI Guides] minValue=0, enableIf: ?exposure=1, gpuSupport=none [Default value] 200

◆ get_latency()

float VRay::Plugins::CameraPhysical::get_latency ( double  time = TiMe::Default()) const
inline

Shutter latency in seconds for video camera [UI Guides] enableIf: ?type=2, gpuSupport=none [Default value] 0

◆ get_lens_file()

std::string VRay::Plugins::CameraPhysical::get_lens_file ( double  time = TiMe::Default()) const
inline

LENS file with camera lens-type image distortion description [UI Guides] fileAsset=vrlens, enableIf: ?distortion_type=2, gpuSupport=full [Default value]

◆ get_lens_shift()

float VRay::Plugins::CameraPhysical::get_lens_shift ( double  time = TiMe::Default()) const
inline

Lens shift [UI Guides] displayName=Vertical tilt, gpuSupport=full [Default value] 0

◆ get_optical_vignetting()

float VRay::Plugins::CameraPhysical::get_optical_vignetting ( double  time = TiMe::Default()) const
inline

Optical vignetting ("cat's eye bokeh") amount [UI Guides] minValue=-3, maxValue=3, gpuSupport=full [Default value] 0

◆ get_rolling_shutter_duration()

float VRay::Plugins::CameraPhysical::get_rolling_shutter_duration ( double  time = TiMe::Default()) const
inline

Rolling shutter duration (the time for the shutter to pass through the image) in seconds^-1 [UI Guides] displayName=Rolling shutter speed, enableIf: ?use_moblur!=0, ?rolling_shutter_mode!=0, minValue=0, gpuSupport=full [Default value] 200

◆ get_rolling_shutter_mode()

int VRay::Plugins::CameraPhysical::get_rolling_shutter_mode ( double  time = TiMe::Default()) const
inline

Rolling shutter mode: 0=Disabled, 1=Top to bottom, 2=Bottom to top, 3=Left to right, 4=Right to left [UI Guides] enableIf: ?use_moblur!=0, enum=0:Disabled;1:Top to bottom;2:Bottom to top;3:Left to right;4:Right to left, gpuSupport=full [Default value] 0

◆ get_scene_name()

std::string VRay::Plugins::CameraPhysical::get_scene_name ( double  time = TiMe::Default()) const
inline

The original scene name of the camera associated with the plugin [UI Guides] displayName=Scene name, gpuSupport=full [Default value]

◆ get_shutter_angle()

float VRay::Plugins::CameraPhysical::get_shutter_angle ( double  time = TiMe::Default()) const
inline

Shutter angle in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=0, maxValue=360, gpuSupport=full [Default value] 180

◆ get_shutter_offset()

float VRay::Plugins::CameraPhysical::get_shutter_offset ( double  time = TiMe::Default()) const
inline

Shutter offset in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=-360, maxValue=360, gpuSupport=full [Default value] 0

◆ get_shutter_speed()

float VRay::Plugins::CameraPhysical::get_shutter_speed ( double  time = TiMe::Default()) const
inline

The shutter speed in seconds^-1 for still camera [UI Guides] enableIf: ?type=0, minValue=0, gpuSupport=full [Default value] 300

◆ get_specify_focus()

bool VRay::Plugins::CameraPhysical::get_specify_focus ( double  time = TiMe::Default()) const
inline

Set to true to enable the focus_distance parameter [UI Guides] gpuSupport=full [Default value] 0

◆ get_specify_fov()

bool VRay::Plugins::CameraPhysical::get_specify_fov ( double  time = TiMe::Default()) const
inline

Set to true to use explicit field of view from the "fov" value and false to use the focal length [UI Guides] gpuSupport=full [Default value] 0

◆ get_subdivs()

int VRay::Plugins::CameraPhysical::get_subdivs ( double  time = TiMe::Default()) const
inline

Deprecated. This has no effect. [UI Guides] gpuSupport=none [Default value] 1

◆ get_target_distance()

float VRay::Plugins::CameraPhysical::get_target_distance ( double  time = TiMe::Default()) const
inline

Target distance (if specify_focus=0). Affects only the distance of the focal plane. [UI Guides] enableIf: ?specify_focus=0, quantityType=distance, minValue=0, gpuSupport=full [Default value] 200

◆ get_targeted()

bool VRay::Plugins::CameraPhysical::get_targeted ( double  time = TiMe::Default()) const
inline

Has no effect. Target distance is used when the focus distance is not used (if specify_focus=0). [UI Guides] gpuSupport=full [Default value] 1

◆ get_type()

int VRay::Plugins::CameraPhysical::get_type ( double  time = TiMe::Default()) const
inline

This defines how the shutter works (0 - Still camera, 1 - Movie camera, 2 - Video camera [UI Guides] enum=0:Still;1:Movie;2:Video, minValue=0, gpuSupport=partial [Default value] 0

◆ get_use_dof()

bool VRay::Plugins::CameraPhysical::get_use_dof ( double  time = TiMe::Default()) const
inline

Set to true to enable raytraced depth of field effect [UI Guides] displayName=Enable DOF, gpuSupport=full [Default value] 0

◆ get_use_moblur()

bool VRay::Plugins::CameraPhysical::get_use_moblur ( double  time = TiMe::Default()) const
inline

Set to true to enable motion blur [UI Guides] displayName=Enable Motion Blur, gpuSupport=full [Default value] 0

◆ get_vertical_offset()

float VRay::Plugins::CameraPhysical::get_vertical_offset ( double  time = TiMe::Default()) const
inline

The vertical offset [UI Guides] displayName=Vertical shift, gpuSupport=full [Default value] 0

◆ get_vignetting()

float VRay::Plugins::CameraPhysical::get_vignetting ( double  time = TiMe::Default()) const
inline

Strength of vignetting effect [UI Guides] minValue=0, gpuSupport=full [Default value] 1

◆ get_white_balance()

Color VRay::Plugins::CameraPhysical::get_white_balance ( double  time = TiMe::Default()) const
inline

White point color [UI Guides] gpuSupport=full [Default value] Color(1, 1, 1)

◆ get_zoom_factor()

float VRay::Plugins::CameraPhysical::get_zoom_factor ( double  time = TiMe::Default()) const
inline

Zoom factor [UI Guides] minValue=0, gpuSupport=full [Default value] 1

◆ set_anisotropy()

bool VRay::Plugins::CameraPhysical::set_anisotropy ( float  val,
double  time = TiMe::Default() 
)
inline

Bokeh anisotropy [UI Guides] minValue=-1, maxValue=1, gpuSupport=full [Default value] 0

◆ set_blades_enable()

bool VRay::Plugins::CameraPhysical::set_blades_enable ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to enable Bokeh effects [UI Guides] gpuSupport=full [Default value] 0

◆ set_blades_num()

bool VRay::Plugins::CameraPhysical::set_blades_num ( int  val,
double  time = TiMe::Default() 
)
inline

Number of blades - 0 disables Bokeh [UI Guides] enableIf: ?blades_enable=1, minValue=2, maxValue=20, gpuSupport=full [Default value] 5

◆ set_blades_rotation()

bool VRay::Plugins::CameraPhysical::set_blades_rotation ( float  val,
double  time = TiMe::Default() 
)
inline

Blade rotation in radians [UI Guides] gpuSupport=full [Default value] 0

◆ set_bmpaperture_affects_exposure()

bool VRay::Plugins::CameraPhysical::set_bmpaperture_affects_exposure ( bool  val,
double  time = TiMe::Default() 
)
inline

This will make the Bitmap Aperture's size and shape affect the exposure [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap affects exposure, gpuSupport=full [Default value] 1

◆ set_bmpaperture_enable()

bool VRay::Plugins::CameraPhysical::set_bmpaperture_enable ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to enable the use of bitmap aperture [UI Guides] displayName=Bitmap aperture, minValue=1, maxValue=2048, gpuSupport=full [Default value] 0

◆ set_bmpaperture_resolution()

bool VRay::Plugins::CameraPhysical::set_bmpaperture_resolution ( int  val,
double  time = TiMe::Default() 
)
inline

Texture sampling resolution for the importance sampling [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap resolution, gpuSupport=full [Default value] 512

◆ set_bmpaperture_tex() [1/2]

bool VRay::Plugins::CameraPhysical::set_bmpaperture_tex ( const AColor texture,
double  time = TiMe::Default() 
)
inline

Aperture texture to use when bmpaperture_enable=1. The aperture is open where the texture is white. [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap aperture texture, attributes=textureSlot, gpuSupport=full

◆ set_bmpaperture_tex() [2/2]

bool VRay::Plugins::CameraPhysical::set_bmpaperture_tex ( const PluginRef texture,
double  time = TiMe::Default() 
)
inline

Aperture texture to use when bmpaperture_enable=1. The aperture is open where the texture is white. [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap aperture texture, attributes=textureSlot, gpuSupport=full

◆ set_camera_shader_tex() [1/2]

bool VRay::Plugins::CameraPhysical::set_camera_shader_tex ( const AColor texture,
double  time = TiMe::Default() 
)
inline

Camera shader [UI Guides] displayName=Camera shader texture, attributes=textureSlot, gpuSupport=full

◆ set_camera_shader_tex() [2/2]

bool VRay::Plugins::CameraPhysical::set_camera_shader_tex ( const PluginRef texture,
double  time = TiMe::Default() 
)
inline

Camera shader [UI Guides] displayName=Camera shader texture, attributes=textureSlot, gpuSupport=full

◆ set_center_bias()

bool VRay::Plugins::CameraPhysical::set_center_bias ( float  val,
double  time = TiMe::Default() 
)
inline

Bias toward the center of the lens for DOF sampling [UI Guides] minValue=-100, maxValue=100, gpuSupport=full [Default value] 0

◆ set_distortion()

bool VRay::Plugins::CameraPhysical::set_distortion ( float  val,
double  time = TiMe::Default() 
)
inline

Distortion amount [UI Guides] enableIf: ?distortion_type=0; ?distortion_type=1, gpuSupport=full [Default value] 0

◆ set_distortion_tex() [1/2]

bool VRay::Plugins::CameraPhysical::set_distortion_tex ( const AColor texture,
double  time = TiMe::Default() 
)
inline

Distortion texture to use when distortion_type=3. Values are in image space - (0,0) maps to bottom left, (1,1) maps to top right. [UI Guides] displayName=Distortion texture, enableIf: ?distortion_type=3, gpuSupport=none

◆ set_distortion_tex() [2/2]

bool VRay::Plugins::CameraPhysical::set_distortion_tex ( const PluginRef texture,
double  time = TiMe::Default() 
)
inline

Distortion texture to use when distortion_type=3. Values are in image space - (0,0) maps to bottom left, (1,1) maps to top right. [UI Guides] displayName=Distortion texture, enableIf: ?distortion_type=3, gpuSupport=none

◆ set_distortion_type()

bool VRay::Plugins::CameraPhysical::set_distortion_type ( int  val,
double  time = TiMe::Default() 
)
inline

Type of optical distortion (0 - Quadratic, 1 - Cubic, 2 - Lens file, 3 - Texture) [UI Guides] enum=0:Quadratic;1:Cubic;2:Lens file;3:Texture, gpuSupport=partial [Default value] 0

◆ set_dof_display_threshold()

bool VRay::Plugins::CameraPhysical::set_dof_display_threshold ( float  val,
double  time = TiMe::Default() 
)
inline

Display threshold for depth-of-field [UI Guides] gpuSupport=none [Default value] 0.001

◆ set_dont_affect_settings()

bool VRay::Plugins::CameraPhysical::set_dont_affect_settings ( bool  val,
double  time = TiMe::Default() 
)
inline

This is here so we can suppress a PhysicalCamera node from affecting the main VRayRenderer sequence and frame data. [UI Guides] gpuSupport=full [Default value] 0

◆ set_enable_thin_lens_equation()

bool VRay::Plugins::CameraPhysical::set_enable_thin_lens_equation ( bool  val,
double  time = TiMe::Default() 
)
inline

Determine if the focus distance will affect the fov or focal length calculation due to thin lens equation [UI Guides] displayName=Enable thin lens equation, gpuSupport=none [Default value] 1

◆ set_exposure()

bool VRay::Plugins::CameraPhysical::set_exposure ( int  val,
double  time = TiMe::Default() 
)
inline

0 - disable exposure color correction; 1 - physical exposure color correction; 2 - exposure color correction from exposure value [UI Guides] enum=0:No exposure;1:Physical Exposure;2:Exposure Value, gpuSupport=full [Default value] 1

◆ set_exposure_value()

bool VRay::Plugins::CameraPhysical::set_exposure_value ( float  val,
double  time = TiMe::Default() 
)
inline

Exposure value to use with exposure mode 2 [UI Guides] displayName=Exposure value, enableIf: ?exposure=2, gpuSupport=full [Default value] 0

◆ set_f_number()

bool VRay::Plugins::CameraPhysical::set_f_number ( float  val,
double  time = TiMe::Default() 
)
inline

F-stop [UI Guides] displayName=F-stop, minValue=0.01, gpuSupport=full [Default value] 8

◆ set_film_width()

bool VRay::Plugins::CameraPhysical::set_film_width ( float  val,
double  time = TiMe::Default() 
)
inline

Film gate in mm [UI Guides] minValue=0, gpuSupport=full [Default value] 36

◆ set_focal_length()

bool VRay::Plugins::CameraPhysical::set_focal_length ( float  val,
double  time = TiMe::Default() 
)
inline

Focal length in mm [UI Guides] minValue=0, gpuSupport=full [Default value] 40

◆ set_focus_distance()

bool VRay::Plugins::CameraPhysical::set_focus_distance ( float  val,
double  time = TiMe::Default() 
)
inline

Focus distance in world units (if specify_focus=1). Affects the lens light attenuation and thin lens model. [UI Guides] enableIf: ?specify_focus=1, quantityType=distance, minValue=0, gpuSupport=full [Default value] 200

◆ set_fov()

bool VRay::Plugins::CameraPhysical::set_fov ( float  val,
double  time = TiMe::Default() 
)
inline

The FOV value (in radians) to use when specify_fov is true [UI Guides] enableIf: ?specify_fov=1, gpuSupport=full [Default value] 1.5708

◆ set_horizontal_offset()

bool VRay::Plugins::CameraPhysical::set_horizontal_offset ( float  val,
double  time = TiMe::Default() 
)
inline

The horizontal offset [UI Guides] displayName=Horizontal shift, gpuSupport=full [Default value] 0

◆ set_horizontal_shift()

bool VRay::Plugins::CameraPhysical::set_horizontal_shift ( float  val,
double  time = TiMe::Default() 
)
inline

The horizontal lens shift [UI Guides] displayName=Horizontal tilt, gpuSupport=full [Default value] 0

◆ set_ISO()

bool VRay::Plugins::CameraPhysical::set_ISO ( float  val,
double  time = TiMe::Default() 
)
inline

Sensor sensitivity (unbounded) [UI Guides] minValue=0, enableIf: ?exposure=1, gpuSupport=none [Default value] 200

◆ set_latency()

bool VRay::Plugins::CameraPhysical::set_latency ( float  val,
double  time = TiMe::Default() 
)
inline

Shutter latency in seconds for video camera [UI Guides] enableIf: ?type=2, gpuSupport=none [Default value] 0

◆ set_lens_file() [1/2]

bool VRay::Plugins::CameraPhysical::set_lens_file ( const char *  str,
double  time = TiMe::Default() 
)
inline

LENS file with camera lens-type image distortion description [UI Guides] fileAsset=vrlens, enableIf: ?distortion_type=2, gpuSupport=full [Default value]

◆ set_lens_file() [2/2]

bool VRay::Plugins::CameraPhysical::set_lens_file ( const std::string &  str,
double  time = TiMe::Default() 
)
inline

LENS file with camera lens-type image distortion description [UI Guides] fileAsset=vrlens, enableIf: ?distortion_type=2, gpuSupport=full [Default value]

◆ set_lens_shift()

bool VRay::Plugins::CameraPhysical::set_lens_shift ( float  val,
double  time = TiMe::Default() 
)
inline

Lens shift [UI Guides] displayName=Vertical tilt, gpuSupport=full [Default value] 0

◆ set_optical_vignetting()

bool VRay::Plugins::CameraPhysical::set_optical_vignetting ( float  val,
double  time = TiMe::Default() 
)
inline

Optical vignetting ("cat's eye bokeh") amount [UI Guides] minValue=-3, maxValue=3, gpuSupport=full [Default value] 0

◆ set_rolling_shutter_duration()

bool VRay::Plugins::CameraPhysical::set_rolling_shutter_duration ( float  val,
double  time = TiMe::Default() 
)
inline

Rolling shutter duration (the time for the shutter to pass through the image) in seconds^-1 [UI Guides] displayName=Rolling shutter speed, enableIf: ?use_moblur!=0, ?rolling_shutter_mode!=0, minValue=0, gpuSupport=full [Default value] 200

◆ set_rolling_shutter_mode()

bool VRay::Plugins::CameraPhysical::set_rolling_shutter_mode ( int  val,
double  time = TiMe::Default() 
)
inline

Rolling shutter mode: 0=Disabled, 1=Top to bottom, 2=Bottom to top, 3=Left to right, 4=Right to left [UI Guides] enableIf: ?use_moblur!=0, enum=0:Disabled;1:Top to bottom;2:Bottom to top;3:Left to right;4:Right to left, gpuSupport=full [Default value] 0

◆ set_scene_name() [1/2]

bool VRay::Plugins::CameraPhysical::set_scene_name ( const char *  str,
double  time = TiMe::Default() 
)
inline

The original scene name of the camera associated with the plugin [UI Guides] displayName=Scene name, gpuSupport=full [Default value]

◆ set_scene_name() [2/2]

bool VRay::Plugins::CameraPhysical::set_scene_name ( const std::string &  str,
double  time = TiMe::Default() 
)
inline

The original scene name of the camera associated with the plugin [UI Guides] displayName=Scene name, gpuSupport=full [Default value]

◆ set_shutter_angle()

bool VRay::Plugins::CameraPhysical::set_shutter_angle ( float  val,
double  time = TiMe::Default() 
)
inline

Shutter angle in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=0, maxValue=360, gpuSupport=full [Default value] 180

◆ set_shutter_offset()

bool VRay::Plugins::CameraPhysical::set_shutter_offset ( float  val,
double  time = TiMe::Default() 
)
inline

Shutter offset in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=-360, maxValue=360, gpuSupport=full [Default value] 0

◆ set_shutter_speed()

bool VRay::Plugins::CameraPhysical::set_shutter_speed ( float  val,
double  time = TiMe::Default() 
)
inline

The shutter speed in seconds^-1 for still camera [UI Guides] enableIf: ?type=0, minValue=0, gpuSupport=full [Default value] 300

◆ set_specify_focus()

bool VRay::Plugins::CameraPhysical::set_specify_focus ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to enable the focus_distance parameter [UI Guides] gpuSupport=full [Default value] 0

◆ set_specify_fov()

bool VRay::Plugins::CameraPhysical::set_specify_fov ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to use explicit field of view from the "fov" value and false to use the focal length [UI Guides] gpuSupport=full [Default value] 0

◆ set_subdivs()

bool VRay::Plugins::CameraPhysical::set_subdivs ( int  val,
double  time = TiMe::Default() 
)
inline

Deprecated. This has no effect. [UI Guides] gpuSupport=none [Default value] 1

◆ set_target_distance()

bool VRay::Plugins::CameraPhysical::set_target_distance ( float  val,
double  time = TiMe::Default() 
)
inline

Target distance (if specify_focus=0). Affects only the distance of the focal plane. [UI Guides] enableIf: ?specify_focus=0, quantityType=distance, minValue=0, gpuSupport=full [Default value] 200

◆ set_targeted()

bool VRay::Plugins::CameraPhysical::set_targeted ( bool  val,
double  time = TiMe::Default() 
)
inline

Has no effect. Target distance is used when the focus distance is not used (if specify_focus=0). [UI Guides] gpuSupport=full [Default value] 1

◆ set_type()

bool VRay::Plugins::CameraPhysical::set_type ( int  val,
double  time = TiMe::Default() 
)
inline

This defines how the shutter works (0 - Still camera, 1 - Movie camera, 2 - Video camera [UI Guides] enum=0:Still;1:Movie;2:Video, minValue=0, gpuSupport=partial [Default value] 0

◆ set_use_dof()

bool VRay::Plugins::CameraPhysical::set_use_dof ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to enable raytraced depth of field effect [UI Guides] displayName=Enable DOF, gpuSupport=full [Default value] 0

◆ set_use_moblur()

bool VRay::Plugins::CameraPhysical::set_use_moblur ( bool  val,
double  time = TiMe::Default() 
)
inline

Set to true to enable motion blur [UI Guides] displayName=Enable Motion Blur, gpuSupport=full [Default value] 0

◆ set_vertical_offset()

bool VRay::Plugins::CameraPhysical::set_vertical_offset ( float  val,
double  time = TiMe::Default() 
)
inline

The vertical offset [UI Guides] displayName=Vertical shift, gpuSupport=full [Default value] 0

◆ set_vignetting()

bool VRay::Plugins::CameraPhysical::set_vignetting ( float  val,
double  time = TiMe::Default() 
)
inline

Strength of vignetting effect [UI Guides] minValue=0, gpuSupport=full [Default value] 1

◆ set_white_balance()

bool VRay::Plugins::CameraPhysical::set_white_balance ( const Color color,
double  time = TiMe::Default() 
)
inline

White point color [UI Guides] gpuSupport=full [Default value] Color(1, 1, 1)

◆ set_zoom_factor()

bool VRay::Plugins::CameraPhysical::set_zoom_factor ( float  val,
double  time = TiMe::Default() 
)
inline

Zoom factor [UI Guides] minValue=0, gpuSupport=full [Default value] 1


The documentation for this class was generated from the following file: