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...

Inherits VRay.Plugins.Plugin, VRay.Plugins.IPluginRef< CameraPhysical >, and VRay.Plugins.ISettingsPluginCategory.

Public Member Functions

float Get_Anisotropy (double time)
 Gets the value of CameraPhysical.Anisotropy More...
 
bool Get_BladesEnable (double time)
 Gets the value of CameraPhysical.BladesEnable More...
 
int Get_BladesNum (double time)
 Gets the value of CameraPhysical.BladesNum More...
 
float Get_BladesRotation (double time)
 Gets the value of CameraPhysical.BladesRotation More...
 
bool Get_BmpapertureAffectsExposure (double time)
 Gets the value of CameraPhysical.BmpapertureAffectsExposure More...
 
bool Get_BmpapertureEnable (double time)
 Gets the value of CameraPhysical.BmpapertureEnable More...
 
int Get_BmpapertureResolution (double time)
 Gets the value of CameraPhysical.BmpapertureResolution More...
 
object Get_BmpapertureTex (double time)
 Gets the value of CameraPhysical.BmpapertureTex More...
 
int Get_CameraPhysicalType (double time)
 Gets the value of CameraPhysical.CameraPhysicalType More...
 
object Get_CameraShaderTex (double time)
 Gets the value of CameraPhysical.CameraShaderTex More...
 
float Get_CenterBias (double time)
 Gets the value of CameraPhysical.CenterBias More...
 
float Get_Distortion (double time)
 Gets the value of CameraPhysical.Distortion More...
 
object Get_DistortionTex (double time)
 Gets the value of CameraPhysical.DistortionTex More...
 
int Get_DistortionType (double time)
 Gets the value of CameraPhysical.DistortionType More...
 
float Get_DofDisplayThreshold (double time)
 Gets the value of CameraPhysical.DofDisplayThreshold More...
 
bool Get_DontAffectSettings (double time)
 Gets the value of CameraPhysical.DontAffectSettings More...
 
bool Get_EnableThinLensEquation (double time)
 Gets the value of CameraPhysical.EnableThinLensEquation More...
 
int Get_Exposure (double time)
 Gets the value of CameraPhysical.Exposure More...
 
float Get_ExposureValue (double time)
 Gets the value of CameraPhysical.ExposureValue More...
 
float Get_FilmWidth (double time)
 Gets the value of CameraPhysical.FilmWidth More...
 
float Get_FNumber (double time)
 Gets the value of CameraPhysical.FNumber More...
 
float Get_FocalLength (double time)
 Gets the value of CameraPhysical.FocalLength More...
 
float Get_FocusDistance (double time)
 Gets the value of CameraPhysical.FocusDistance More...
 
float Get_Fov (double time)
 Gets the value of CameraPhysical.Fov More...
 
float Get_HorizontalOffset (double time)
 Gets the value of CameraPhysical.HorizontalOffset More...
 
float Get_HorizontalShift (double time)
 Gets the value of CameraPhysical.HorizontalShift More...
 
float Get_ISO (double time)
 Gets the value of CameraPhysical.ISO More...
 
float Get_Latency (double time)
 Gets the value of CameraPhysical.Latency More...
 
string Get_LensFile (double time)
 Gets the value of CameraPhysical.LensFile More...
 
float Get_LensShift (double time)
 Gets the value of CameraPhysical.LensShift More...
 
float Get_OpticalVignetting (double time)
 Gets the value of CameraPhysical.OpticalVignetting More...
 
float Get_RollingShutterDuration (double time)
 Gets the value of CameraPhysical.RollingShutterDuration More...
 
int Get_RollingShutterMode (double time)
 Gets the value of CameraPhysical.RollingShutterMode More...
 
string Get_SceneName (double time)
 Gets the value of CameraPhysical.SceneName More...
 
float Get_ShutterAngle (double time)
 Gets the value of CameraPhysical.ShutterAngle More...
 
float Get_ShutterOffset (double time)
 Gets the value of CameraPhysical.ShutterOffset More...
 
float Get_ShutterSpeed (double time)
 Gets the value of CameraPhysical.ShutterSpeed More...
 
bool Get_SpecifyFocus (double time)
 Gets the value of CameraPhysical.SpecifyFocus More...
 
bool Get_SpecifyFov (double time)
 Gets the value of CameraPhysical.SpecifyFov More...
 
int Get_Subdivs (double time)
 Gets the value of CameraPhysical.Subdivs More...
 
float Get_TargetDistance (double time)
 Gets the value of CameraPhysical.TargetDistance More...
 
bool Get_Targeted (double time)
 Gets the value of CameraPhysical.Targeted More...
 
bool Get_UseDof (double time)
 Gets the value of CameraPhysical.UseDof More...
 
bool Get_UseMoblur (double time)
 Gets the value of CameraPhysical.UseMoblur More...
 
float Get_VerticalOffset (double time)
 Gets the value of CameraPhysical.VerticalOffset More...
 
float Get_Vignetting (double time)
 Gets the value of CameraPhysical.Vignetting More...
 
Color Get_WhiteBalance (double time)
 Gets the value of CameraPhysical.WhiteBalance More...
 
float Get_ZoomFactor (double time)
 Gets the value of CameraPhysical.ZoomFactor More...
 
bool Set_Anisotropy (float val, double time)
 Sets a value to CameraPhysical.Anisotropy More...
 
bool Set_BladesEnable (bool val, double time)
 Sets a value to CameraPhysical.BladesEnable More...
 
bool Set_BladesNum (int val, double time)
 Sets a value to CameraPhysical.BladesNum More...
 
bool Set_BladesRotation (float val, double time)
 Sets a value to CameraPhysical.BladesRotation More...
 
bool Set_BmpapertureAffectsExposure (bool val, double time)
 Sets a value to CameraPhysical.BmpapertureAffectsExposure More...
 
bool Set_BmpapertureEnable (bool val, double time)
 Sets a value to CameraPhysical.BmpapertureEnable More...
 
bool Set_BmpapertureResolution (int val, double time)
 Sets a value to CameraPhysical.BmpapertureResolution More...
 
bool Set_BmpapertureTex (object val, double time)
 Sets a value to CameraPhysical.BmpapertureTex More...
 
bool Set_CameraPhysicalType (int val, double time)
 Sets a value to CameraPhysical.CameraPhysicalType More...
 
bool Set_CameraShaderTex (object val, double time)
 Sets a value to CameraPhysical.CameraShaderTex More...
 
bool Set_CenterBias (float val, double time)
 Sets a value to CameraPhysical.CenterBias More...
 
bool Set_Distortion (float val, double time)
 Sets a value to CameraPhysical.Distortion More...
 
bool Set_DistortionTex (object val, double time)
 Sets a value to CameraPhysical.DistortionTex More...
 
bool Set_DistortionType (int val, double time)
 Sets a value to CameraPhysical.DistortionType More...
 
bool Set_DofDisplayThreshold (float val, double time)
 Sets a value to CameraPhysical.DofDisplayThreshold More...
 
bool Set_DontAffectSettings (bool val, double time)
 Sets a value to CameraPhysical.DontAffectSettings More...
 
bool Set_EnableThinLensEquation (bool val, double time)
 Sets a value to CameraPhysical.EnableThinLensEquation More...
 
bool Set_Exposure (int val, double time)
 Sets a value to CameraPhysical.Exposure More...
 
bool Set_ExposureValue (float val, double time)
 Sets a value to CameraPhysical.ExposureValue More...
 
bool Set_FilmWidth (float val, double time)
 Sets a value to CameraPhysical.FilmWidth More...
 
bool Set_FNumber (float val, double time)
 Sets a value to CameraPhysical.FNumber More...
 
bool Set_FocalLength (float val, double time)
 Sets a value to CameraPhysical.FocalLength More...
 
bool Set_FocusDistance (float val, double time)
 Sets a value to CameraPhysical.FocusDistance More...
 
bool Set_Fov (float val, double time)
 Sets a value to CameraPhysical.Fov More...
 
bool Set_HorizontalOffset (float val, double time)
 Sets a value to CameraPhysical.HorizontalOffset More...
 
bool Set_HorizontalShift (float val, double time)
 Sets a value to CameraPhysical.HorizontalShift More...
 
bool Set_ISO (float val, double time)
 Sets a value to CameraPhysical.ISO More...
 
bool Set_Latency (float val, double time)
 Sets a value to CameraPhysical.Latency More...
 
bool Set_LensFile (string val, double time)
 Sets a value to CameraPhysical.LensFile More...
 
bool Set_LensShift (float val, double time)
 Sets a value to CameraPhysical.LensShift More...
 
bool Set_OpticalVignetting (float val, double time)
 Sets a value to CameraPhysical.OpticalVignetting More...
 
bool Set_RollingShutterDuration (float val, double time)
 Sets a value to CameraPhysical.RollingShutterDuration More...
 
bool Set_RollingShutterMode (int val, double time)
 Sets a value to CameraPhysical.RollingShutterMode More...
 
bool Set_SceneName (string val, double time)
 Sets a value to CameraPhysical.SceneName More...
 
bool Set_ShutterAngle (float val, double time)
 Sets a value to CameraPhysical.ShutterAngle More...
 
bool Set_ShutterOffset (float val, double time)
 Sets a value to CameraPhysical.ShutterOffset More...
 
bool Set_ShutterSpeed (float val, double time)
 Sets a value to CameraPhysical.ShutterSpeed More...
 
bool Set_SpecifyFocus (bool val, double time)
 Sets a value to CameraPhysical.SpecifyFocus More...
 
bool Set_SpecifyFov (bool val, double time)
 Sets a value to CameraPhysical.SpecifyFov More...
 
bool Set_Subdivs (int val, double time)
 Sets a value to CameraPhysical.Subdivs More...
 
bool Set_TargetDistance (float val, double time)
 Sets a value to CameraPhysical.TargetDistance More...
 
bool Set_Targeted (bool val, double time)
 Sets a value to CameraPhysical.Targeted More...
 
bool Set_UseDof (bool val, double time)
 Sets a value to CameraPhysical.UseDof More...
 
bool Set_UseMoblur (bool val, double time)
 Sets a value to CameraPhysical.UseMoblur More...
 
bool Set_VerticalOffset (float val, double time)
 Sets a value to CameraPhysical.VerticalOffset More...
 
bool Set_Vignetting (float val, double time)
 Sets a value to CameraPhysical.Vignetting More...
 
bool Set_WhiteBalance (Color val, double time)
 Sets a value to CameraPhysical.WhiteBalance More...
 
bool Set_ZoomFactor (float val, double time)
 Sets a value to CameraPhysical.ZoomFactor More...
 
- Public Member Functions inherited from VRay.Plugins.Plugin
PluginCategories GetCategories ()
 Gets all the plugin categories this plugin belongs to, such as being a Light or a Material, etc.
 
long GetIntegerID ()
 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.
 
double[] GetKeyframeTimes (string propertyName)
 Return an array of keyframe times if the property contains animated values or an empty array if the property is not animated. More...
 
PluginMeta GetMeta ()
 Gets a plugin meta object.
 
string GetName ()
 Gets the name of the plugin.
 
PropertyRuntimeMeta GetPropertyRuntimeMeta (string propertyName)
 Gets an object with runtime meta information about the property. More...
 
VRayRenderer GetRenderer ()
 Gets a reference to the renderer which created the plugin.
 
string Gettype ()
 Gets the type of the plugin. More...
 
object GetValue (string propertyName)
 Gets the value of the specified property as a generic object. More...
 
object GetValue (string propertyName, double time)
 Gets the value of the specified property as a generic object. More...
 
AColor GetValueAsAColor (string propertyName)
 Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...
 
AColor GetValueAsAColor (string propertyName, double time)
 Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...
 
bool GetValueAsBool (string propertyName)
 Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...
 
bool GetValueAsBool (string propertyName, double time)
 Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...
 
Color GetValueAsColor (string propertyName)
 Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...
 
Color GetValueAsColor (string propertyName, double time)
 Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...
 
double GetValueAsDouble (string propertyName)
 Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...
 
double GetValueAsDouble (string propertyName, double time)
 Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...
 
float GetValueAsFloat (string propertyName)
 Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...
 
float GetValueAsFloat (string propertyName, double time)
 Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...
 
int GetValueAsInt (string propertyName)
 Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...
 
int GetValueAsInt (string propertyName, double time)
 Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...
 
IList GetValueAsList (string propertyName)
 Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...
 
IList GetValueAsList (string propertyName, double time)
 Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...
 
IList< T > GetValueAsList< T > (string propertyName)
 Gets the value of the specified property if it is of a list type. More...
 
IList< T > GetValueAsList< T > (string propertyName, double time)
 Gets the value of the specified property if it is of a list type. More...
 
Matrix GetValueAsMatrix (string propertyName)
 Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...
 
Matrix GetValueAsMatrix (string propertyName, double time)
 Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...
 
IPluginRef GetValueAsPluginRef (string propertyName)
 Gets the value of the specified property if it is of type Plugin/PluginRef. More...
 
IPluginRef GetValueAsPluginRef (string propertyName, double time)
 Gets the value of the specified property if it is of type Plugin/PluginRef. More...
 
string GetValueAsString (string propertyName)
 Gets the string representation of the specified plugin property value. More...
 
string GetValueAsString (string propertyName, double time)
 Gets the string representation of the specified plugin property value. More...
 
Transform GetValueAsTransform (string propertyName)
 Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...
 
Transform GetValueAsTransform (string propertyName, double time)
 Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...
 
Vector GetValueAsVector (string propertyName)
 Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...
 
Vector GetValueAsVector (string propertyName, double time)
 Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...
 
bool IsPropertyAnimated (string propertyName)
 Returns whether the current value of the property is animated or not. More...
 
bool IsValid ()
 Check whether this object contains a valid reference to a V-Ray plugin instance. (The reference may become invalid if the actual plugin it refers to has been deleted.) More...
 
bool SetName (string newName)
 Sets a new name of the plugin. More...
 
bool SetValue (string propertyName, AColor value)
 Sets the value of the specified property as AColor. More...
 
bool SetValue (string propertyName, AColor value, double time)
 Sets the value of the specified property as AColor. More...
 
bool SetValue (string propertyName, bool value)
 Sets the value of the specified property as bool. More...
 
bool SetValue (string propertyName, bool value, double time)
 Sets the value of the specified property as bool. More...
 
bool SetValue (string propertyName, Color value)
 Sets the value of the specified property as Color. More...
 
bool SetValue (string propertyName, Color value, double time)
 Sets the value of the specified property as Color. More...
 
bool SetValue (string propertyName, Color[] value)
 Sets the value of the specified property as an array of Colors. More...
 
bool SetValue (string propertyName, Color[] value, double time)
 Sets the value of the specified property as an array of Colors. More...
 
bool SetValue (string propertyName, Color[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a Color array. More...
 
bool SetValue (string propertyName, Color[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a Color array. More...
 
bool SetValue (string propertyName, double value)
 Sets the value of the specified property as double. More...
 
bool SetValue (string propertyName, double value, double time)
 Sets the value of the specified property as double. More...
 
bool SetValue (string propertyName, double[] value)
 Sets the value of the specified property as an array of doubles. More...
 
bool SetValue (string propertyName, double[] value, double time)
 Sets the value of the specified property as an array of doubles. More...
 
bool SetValue (string propertyName, double[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a double array. More...
 
bool SetValue (string propertyName, double[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a double array. More...
 
bool SetValue (string propertyName, float value)
 Sets the value of the specified property as float. More...
 
bool SetValue (string propertyName, float value, double time)
 Sets the value of the specified property as float. More...
 
bool SetValue (string propertyName, float[] value)
 Sets the value of the specified property as an array of floats. More...
 
bool SetValue (string propertyName, float[] value, double time)
 Sets the value of the specified property as an array of floats. More...
 
bool SetValue (string propertyName, float[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a float array. More...
 
bool SetValue (string propertyName, float[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a float array. More...
 
bool SetValue (string propertyName, IList< Color > value)
 Sets the value of the specified property as a list of Colors. More...
 
bool SetValue (string propertyName, IList< Color > value, double time)
 Sets the value of the specified property as a list of Colors. More...
 
bool SetValue (string propertyName, IList< double > value)
 Sets the value of the specified property as alist of doubles. More...
 
bool SetValue (string propertyName, IList< double > value, double time)
 Sets the value of the specified property as alist of doubles. More...
 
bool SetValue (string propertyName, IList< float > value)
 Sets the value of the specified property as a list of floats. More...
 
bool SetValue (string propertyName, IList< float > value, double time)
 Sets the value of the specified property as a list of floats. More...
 
bool SetValue (string propertyName, IList< int > value)
 Sets the value of the specified property as a list of ints. More...
 
bool SetValue (string propertyName, IList< int > value, double time)
 Sets the value of the specified property as a list of ints. More...
 
bool SetValue (string propertyName, IList< Vector > value)
 Sets the value of the specified property as a list of Vectors. More...
 
bool SetValue (string propertyName, IList< Vector > value, double time)
 Sets the value of the specified property as a list of Vectors. More...
 
bool SetValue (string propertyName, int value)
 Sets the value of the specified property as int. More...
 
bool SetValue (string propertyName, int value, double time)
 Sets the value of the specified property as int. More...
 
bool SetValue (string propertyName, int[] value)
 Sets the value of the specified property as an array of ints. More...
 
bool SetValue (string propertyName, int[] value, double time)
 Sets the value of the specified property as an array of ints. More...
 
bool SetValue (string propertyName, int[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of an int array. More...
 
bool SetValue (string propertyName, int[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of an int array. More...
 
bool SetValue (string propertyName, IPluginRef value)
 Sets the value of the specified property as Plugin or Plugin's output parameter. More...
 
bool SetValue (string propertyName, IPluginRef value, double time)
 Sets the value of the specified property as Plugin or Plugin's output parameter. More...
 
bool SetValue (string propertyName, Matrix value)
 Sets the value of the specified property as Matrix. More...
 
bool SetValue (string propertyName, Matrix value, double time)
 Sets the value of the specified property as Matrix. More...
 
bool SetValue (string propertyName, object value)
 Sets the value of the specified property as a generic object. The type is deduced internally. More...
 
bool SetValue (string propertyName, object value, double time)
 Sets the value of the specified property as a generic object. The type is deduced internally. More...
 
bool SetValue (string propertyName, Plugin outPlugin, string outPropertyName)
 Sets the value of the specified property as a Plugin's output parameter. More...
 
bool SetValue (string propertyName, Plugin outPlugin, string outPropertyName, double time)
 Sets the value of the specified property as a Plugin's output parameter. More...
 
bool SetValue (string propertyName, Plugin value)
 Sets the value of the specified property as Plugin. More...
 
bool SetValue (string propertyName, Plugin value, double time)
 Sets the value of the specified property as Plugin. More...
 
bool SetValue (string propertyName, string propertyValue)
 Updates the currently loaded V-Ray scene. More...
 
bool SetValue (string propertyName, string propertyValue, double time)
 Updates the currently loaded V-Ray scene. More...
 
bool SetValue (string propertyName, Transform value)
 Sets the value of the specified property as Transform. More...
 
bool SetValue (string propertyName, Transform value, double time)
 Sets the value of the specified property as Transform. More...
 
bool SetValue (string propertyName, Vector value)
 Sets the value of the specified property as Vector. More...
 
bool SetValue (string propertyName, Vector value, double time)
 Sets the value of the specified property as Vector. More...
 
bool SetValue (string propertyName, Vector[] value)
 Sets the value of the specified property as an array of Vectors. More...
 
bool SetValue (string propertyName, Vector[] value, double time)
 Sets the value of the specified property as an array of Vectors. More...
 
bool SetValue (string propertyName, Vector[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a Vector array. More...
 
bool SetValue (string propertyName, Vector[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a Vector array. More...
 
override string ToString ()
 Returns the plugin name. More...
 
string ToString ()
 
new string ToString ()
 
- Public Member Functions inherited from VRay.Plugins.IPluginRef< CameraPhysical >
string ToString ()
 
new string ToString ()
 

Static Public Member Functions

static CameraPhysical GetInstance (VRayRenderer renderer, string name)
 Use renderer to find and return a CameraPhysical instance with the given name
 
static CameraPhysical NewInstance (VRayRenderer renderer, string name)
 Use renderer to create and return a CameraPhysical instance
 

Properties

float Anisotropy [get, set]
 Bokeh anisotropy [UI Guides] minValue=-1, maxValue=1, gpuSupport=full More...
 
bool BladesEnable [get, set]
 Set to true to enable Bokeh effects [UI Guides] gpuSupport=full More...
 
int BladesNum [get, set]
 Number of blades - 0 disables Bokeh [UI Guides] enableIf: ?blades_enable=1, minValue=2, maxValue=20, gpuSupport=full More...
 
float BladesRotation [get, set]
 Blade rotation in radians [UI Guides] gpuSupport=full More...
 
bool BmpapertureAffectsExposure [get, set]
 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 More...
 
bool BmpapertureEnable [get, set]
 Set to true to enable the use of bitmap aperture [UI Guides] displayName=Bitmap aperture, minValue=1, maxValue=2048, gpuSupport=full More...
 
int BmpapertureResolution [get, set]
 Texture sampling resolution for the importance sampling [UI Guides] enableIf: ?bmpaperture_enable=1, displayName=Bitmap resolution, gpuSupport=full More...
 
object BmpapertureTex [get, set]
 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
 
int CameraPhysicalType [get, set]
 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 More...
 
object CameraShaderTex [get, set]
 Camera shader [UI Guides] displayName=Camera shader texture, attributes=textureSlot, gpuSupport=full
 
float CenterBias [get, set]
 Bias toward the center of the lens for DOF sampling [UI Guides] minValue=-100, maxValue=100, gpuSupport=full More...
 
float Distortion [get, set]
 Distortion amount [UI Guides] enableIf: ?distortion_type=0; ?distortion_type=1, gpuSupport=full More...
 
object DistortionTex [get, set]
 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
 
int DistortionType [get, set]
 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 More...
 
float DofDisplayThreshold [get, set]
 Display threshold for depth-of-field [UI Guides] gpuSupport=none More...
 
bool DontAffectSettings [get, set]
 This is here so we can suppress a PhysicalCamera node from affecting the main VRayRenderer sequence and frame data. [UI Guides] gpuSupport=full More...
 
bool EnableThinLensEquation [get, set]
 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 More...
 
int Exposure [get, set]
 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 More...
 
float ExposureValue [get, set]
 Exposure value to use with exposure mode 2 [UI Guides] displayName=Exposure value, enableIf: ?exposure=2, gpuSupport=full More...
 
float FilmWidth [get, set]
 Film gate in mm [UI Guides] minValue=0, gpuSupport=full More...
 
float FNumber [get, set]
 F-stop [UI Guides] displayName=F-stop, minValue=0.01, gpuSupport=full More...
 
float FocalLength [get, set]
 Focal length in mm [UI Guides] minValue=0, gpuSupport=full More...
 
float FocusDistance [get, set]
 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 More...
 
float Fov [get, set]
 The FOV value (in radians) to use when specify_fov is true [UI Guides] enableIf: ?specify_fov=1, gpuSupport=full More...
 
float HorizontalOffset [get, set]
 The horizontal offset [UI Guides] displayName=Horizontal shift, gpuSupport=full More...
 
float HorizontalShift [get, set]
 The horizontal lens shift [UI Guides] displayName=Horizontal tilt, gpuSupport=full More...
 
float ISO [get, set]
 Sensor sensitivity (unbounded) [UI Guides] minValue=0, enableIf: ?exposure=1, gpuSupport=none More...
 
float Latency [get, set]
 Shutter latency in seconds for video camera [UI Guides] enableIf: ?type=2, gpuSupport=none More...
 
string LensFile [get, set]
 LENS file with camera lens-type image distortion description [UI Guides] fileAsset=vrlens, enableIf: ?distortion_type=2, gpuSupport=full More...
 
float LensShift [get, set]
 Lens shift [UI Guides] displayName=Vertical tilt, gpuSupport=full More...
 
float OpticalVignetting [get, set]
 Optical vignetting ("cat's eye bokeh") amount [UI Guides] minValue=-3, maxValue=3, gpuSupport=full More...
 
float RollingShutterDuration [get, set]
 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 More...
 
int RollingShutterMode [get, set]
 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 More...
 
string SceneName [get, set]
 The original scene name of the camera associated with the plugin [UI Guides] displayName=Scene name, gpuSupport=full More...
 
float ShutterAngle [get, set]
 Shutter angle in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=0, maxValue=360, gpuSupport=full More...
 
float ShutterOffset [get, set]
 Shutter offset in degrees for movie camera [UI Guides] enableIf: ?type=1, minValue=-360, maxValue=360, gpuSupport=full More...
 
float ShutterSpeed [get, set]
 The shutter speed in seconds^-1 for still camera [UI Guides] enableIf: ?type=0, minValue=0, gpuSupport=full More...
 
bool SpecifyFocus [get, set]
 Set to true to enable the focus_distance parameter [UI Guides] gpuSupport=full More...
 
bool SpecifyFov [get, set]
 Set to true to use explicit field of view from the "fov" value and false to use the focal length [UI Guides] gpuSupport=full More...
 
int Subdivs [get, set]
 Deprecated. This has no effect. [UI Guides] gpuSupport=none More...
 
float TargetDistance [get, set]
 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 More...
 
bool Targeted [get, set]
 Has no effect. Target distance is used when the focus distance is not used (if specify_focus=0). [UI Guides] gpuSupport=full More...
 
bool UseDof [get, set]
 Set to true to enable raytraced depth of field effect [UI Guides] displayName=Enable DOF, gpuSupport=full More...
 
bool UseMoblur [get, set]
 Set to true to enable motion blur [UI Guides] displayName=Enable Motion Blur, gpuSupport=full More...
 
float VerticalOffset [get, set]
 The vertical offset [UI Guides] displayName=Vertical shift, gpuSupport=full More...
 
float Vignetting [get, set]
 Strength of vignetting effect [UI Guides] minValue=0, gpuSupport=full More...
 
Color WhiteBalance [get, set]
 White point color [UI Guides] gpuSupport=full More...
 
float ZoomFactor [get, set]
 Zoom factor [UI Guides] minValue=0, gpuSupport=full More...
 
- Properties inherited from VRay.Plugins.Plugin
string this[string property] [get, set]
 Gets or sets a property with the given name. More...
 
- Properties inherited from VRay.Plugins.IPluginRef< T >
string OutputName [get]
 The output property name of the plugin if any. More...
 
new string OutputName [get]
 The output property name of the plugin if any. More...
 
Plugin Plugin [get]
 The plugin. More...
 
new T Plugin [get]
 The plugin. More...
 
- Properties inherited from VRay.Plugins.IPluginRef< CameraPhysical >
string OutputName [get]
 The output property name of the plugin if any.
 
new string OutputName [get]
 The output property name of the plugin if any.
 
Plugin Plugin [get]
 The plugin.
 
new T Plugin [get]
 The plugin.
 

Additional Inherited Members

- Protected Member Functions inherited from VRay.Plugins.Plugin
 Plugin (VRayRenderer renderer, long id)
 
 Plugin (VRayRenderer renderer, string name)
 
void Initialize (VRayRenderer vrayRenderer, long pluginId)
 

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)

Gets the value of CameraPhysical.Anisotropy

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BladesEnable()

bool VRay.Plugins.CameraPhysical.Get_BladesEnable ( double  time)

Gets the value of CameraPhysical.BladesEnable

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BladesNum()

int VRay.Plugins.CameraPhysical.Get_BladesNum ( double  time)

Gets the value of CameraPhysical.BladesNum

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BladesRotation()

float VRay.Plugins.CameraPhysical.Get_BladesRotation ( double  time)

Gets the value of CameraPhysical.BladesRotation

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BmpapertureAffectsExposure()

bool VRay.Plugins.CameraPhysical.Get_BmpapertureAffectsExposure ( double  time)

Gets the value of CameraPhysical.BmpapertureAffectsExposure

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BmpapertureEnable()

bool VRay.Plugins.CameraPhysical.Get_BmpapertureEnable ( double  time)

Gets the value of CameraPhysical.BmpapertureEnable

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BmpapertureResolution()

int VRay.Plugins.CameraPhysical.Get_BmpapertureResolution ( double  time)

Gets the value of CameraPhysical.BmpapertureResolution

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_BmpapertureTex()

object VRay.Plugins.CameraPhysical.Get_BmpapertureTex ( double  time)

Gets the value of CameraPhysical.BmpapertureTex

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_CameraPhysicalType()

int VRay.Plugins.CameraPhysical.Get_CameraPhysicalType ( double  time)

Gets the value of CameraPhysical.CameraPhysicalType

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_CameraShaderTex()

object VRay.Plugins.CameraPhysical.Get_CameraShaderTex ( double  time)

Gets the value of CameraPhysical.CameraShaderTex

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_CenterBias()

float VRay.Plugins.CameraPhysical.Get_CenterBias ( double  time)

Gets the value of CameraPhysical.CenterBias

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Distortion()

float VRay.Plugins.CameraPhysical.Get_Distortion ( double  time)

Gets the value of CameraPhysical.Distortion

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_DistortionTex()

object VRay.Plugins.CameraPhysical.Get_DistortionTex ( double  time)

Gets the value of CameraPhysical.DistortionTex

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_DistortionType()

int VRay.Plugins.CameraPhysical.Get_DistortionType ( double  time)

Gets the value of CameraPhysical.DistortionType

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_DofDisplayThreshold()

float VRay.Plugins.CameraPhysical.Get_DofDisplayThreshold ( double  time)

Gets the value of CameraPhysical.DofDisplayThreshold

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_DontAffectSettings()

bool VRay.Plugins.CameraPhysical.Get_DontAffectSettings ( double  time)

Gets the value of CameraPhysical.DontAffectSettings

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_EnableThinLensEquation()

bool VRay.Plugins.CameraPhysical.Get_EnableThinLensEquation ( double  time)

Gets the value of CameraPhysical.EnableThinLensEquation

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Exposure()

int VRay.Plugins.CameraPhysical.Get_Exposure ( double  time)

Gets the value of CameraPhysical.Exposure

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ExposureValue()

float VRay.Plugins.CameraPhysical.Get_ExposureValue ( double  time)

Gets the value of CameraPhysical.ExposureValue

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_FilmWidth()

float VRay.Plugins.CameraPhysical.Get_FilmWidth ( double  time)

Gets the value of CameraPhysical.FilmWidth

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_FNumber()

float VRay.Plugins.CameraPhysical.Get_FNumber ( double  time)

Gets the value of CameraPhysical.FNumber

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_FocalLength()

float VRay.Plugins.CameraPhysical.Get_FocalLength ( double  time)

Gets the value of CameraPhysical.FocalLength

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_FocusDistance()

float VRay.Plugins.CameraPhysical.Get_FocusDistance ( double  time)

Gets the value of CameraPhysical.FocusDistance

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Fov()

float VRay.Plugins.CameraPhysical.Get_Fov ( double  time)

Gets the value of CameraPhysical.Fov

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_HorizontalOffset()

float VRay.Plugins.CameraPhysical.Get_HorizontalOffset ( double  time)

Gets the value of CameraPhysical.HorizontalOffset

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_HorizontalShift()

float VRay.Plugins.CameraPhysical.Get_HorizontalShift ( double  time)

Gets the value of CameraPhysical.HorizontalShift

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ISO()

float VRay.Plugins.CameraPhysical.Get_ISO ( double  time)

Gets the value of CameraPhysical.ISO

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Latency()

float VRay.Plugins.CameraPhysical.Get_Latency ( double  time)

Gets the value of CameraPhysical.Latency

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_LensFile()

string VRay.Plugins.CameraPhysical.Get_LensFile ( double  time)

Gets the value of CameraPhysical.LensFile

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_LensShift()

float VRay.Plugins.CameraPhysical.Get_LensShift ( double  time)

Gets the value of CameraPhysical.LensShift

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_OpticalVignetting()

float VRay.Plugins.CameraPhysical.Get_OpticalVignetting ( double  time)

Gets the value of CameraPhysical.OpticalVignetting

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_RollingShutterDuration()

float VRay.Plugins.CameraPhysical.Get_RollingShutterDuration ( double  time)

Gets the value of CameraPhysical.RollingShutterDuration

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_RollingShutterMode()

int VRay.Plugins.CameraPhysical.Get_RollingShutterMode ( double  time)

Gets the value of CameraPhysical.RollingShutterMode

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_SceneName()

string VRay.Plugins.CameraPhysical.Get_SceneName ( double  time)

Gets the value of CameraPhysical.SceneName

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ShutterAngle()

float VRay.Plugins.CameraPhysical.Get_ShutterAngle ( double  time)

Gets the value of CameraPhysical.ShutterAngle

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ShutterOffset()

float VRay.Plugins.CameraPhysical.Get_ShutterOffset ( double  time)

Gets the value of CameraPhysical.ShutterOffset

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ShutterSpeed()

float VRay.Plugins.CameraPhysical.Get_ShutterSpeed ( double  time)

Gets the value of CameraPhysical.ShutterSpeed

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_SpecifyFocus()

bool VRay.Plugins.CameraPhysical.Get_SpecifyFocus ( double  time)

Gets the value of CameraPhysical.SpecifyFocus

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_SpecifyFov()

bool VRay.Plugins.CameraPhysical.Get_SpecifyFov ( double  time)

Gets the value of CameraPhysical.SpecifyFov

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Subdivs()

int VRay.Plugins.CameraPhysical.Get_Subdivs ( double  time)

Gets the value of CameraPhysical.Subdivs

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_TargetDistance()

float VRay.Plugins.CameraPhysical.Get_TargetDistance ( double  time)

Gets the value of CameraPhysical.TargetDistance

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Targeted()

bool VRay.Plugins.CameraPhysical.Get_Targeted ( double  time)

Gets the value of CameraPhysical.Targeted

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_UseDof()

bool VRay.Plugins.CameraPhysical.Get_UseDof ( double  time)

Gets the value of CameraPhysical.UseDof

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_UseMoblur()

bool VRay.Plugins.CameraPhysical.Get_UseMoblur ( double  time)

Gets the value of CameraPhysical.UseMoblur

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_VerticalOffset()

float VRay.Plugins.CameraPhysical.Get_VerticalOffset ( double  time)

Gets the value of CameraPhysical.VerticalOffset

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Vignetting()

float VRay.Plugins.CameraPhysical.Get_Vignetting ( double  time)

Gets the value of CameraPhysical.Vignetting

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_WhiteBalance()

Color VRay.Plugins.CameraPhysical.Get_WhiteBalance ( double  time)

Gets the value of CameraPhysical.WhiteBalance

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ZoomFactor()

float VRay.Plugins.CameraPhysical.Get_ZoomFactor ( double  time)

Gets the value of CameraPhysical.ZoomFactor

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Set_Anisotropy()

bool VRay.Plugins.CameraPhysical.Set_Anisotropy ( float  val,
double  time 
)

Sets a value to CameraPhysical.Anisotropy

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BladesEnable()

bool VRay.Plugins.CameraPhysical.Set_BladesEnable ( bool  val,
double  time 
)

Sets a value to CameraPhysical.BladesEnable

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BladesNum()

bool VRay.Plugins.CameraPhysical.Set_BladesNum ( int  val,
double  time 
)

Sets a value to CameraPhysical.BladesNum

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BladesRotation()

bool VRay.Plugins.CameraPhysical.Set_BladesRotation ( float  val,
double  time 
)

Sets a value to CameraPhysical.BladesRotation

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BmpapertureAffectsExposure()

bool VRay.Plugins.CameraPhysical.Set_BmpapertureAffectsExposure ( bool  val,
double  time 
)

Sets a value to CameraPhysical.BmpapertureAffectsExposure

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BmpapertureEnable()

bool VRay.Plugins.CameraPhysical.Set_BmpapertureEnable ( bool  val,
double  time 
)

Sets a value to CameraPhysical.BmpapertureEnable

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BmpapertureResolution()

bool VRay.Plugins.CameraPhysical.Set_BmpapertureResolution ( int  val,
double  time 
)

Sets a value to CameraPhysical.BmpapertureResolution

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_BmpapertureTex()

bool VRay.Plugins.CameraPhysical.Set_BmpapertureTex ( object  val,
double  time 
)

Sets a value to CameraPhysical.BmpapertureTex

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_CameraPhysicalType()

bool VRay.Plugins.CameraPhysical.Set_CameraPhysicalType ( int  val,
double  time 
)

Sets a value to CameraPhysical.CameraPhysicalType

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_CameraShaderTex()

bool VRay.Plugins.CameraPhysical.Set_CameraShaderTex ( object  val,
double  time 
)

Sets a value to CameraPhysical.CameraShaderTex

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_CenterBias()

bool VRay.Plugins.CameraPhysical.Set_CenterBias ( float  val,
double  time 
)

Sets a value to CameraPhysical.CenterBias

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Distortion()

bool VRay.Plugins.CameraPhysical.Set_Distortion ( float  val,
double  time 
)

Sets a value to CameraPhysical.Distortion

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_DistortionTex()

bool VRay.Plugins.CameraPhysical.Set_DistortionTex ( object  val,
double  time 
)

Sets a value to CameraPhysical.DistortionTex

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_DistortionType()

bool VRay.Plugins.CameraPhysical.Set_DistortionType ( int  val,
double  time 
)

Sets a value to CameraPhysical.DistortionType

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_DofDisplayThreshold()

bool VRay.Plugins.CameraPhysical.Set_DofDisplayThreshold ( float  val,
double  time 
)

Sets a value to CameraPhysical.DofDisplayThreshold

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_DontAffectSettings()

bool VRay.Plugins.CameraPhysical.Set_DontAffectSettings ( bool  val,
double  time 
)

Sets a value to CameraPhysical.DontAffectSettings

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_EnableThinLensEquation()

bool VRay.Plugins.CameraPhysical.Set_EnableThinLensEquation ( bool  val,
double  time 
)

Sets a value to CameraPhysical.EnableThinLensEquation

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Exposure()

bool VRay.Plugins.CameraPhysical.Set_Exposure ( int  val,
double  time 
)

Sets a value to CameraPhysical.Exposure

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ExposureValue()

bool VRay.Plugins.CameraPhysical.Set_ExposureValue ( float  val,
double  time 
)

Sets a value to CameraPhysical.ExposureValue

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_FilmWidth()

bool VRay.Plugins.CameraPhysical.Set_FilmWidth ( float  val,
double  time 
)

Sets a value to CameraPhysical.FilmWidth

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_FNumber()

bool VRay.Plugins.CameraPhysical.Set_FNumber ( float  val,
double  time 
)

Sets a value to CameraPhysical.FNumber

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_FocalLength()

bool VRay.Plugins.CameraPhysical.Set_FocalLength ( float  val,
double  time 
)

Sets a value to CameraPhysical.FocalLength

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_FocusDistance()

bool VRay.Plugins.CameraPhysical.Set_FocusDistance ( float  val,
double  time 
)

Sets a value to CameraPhysical.FocusDistance

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Fov()

bool VRay.Plugins.CameraPhysical.Set_Fov ( float  val,
double  time 
)

Sets a value to CameraPhysical.Fov

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_HorizontalOffset()

bool VRay.Plugins.CameraPhysical.Set_HorizontalOffset ( float  val,
double  time 
)

Sets a value to CameraPhysical.HorizontalOffset

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_HorizontalShift()

bool VRay.Plugins.CameraPhysical.Set_HorizontalShift ( float  val,
double  time 
)

Sets a value to CameraPhysical.HorizontalShift

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ISO()

bool VRay.Plugins.CameraPhysical.Set_ISO ( float  val,
double  time 
)

Sets a value to CameraPhysical.ISO

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Latency()

bool VRay.Plugins.CameraPhysical.Set_Latency ( float  val,
double  time 
)

Sets a value to CameraPhysical.Latency

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_LensFile()

bool VRay.Plugins.CameraPhysical.Set_LensFile ( string  val,
double  time 
)

Sets a value to CameraPhysical.LensFile

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_LensShift()

bool VRay.Plugins.CameraPhysical.Set_LensShift ( float  val,
double  time 
)

Sets a value to CameraPhysical.LensShift

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_OpticalVignetting()

bool VRay.Plugins.CameraPhysical.Set_OpticalVignetting ( float  val,
double  time 
)

Sets a value to CameraPhysical.OpticalVignetting

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_RollingShutterDuration()

bool VRay.Plugins.CameraPhysical.Set_RollingShutterDuration ( float  val,
double  time 
)

Sets a value to CameraPhysical.RollingShutterDuration

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_RollingShutterMode()

bool VRay.Plugins.CameraPhysical.Set_RollingShutterMode ( int  val,
double  time 
)

Sets a value to CameraPhysical.RollingShutterMode

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_SceneName()

bool VRay.Plugins.CameraPhysical.Set_SceneName ( string  val,
double  time 
)

Sets a value to CameraPhysical.SceneName

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ShutterAngle()

bool VRay.Plugins.CameraPhysical.Set_ShutterAngle ( float  val,
double  time 
)

Sets a value to CameraPhysical.ShutterAngle

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ShutterOffset()

bool VRay.Plugins.CameraPhysical.Set_ShutterOffset ( float  val,
double  time 
)

Sets a value to CameraPhysical.ShutterOffset

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ShutterSpeed()

bool VRay.Plugins.CameraPhysical.Set_ShutterSpeed ( float  val,
double  time 
)

Sets a value to CameraPhysical.ShutterSpeed

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_SpecifyFocus()

bool VRay.Plugins.CameraPhysical.Set_SpecifyFocus ( bool  val,
double  time 
)

Sets a value to CameraPhysical.SpecifyFocus

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_SpecifyFov()

bool VRay.Plugins.CameraPhysical.Set_SpecifyFov ( bool  val,
double  time 
)

Sets a value to CameraPhysical.SpecifyFov

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Subdivs()

bool VRay.Plugins.CameraPhysical.Set_Subdivs ( int  val,
double  time 
)

Sets a value to CameraPhysical.Subdivs

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_TargetDistance()

bool VRay.Plugins.CameraPhysical.Set_TargetDistance ( float  val,
double  time 
)

Sets a value to CameraPhysical.TargetDistance

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Targeted()

bool VRay.Plugins.CameraPhysical.Set_Targeted ( bool  val,
double  time 
)

Sets a value to CameraPhysical.Targeted

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_UseDof()

bool VRay.Plugins.CameraPhysical.Set_UseDof ( bool  val,
double  time 
)

Sets a value to CameraPhysical.UseDof

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_UseMoblur()

bool VRay.Plugins.CameraPhysical.Set_UseMoblur ( bool  val,
double  time 
)

Sets a value to CameraPhysical.UseMoblur

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_VerticalOffset()

bool VRay.Plugins.CameraPhysical.Set_VerticalOffset ( float  val,
double  time 
)

Sets a value to CameraPhysical.VerticalOffset

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Vignetting()

bool VRay.Plugins.CameraPhysical.Set_Vignetting ( float  val,
double  time 
)

Sets a value to CameraPhysical.Vignetting

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_WhiteBalance()

bool VRay.Plugins.CameraPhysical.Set_WhiteBalance ( Color  val,
double  time 
)

Sets a value to CameraPhysical.WhiteBalance

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ZoomFactor()

bool VRay.Plugins.CameraPhysical.Set_ZoomFactor ( float  val,
double  time 
)

Sets a value to CameraPhysical.ZoomFactor

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

Property Documentation

◆ Anisotropy

float VRay.Plugins.CameraPhysical.Anisotropy
getset

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

Default value: 0

◆ BladesEnable

bool VRay.Plugins.CameraPhysical.BladesEnable
getset

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

Default value: 0

◆ BladesNum

int VRay.Plugins.CameraPhysical.BladesNum
getset

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

Default value: 5

◆ BladesRotation

float VRay.Plugins.CameraPhysical.BladesRotation
getset

Blade rotation in radians [UI Guides] gpuSupport=full

Default value: 0

◆ BmpapertureAffectsExposure

bool VRay.Plugins.CameraPhysical.BmpapertureAffectsExposure
getset

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

◆ BmpapertureEnable

bool VRay.Plugins.CameraPhysical.BmpapertureEnable
getset

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

Default value: 0

◆ BmpapertureResolution

int VRay.Plugins.CameraPhysical.BmpapertureResolution
getset

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

Default value: 512

◆ CameraPhysicalType

int VRay.Plugins.CameraPhysical.CameraPhysicalType
getset

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

◆ CenterBias

float VRay.Plugins.CameraPhysical.CenterBias
getset

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

Default value: 0

◆ Distortion

float VRay.Plugins.CameraPhysical.Distortion
getset

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

Default value: 0

◆ DistortionType

int VRay.Plugins.CameraPhysical.DistortionType
getset

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

◆ DofDisplayThreshold

float VRay.Plugins.CameraPhysical.DofDisplayThreshold
getset

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

Default value: 0.001

◆ DontAffectSettings

bool VRay.Plugins.CameraPhysical.DontAffectSettings
getset

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

◆ EnableThinLensEquation

bool VRay.Plugins.CameraPhysical.EnableThinLensEquation
getset

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

◆ Exposure

int VRay.Plugins.CameraPhysical.Exposure
getset

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

◆ ExposureValue

float VRay.Plugins.CameraPhysical.ExposureValue
getset

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

Default value: 0

◆ FilmWidth

float VRay.Plugins.CameraPhysical.FilmWidth
getset

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

Default value: 36

◆ FNumber

float VRay.Plugins.CameraPhysical.FNumber
getset

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

Default value: 8

◆ FocalLength

float VRay.Plugins.CameraPhysical.FocalLength
getset

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

Default value: 40

◆ FocusDistance

float VRay.Plugins.CameraPhysical.FocusDistance
getset

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

◆ Fov

float VRay.Plugins.CameraPhysical.Fov
getset

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

Default value: 1.5708

◆ HorizontalOffset

float VRay.Plugins.CameraPhysical.HorizontalOffset
getset

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

Default value: 0

◆ HorizontalShift

float VRay.Plugins.CameraPhysical.HorizontalShift
getset

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

Default value: 0

◆ ISO

float VRay.Plugins.CameraPhysical.ISO
getset

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

Default value: 200

◆ Latency

float VRay.Plugins.CameraPhysical.Latency
getset

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

Default value: 0

◆ LensFile

string VRay.Plugins.CameraPhysical.LensFile
getset

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

Default value:

◆ LensShift

float VRay.Plugins.CameraPhysical.LensShift
getset

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

Default value: 0

◆ OpticalVignetting

float VRay.Plugins.CameraPhysical.OpticalVignetting
getset

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

Default value: 0

◆ RollingShutterDuration

float VRay.Plugins.CameraPhysical.RollingShutterDuration
getset

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

◆ RollingShutterMode

int VRay.Plugins.CameraPhysical.RollingShutterMode
getset

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

◆ SceneName

string VRay.Plugins.CameraPhysical.SceneName
getset

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

Default value:

◆ ShutterAngle

float VRay.Plugins.CameraPhysical.ShutterAngle
getset

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

Default value: 180

◆ ShutterOffset

float VRay.Plugins.CameraPhysical.ShutterOffset
getset

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

Default value: 0

◆ ShutterSpeed

float VRay.Plugins.CameraPhysical.ShutterSpeed
getset

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

Default value: 300

◆ SpecifyFocus

bool VRay.Plugins.CameraPhysical.SpecifyFocus
getset

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

Default value: 0

◆ SpecifyFov

bool VRay.Plugins.CameraPhysical.SpecifyFov
getset

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

◆ Subdivs

int VRay.Plugins.CameraPhysical.Subdivs
getset

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

Default value: 1

◆ TargetDistance

float VRay.Plugins.CameraPhysical.TargetDistance
getset

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

◆ Targeted

bool VRay.Plugins.CameraPhysical.Targeted
getset

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

◆ UseDof

bool VRay.Plugins.CameraPhysical.UseDof
getset

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

Default value: 0

◆ UseMoblur

bool VRay.Plugins.CameraPhysical.UseMoblur
getset

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

Default value: 0

◆ VerticalOffset

float VRay.Plugins.CameraPhysical.VerticalOffset
getset

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

Default value: 0

◆ Vignetting

float VRay.Plugins.CameraPhysical.Vignetting
getset

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

Default value: 1

◆ WhiteBalance

Color VRay.Plugins.CameraPhysical.WhiteBalance
getset

White point color [UI Guides] gpuSupport=full

Default value: Color(1, 1, 1)

◆ ZoomFactor

float VRay.Plugins.CameraPhysical.ZoomFactor
getset

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

Default value: 1


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