VRay SDK for C#
Loading...
Searching...
No Matches
VRay.Plugins.VRayObjectProperties Class Reference

Combines MtlWrapper and MtlRenderStats functionality to be used as a direct reference in Node instances. This means it adds both Matte properties for the Node and options to control primary visibility and shadow visibility of the Node. Note that the GPU implementation currently requires using a dedicated VRayObjectProperties instance for each unique Node and Node::material pair. [gpuSupport=(partial)] More...

Inherits VRay.Plugins.Plugin, and VRay.Plugins.IPluginRef< VRayObjectProperties >.

Public Member Functions

bool Get_AffectAlpha (double time)
 Gets the value of VRayObjectProperties.AffectAlpha More...
 
float Get_AlphaContribution (double time)
 Gets the value of VRayObjectProperties.AlphaContribution More...
 
object Get_AlphaContributionTex (double time)
 Gets the value of VRayObjectProperties.AlphaContributionTex More...
 
bool Get_CameraVisibility (double time)
 Gets the value of VRayObjectProperties.CameraVisibility More...
 
IList< object > Get_Channels (double time)
 Gets the value of VRayObjectProperties.Channels More...
 
float Get_GenerateCaustics (double time)
 Gets the value of VRayObjectProperties.GenerateCaustics More...
 
float Get_GenerateGi (double time)
 Gets the value of VRayObjectProperties.GenerateGi More...
 
bool Get_GenerateRenderElements (double time)
 Gets the value of VRayObjectProperties.GenerateRenderElements More...
 
float Get_GiAmount (double time)
 Gets the value of VRayObjectProperties.GiAmount More...
 
float Get_GiQualityMultiplier (double time)
 Gets the value of VRayObjectProperties.GiQualityMultiplier More...
 
int Get_GiSurfaceId (double time)
 Gets the value of VRayObjectProperties.GiSurfaceId More...
 
bool Get_GiVisibility (double time)
 Gets the value of VRayObjectProperties.GiVisibility More...
 
int Get_MatteForSecondaryRays (double time)
 Gets the value of VRayObjectProperties.MatteForSecondaryRays More...
 
bool Get_MatteSurface (double time)
 Gets the value of VRayObjectProperties.MatteSurface More...
 
bool Get_MayaBackgroundShaderCompatibility (double time)
 Gets the value of VRayObjectProperties.MayaBackgroundShaderCompatibility More...
 
bool Get_NoGiOnOtherMattes (double time)
 Gets the value of VRayObjectProperties.NoGiOnOtherMattes More...
 
float Get_ReceiveCaustics (double time)
 Gets the value of VRayObjectProperties.ReceiveCaustics More...
 
float Get_ReceiveGi (double time)
 Gets the value of VRayObjectProperties.ReceiveGi More...
 
float Get_ReflectionAmount (double time)
 Gets the value of VRayObjectProperties.ReflectionAmount More...
 
IList< object > Get_ReflectionExclude (double time)
 Gets the value of VRayObjectProperties.ReflectionExclude More...
 
object Get_ReflectionFilterTex (double time)
 Gets the value of VRayObjectProperties.ReflectionFilterTex More...
 
bool Get_ReflectionListIsInclusive (double time)
 Gets the value of VRayObjectProperties.ReflectionListIsInclusive More...
 
bool Get_ReflectionsVisibility (double time)
 Gets the value of VRayObjectProperties.ReflectionsVisibility More...
 
float Get_RefractionAmount (double time)
 Gets the value of VRayObjectProperties.RefractionAmount More...
 
IList< object > Get_RefractionExclude (double time)
 Gets the value of VRayObjectProperties.RefractionExclude More...
 
bool Get_RefractionListIsInclusive (double time)
 Gets the value of VRayObjectProperties.RefractionListIsInclusive More...
 
bool Get_RefractionsVisibility (double time)
 Gets the value of VRayObjectProperties.RefractionsVisibility More...
 
bool Get_RenderStatsUse (double time)
 Gets the value of VRayObjectProperties.RenderStatsUse More...
 
float Get_ShadowBrightness (double time)
 Gets the value of VRayObjectProperties.ShadowBrightness More...
 
object Get_ShadowBrightnessTex (double time)
 Gets the value of VRayObjectProperties.ShadowBrightnessTex More...
 
bool Get_Shadows (double time)
 Gets the value of VRayObjectProperties.Shadows More...
 
bool Get_ShadowsReceive (double time)
 Gets the value of VRayObjectProperties.ShadowsReceive More...
 
bool Get_ShadowsVisibility (double time)
 Gets the value of VRayObjectProperties.ShadowsVisibility More...
 
Color Get_ShadowTintColor (double time)
 Gets the value of VRayObjectProperties.ShadowTintColor More...
 
int Get_TraceDepth (double time)
 Gets the value of VRayObjectProperties.TraceDepth More...
 
bool Get_UseIrradMap (double time)
 Gets the value of VRayObjectProperties.UseIrradMap More...
 
float Get_Visibility (double time)
 Gets the value of VRayObjectProperties.Visibility More...
 
bool Get_WrapperUse (double time)
 Gets the value of VRayObjectProperties.WrapperUse More...
 
bool Set_AffectAlpha (bool val, double time)
 Sets a value to VRayObjectProperties.AffectAlpha More...
 
bool Set_AlphaContribution (float val, double time)
 Sets a value to VRayObjectProperties.AlphaContribution More...
 
bool Set_AlphaContributionTex (object val, double time)
 Sets a value to VRayObjectProperties.AlphaContributionTex More...
 
bool Set_CameraVisibility (bool val, double time)
 Sets a value to VRayObjectProperties.CameraVisibility More...
 
bool Set_Channels (IList< object > val, double time)
 Sets a value to VRayObjectProperties.Channels More...
 
bool Set_GenerateCaustics (float val, double time)
 Sets a value to VRayObjectProperties.GenerateCaustics More...
 
bool Set_GenerateGi (float val, double time)
 Sets a value to VRayObjectProperties.GenerateGi More...
 
bool Set_GenerateRenderElements (bool val, double time)
 Sets a value to VRayObjectProperties.GenerateRenderElements More...
 
bool Set_GiAmount (float val, double time)
 Sets a value to VRayObjectProperties.GiAmount More...
 
bool Set_GiQualityMultiplier (float val, double time)
 Sets a value to VRayObjectProperties.GiQualityMultiplier More...
 
bool Set_GiSurfaceId (int val, double time)
 Sets a value to VRayObjectProperties.GiSurfaceId More...
 
bool Set_GiVisibility (bool val, double time)
 Sets a value to VRayObjectProperties.GiVisibility More...
 
bool Set_MatteForSecondaryRays (int val, double time)
 Sets a value to VRayObjectProperties.MatteForSecondaryRays More...
 
bool Set_MatteSurface (bool val, double time)
 Sets a value to VRayObjectProperties.MatteSurface More...
 
bool Set_MayaBackgroundShaderCompatibility (bool val, double time)
 Sets a value to VRayObjectProperties.MayaBackgroundShaderCompatibility More...
 
bool Set_NoGiOnOtherMattes (bool val, double time)
 Sets a value to VRayObjectProperties.NoGiOnOtherMattes More...
 
bool Set_ReceiveCaustics (float val, double time)
 Sets a value to VRayObjectProperties.ReceiveCaustics More...
 
bool Set_ReceiveGi (float val, double time)
 Sets a value to VRayObjectProperties.ReceiveGi More...
 
bool Set_ReflectionAmount (float val, double time)
 Sets a value to VRayObjectProperties.ReflectionAmount More...
 
bool Set_ReflectionExclude (IList< object > val, double time)
 Sets a value to VRayObjectProperties.ReflectionExclude More...
 
bool Set_ReflectionFilterTex (object val, double time)
 Sets a value to VRayObjectProperties.ReflectionFilterTex More...
 
bool Set_ReflectionListIsInclusive (bool val, double time)
 Sets a value to VRayObjectProperties.ReflectionListIsInclusive More...
 
bool Set_ReflectionsVisibility (bool val, double time)
 Sets a value to VRayObjectProperties.ReflectionsVisibility More...
 
bool Set_RefractionAmount (float val, double time)
 Sets a value to VRayObjectProperties.RefractionAmount More...
 
bool Set_RefractionExclude (IList< object > val, double time)
 Sets a value to VRayObjectProperties.RefractionExclude More...
 
bool Set_RefractionListIsInclusive (bool val, double time)
 Sets a value to VRayObjectProperties.RefractionListIsInclusive More...
 
bool Set_RefractionsVisibility (bool val, double time)
 Sets a value to VRayObjectProperties.RefractionsVisibility More...
 
bool Set_RenderStatsUse (bool val, double time)
 Sets a value to VRayObjectProperties.RenderStatsUse More...
 
bool Set_ShadowBrightness (float val, double time)
 Sets a value to VRayObjectProperties.ShadowBrightness More...
 
bool Set_ShadowBrightnessTex (object val, double time)
 Sets a value to VRayObjectProperties.ShadowBrightnessTex More...
 
bool Set_Shadows (bool val, double time)
 Sets a value to VRayObjectProperties.Shadows More...
 
bool Set_ShadowsReceive (bool val, double time)
 Sets a value to VRayObjectProperties.ShadowsReceive More...
 
bool Set_ShadowsVisibility (bool val, double time)
 Sets a value to VRayObjectProperties.ShadowsVisibility More...
 
bool Set_ShadowTintColor (Color val, double time)
 Sets a value to VRayObjectProperties.ShadowTintColor More...
 
bool Set_TraceDepth (int val, double time)
 Sets a value to VRayObjectProperties.TraceDepth More...
 
bool Set_UseIrradMap (bool val, double time)
 Sets a value to VRayObjectProperties.UseIrradMap More...
 
bool Set_Visibility (float val, double time)
 Sets a value to VRayObjectProperties.Visibility More...
 
bool Set_WrapperUse (bool val, double time)
 Sets a value to VRayObjectProperties.WrapperUse 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< VRayObjectProperties >
string ToString ()
 
new string ToString ()
 

Static Public Member Functions

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

Properties

bool AffectAlpha [get, set]
 Turn this on to make shadows affect the alpha contribution of the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=partial More...
 
float AlphaContribution [get, set]
 The contribution of the resulting color to the alpha channel. [UI Guides] startRollout=Matte properties, minValue=-1, maxValue=1, gpuSupport=partial More...
 
object AlphaContributionTex [get, set]
 Same as alpha_contribution but used for the Maya's useBackground shader which supports textures as alpha contribution [UI Guides] gpuSupport=full
 
bool CameraVisibility [get, set]
 Whether the object is visible from the camera (camera rays) [UI Guides] gpuSupport=full More...
 
IList< object > Channels [get, set]
 Render channels the result of this BRDF will be written to [UI Guides] gpuSupport=none
 
float GenerateCaustics [get, set]
 Controls the caustics generated by the material. [UI Guides] displayName=Generated caustics mult., minValue=0.0, gpuSupport=none More...
 
float GenerateGi [get, set]
 Controls the GI generated by the material. [UI Guides] displayName=Generated GI mult., minValue=0.0, gpuSupport=full More...
 
bool GenerateRenderElements [get, set]
 Setting this to false makes objects to not affect the render elements. [UI Guides] gpuSupport=none More...
 
float GiAmount [get, set]
 Determines the amount of gi shadows. [UI Guides] displayName=GI amount, enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=none More...
 
float GiQualityMultiplier [get, set]
 This is a multiplier for the subdivisions of all secondary ray tracing done for the particular surface. [UI Guides] displayName=Subdivs multiplier, minValue0.0, gpuSupport=none More...
 
int GiSurfaceId [get, set]
 If two objects have different GI surface ids, the light cache samples of the two objects will not be blended. [UI Guides] displayName=GI surface ID, minValue0, startRollout=Miscellaneous, gpuSupport=none More...
 
bool GiVisibility [get, set]
 Whether the object is visible to GI (generating and receiving) [UI Guides] gpuSupport=full More...
 
int MatteForSecondaryRays [get, set]
 Set this to 1 to make the material act as matte for all secondary rays (reflections and refractions); if set to 2, the material will perform automatic projection mapping of the environment map on the matte geometry [UI Guides] displayName=Matte for sec. rays, enum=0:Disable;1:Without Projection Mapping;2:With Projection Mapping, enableIf: ?matte_surface=1, gpuSupport=partial More...
 
bool MatteSurface [get, set]
 Makes the material appear as a matte material, which shows the background, instead of the base material, when viewed directly. [UI Guides] gpuSupport=partial More...
 
bool MayaBackgroundShaderCompatibility [get, set]
 Setting this to true will make the matte alpha opaque so that the alpha of objects behind the matte won't be seen. [UI Guides] gpuSupport=none More...
 
bool NoGiOnOtherMattes [get, set]
 This will cause the material to appear as a matte object in reflections, refractions, GI etc for other matte objects. [UI Guides] displayName=No GI on other mattes, enableIf: ?matte_surface=1, gpuSupport=none More...
 
float ReceiveCaustics [get, set]
 Controls the caustics received by the material. [UI Guides] displayName=Received caustics mult., minValue=0.0, gpuSupport=none More...
 
float ReceiveGi [get, set]
 Controls the GI received by the material. [UI Guides] displayName=Received GI mult., minValue=0.0, gpuSupport=full More...
 
float ReflectionAmount [get, set]
 Shows the reflections of the base material. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full More...
 
IList< object > ReflectionExclude [get, set]
 A list of plugins that will be excluded from reflections. [UI Guides] attributes=objectSet, startRollout=, gpuSupport=none
 
object ReflectionFilterTex [get, set]
 (description missing) [UI Guides] gpuSupport=none
 
bool ReflectionListIsInclusive [get, set]
 Setting this to true will turn the reflection exclude list into inclusive (inverted). [UI Guides] gpuSupport=none More...
 
bool ReflectionsVisibility [get, set]
 Whether the object is visible in reflections [UI Guides] gpuSupport=full More...
 
float RefractionAmount [get, set]
 Shows the refractions of the base material. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full More...
 
IList< object > RefractionExclude [get, set]
 A list of plugins that will be excluded from refractions. [UI Guides] attributes=objectSet, startRollout=, gpuSupport=none
 
bool RefractionListIsInclusive [get, set]
 Setting this to true will turn the refraction exclude list into inclusive (inverted). [UI Guides] gpuSupport=none More...
 
bool RefractionsVisibility [get, set]
 Whether the object is visible in refractions [UI Guides] gpuSupport=full More...
 
bool RenderStatsUse [get, set]
 Use RenderStats properties. More...
 
float ShadowBrightness [get, set]
 An optional brightness parameter for the shadows on the matte surface.A value of 0.0 will make the shadows completely invisible, while a value of 1.0 will show the full shadows. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full More...
 
object ShadowBrightnessTex [get, set]
 Same as shadow_brightness but used for the Maya's useBackground shader which supports textures as shadow brightness [UI Guides] gpuSupport=none
 
bool Shadows [get, set]
 Turn this on to make shadows visible on the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=full More...
 
bool ShadowsReceive [get, set]
 Whether the object receives shadows [UI Guides] gpuSupport=full More...
 
bool ShadowsVisibility [get, set]
 Whether the object casts shadows (visible to lights for shadow rays) [UI Guides] gpuSupport=full More...
 
Color ShadowTintColor [get, set]
 Tint for the shadows on the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=full More...
 
int TraceDepth [get, set]
 The maximum reflection depth (-1 is controlled by the global options) [UI Guides] gpuSupport=none More...
 
bool UseIrradMap [get, set]
 Allow enable/disable of irradiance map per surface. [UI Guides] displayName=Use irradiance map, startRollout=Additional surface properties, gpuSupport=none More...
 
float Visibility [get, set]
 Overall visibility [UI Guides] minValue=0, maxValue=1, gpuSupport=full More...
 
bool WrapperUse [get, set]
 Use Wrapper properties. 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< VRayObjectProperties >
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

Combines MtlWrapper and MtlRenderStats functionality to be used as a direct reference in Node instances. This means it adds both Matte properties for the Node and options to control primary visibility and shadow visibility of the Node. Note that the GPU implementation currently requires using a dedicated VRayObjectProperties instance for each unique Node and Node::material pair. [gpuSupport=(partial)]

Member Function Documentation

◆ Get_AffectAlpha()

bool VRay.Plugins.VRayObjectProperties.Get_AffectAlpha ( double  time)

Gets the value of VRayObjectProperties.AffectAlpha

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

◆ Get_AlphaContribution()

float VRay.Plugins.VRayObjectProperties.Get_AlphaContribution ( double  time)

Gets the value of VRayObjectProperties.AlphaContribution

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

◆ Get_AlphaContributionTex()

object VRay.Plugins.VRayObjectProperties.Get_AlphaContributionTex ( double  time)

Gets the value of VRayObjectProperties.AlphaContributionTex

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

◆ Get_CameraVisibility()

bool VRay.Plugins.VRayObjectProperties.Get_CameraVisibility ( double  time)

Gets the value of VRayObjectProperties.CameraVisibility

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

◆ Get_Channels()

IList< object > VRay.Plugins.VRayObjectProperties.Get_Channels ( double  time)

Gets the value of VRayObjectProperties.Channels

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

◆ Get_GenerateCaustics()

float VRay.Plugins.VRayObjectProperties.Get_GenerateCaustics ( double  time)

Gets the value of VRayObjectProperties.GenerateCaustics

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

◆ Get_GenerateGi()

float VRay.Plugins.VRayObjectProperties.Get_GenerateGi ( double  time)

Gets the value of VRayObjectProperties.GenerateGi

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

◆ Get_GenerateRenderElements()

bool VRay.Plugins.VRayObjectProperties.Get_GenerateRenderElements ( double  time)

Gets the value of VRayObjectProperties.GenerateRenderElements

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

◆ Get_GiAmount()

float VRay.Plugins.VRayObjectProperties.Get_GiAmount ( double  time)

Gets the value of VRayObjectProperties.GiAmount

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

◆ Get_GiQualityMultiplier()

float VRay.Plugins.VRayObjectProperties.Get_GiQualityMultiplier ( double  time)

Gets the value of VRayObjectProperties.GiQualityMultiplier

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

◆ Get_GiSurfaceId()

int VRay.Plugins.VRayObjectProperties.Get_GiSurfaceId ( double  time)

Gets the value of VRayObjectProperties.GiSurfaceId

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

◆ Get_GiVisibility()

bool VRay.Plugins.VRayObjectProperties.Get_GiVisibility ( double  time)

Gets the value of VRayObjectProperties.GiVisibility

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

◆ Get_MatteForSecondaryRays()

int VRay.Plugins.VRayObjectProperties.Get_MatteForSecondaryRays ( double  time)

Gets the value of VRayObjectProperties.MatteForSecondaryRays

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

◆ Get_MatteSurface()

bool VRay.Plugins.VRayObjectProperties.Get_MatteSurface ( double  time)

Gets the value of VRayObjectProperties.MatteSurface

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

◆ Get_MayaBackgroundShaderCompatibility()

bool VRay.Plugins.VRayObjectProperties.Get_MayaBackgroundShaderCompatibility ( double  time)

Gets the value of VRayObjectProperties.MayaBackgroundShaderCompatibility

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

◆ Get_NoGiOnOtherMattes()

bool VRay.Plugins.VRayObjectProperties.Get_NoGiOnOtherMattes ( double  time)

Gets the value of VRayObjectProperties.NoGiOnOtherMattes

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

◆ Get_ReceiveCaustics()

float VRay.Plugins.VRayObjectProperties.Get_ReceiveCaustics ( double  time)

Gets the value of VRayObjectProperties.ReceiveCaustics

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

◆ Get_ReceiveGi()

float VRay.Plugins.VRayObjectProperties.Get_ReceiveGi ( double  time)

Gets the value of VRayObjectProperties.ReceiveGi

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

◆ Get_ReflectionAmount()

float VRay.Plugins.VRayObjectProperties.Get_ReflectionAmount ( double  time)

Gets the value of VRayObjectProperties.ReflectionAmount

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

◆ Get_ReflectionExclude()

IList< object > VRay.Plugins.VRayObjectProperties.Get_ReflectionExclude ( double  time)

Gets the value of VRayObjectProperties.ReflectionExclude

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

◆ Get_ReflectionFilterTex()

object VRay.Plugins.VRayObjectProperties.Get_ReflectionFilterTex ( double  time)

Gets the value of VRayObjectProperties.ReflectionFilterTex

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

◆ Get_ReflectionListIsInclusive()

bool VRay.Plugins.VRayObjectProperties.Get_ReflectionListIsInclusive ( double  time)

Gets the value of VRayObjectProperties.ReflectionListIsInclusive

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

◆ Get_ReflectionsVisibility()

bool VRay.Plugins.VRayObjectProperties.Get_ReflectionsVisibility ( double  time)

Gets the value of VRayObjectProperties.ReflectionsVisibility

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

◆ Get_RefractionAmount()

float VRay.Plugins.VRayObjectProperties.Get_RefractionAmount ( double  time)

Gets the value of VRayObjectProperties.RefractionAmount

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

◆ Get_RefractionExclude()

IList< object > VRay.Plugins.VRayObjectProperties.Get_RefractionExclude ( double  time)

Gets the value of VRayObjectProperties.RefractionExclude

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

◆ Get_RefractionListIsInclusive()

bool VRay.Plugins.VRayObjectProperties.Get_RefractionListIsInclusive ( double  time)

Gets the value of VRayObjectProperties.RefractionListIsInclusive

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

◆ Get_RefractionsVisibility()

bool VRay.Plugins.VRayObjectProperties.Get_RefractionsVisibility ( double  time)

Gets the value of VRayObjectProperties.RefractionsVisibility

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

◆ Get_RenderStatsUse()

bool VRay.Plugins.VRayObjectProperties.Get_RenderStatsUse ( double  time)

Gets the value of VRayObjectProperties.RenderStatsUse

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

◆ Get_ShadowBrightness()

float VRay.Plugins.VRayObjectProperties.Get_ShadowBrightness ( double  time)

Gets the value of VRayObjectProperties.ShadowBrightness

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

◆ Get_ShadowBrightnessTex()

object VRay.Plugins.VRayObjectProperties.Get_ShadowBrightnessTex ( double  time)

Gets the value of VRayObjectProperties.ShadowBrightnessTex

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

◆ Get_Shadows()

bool VRay.Plugins.VRayObjectProperties.Get_Shadows ( double  time)

Gets the value of VRayObjectProperties.Shadows

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

◆ Get_ShadowsReceive()

bool VRay.Plugins.VRayObjectProperties.Get_ShadowsReceive ( double  time)

Gets the value of VRayObjectProperties.ShadowsReceive

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

◆ Get_ShadowsVisibility()

bool VRay.Plugins.VRayObjectProperties.Get_ShadowsVisibility ( double  time)

Gets the value of VRayObjectProperties.ShadowsVisibility

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

◆ Get_ShadowTintColor()

Color VRay.Plugins.VRayObjectProperties.Get_ShadowTintColor ( double  time)

Gets the value of VRayObjectProperties.ShadowTintColor

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

◆ Get_TraceDepth()

int VRay.Plugins.VRayObjectProperties.Get_TraceDepth ( double  time)

Gets the value of VRayObjectProperties.TraceDepth

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

◆ Get_UseIrradMap()

bool VRay.Plugins.VRayObjectProperties.Get_UseIrradMap ( double  time)

Gets the value of VRayObjectProperties.UseIrradMap

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

◆ Get_Visibility()

float VRay.Plugins.VRayObjectProperties.Get_Visibility ( double  time)

Gets the value of VRayObjectProperties.Visibility

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

◆ Get_WrapperUse()

bool VRay.Plugins.VRayObjectProperties.Get_WrapperUse ( double  time)

Gets the value of VRayObjectProperties.WrapperUse

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

◆ Set_AffectAlpha()

bool VRay.Plugins.VRayObjectProperties.Set_AffectAlpha ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.AffectAlpha

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

◆ Set_AlphaContribution()

bool VRay.Plugins.VRayObjectProperties.Set_AlphaContribution ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.AlphaContribution

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

◆ Set_AlphaContributionTex()

bool VRay.Plugins.VRayObjectProperties.Set_AlphaContributionTex ( object  val,
double  time 
)

Sets a value to VRayObjectProperties.AlphaContributionTex

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

◆ Set_CameraVisibility()

bool VRay.Plugins.VRayObjectProperties.Set_CameraVisibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.CameraVisibility

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

◆ Set_Channels()

bool VRay.Plugins.VRayObjectProperties.Set_Channels ( IList< object >  val,
double  time 
)

Sets a value to VRayObjectProperties.Channels

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

◆ Set_GenerateCaustics()

bool VRay.Plugins.VRayObjectProperties.Set_GenerateCaustics ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.GenerateCaustics

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

◆ Set_GenerateGi()

bool VRay.Plugins.VRayObjectProperties.Set_GenerateGi ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.GenerateGi

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

◆ Set_GenerateRenderElements()

bool VRay.Plugins.VRayObjectProperties.Set_GenerateRenderElements ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.GenerateRenderElements

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

◆ Set_GiAmount()

bool VRay.Plugins.VRayObjectProperties.Set_GiAmount ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.GiAmount

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

◆ Set_GiQualityMultiplier()

bool VRay.Plugins.VRayObjectProperties.Set_GiQualityMultiplier ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.GiQualityMultiplier

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

◆ Set_GiSurfaceId()

bool VRay.Plugins.VRayObjectProperties.Set_GiSurfaceId ( int  val,
double  time 
)

Sets a value to VRayObjectProperties.GiSurfaceId

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

◆ Set_GiVisibility()

bool VRay.Plugins.VRayObjectProperties.Set_GiVisibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.GiVisibility

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

◆ Set_MatteForSecondaryRays()

bool VRay.Plugins.VRayObjectProperties.Set_MatteForSecondaryRays ( int  val,
double  time 
)

Sets a value to VRayObjectProperties.MatteForSecondaryRays

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

◆ Set_MatteSurface()

bool VRay.Plugins.VRayObjectProperties.Set_MatteSurface ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.MatteSurface

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

◆ Set_MayaBackgroundShaderCompatibility()

bool VRay.Plugins.VRayObjectProperties.Set_MayaBackgroundShaderCompatibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.MayaBackgroundShaderCompatibility

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

◆ Set_NoGiOnOtherMattes()

bool VRay.Plugins.VRayObjectProperties.Set_NoGiOnOtherMattes ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.NoGiOnOtherMattes

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

◆ Set_ReceiveCaustics()

bool VRay.Plugins.VRayObjectProperties.Set_ReceiveCaustics ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.ReceiveCaustics

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

◆ Set_ReceiveGi()

bool VRay.Plugins.VRayObjectProperties.Set_ReceiveGi ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.ReceiveGi

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

◆ Set_ReflectionAmount()

bool VRay.Plugins.VRayObjectProperties.Set_ReflectionAmount ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.ReflectionAmount

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

◆ Set_ReflectionExclude()

bool VRay.Plugins.VRayObjectProperties.Set_ReflectionExclude ( IList< object >  val,
double  time 
)

Sets a value to VRayObjectProperties.ReflectionExclude

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

◆ Set_ReflectionFilterTex()

bool VRay.Plugins.VRayObjectProperties.Set_ReflectionFilterTex ( object  val,
double  time 
)

Sets a value to VRayObjectProperties.ReflectionFilterTex

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

◆ Set_ReflectionListIsInclusive()

bool VRay.Plugins.VRayObjectProperties.Set_ReflectionListIsInclusive ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.ReflectionListIsInclusive

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

◆ Set_ReflectionsVisibility()

bool VRay.Plugins.VRayObjectProperties.Set_ReflectionsVisibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.ReflectionsVisibility

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

◆ Set_RefractionAmount()

bool VRay.Plugins.VRayObjectProperties.Set_RefractionAmount ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.RefractionAmount

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

◆ Set_RefractionExclude()

bool VRay.Plugins.VRayObjectProperties.Set_RefractionExclude ( IList< object >  val,
double  time 
)

Sets a value to VRayObjectProperties.RefractionExclude

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

◆ Set_RefractionListIsInclusive()

bool VRay.Plugins.VRayObjectProperties.Set_RefractionListIsInclusive ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.RefractionListIsInclusive

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

◆ Set_RefractionsVisibility()

bool VRay.Plugins.VRayObjectProperties.Set_RefractionsVisibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.RefractionsVisibility

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

◆ Set_RenderStatsUse()

bool VRay.Plugins.VRayObjectProperties.Set_RenderStatsUse ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.RenderStatsUse

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

◆ Set_ShadowBrightness()

bool VRay.Plugins.VRayObjectProperties.Set_ShadowBrightness ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.ShadowBrightness

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

◆ Set_ShadowBrightnessTex()

bool VRay.Plugins.VRayObjectProperties.Set_ShadowBrightnessTex ( object  val,
double  time 
)

Sets a value to VRayObjectProperties.ShadowBrightnessTex

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

◆ Set_Shadows()

bool VRay.Plugins.VRayObjectProperties.Set_Shadows ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.Shadows

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

◆ Set_ShadowsReceive()

bool VRay.Plugins.VRayObjectProperties.Set_ShadowsReceive ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.ShadowsReceive

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

◆ Set_ShadowsVisibility()

bool VRay.Plugins.VRayObjectProperties.Set_ShadowsVisibility ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.ShadowsVisibility

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

◆ Set_ShadowTintColor()

bool VRay.Plugins.VRayObjectProperties.Set_ShadowTintColor ( Color  val,
double  time 
)

Sets a value to VRayObjectProperties.ShadowTintColor

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

◆ Set_TraceDepth()

bool VRay.Plugins.VRayObjectProperties.Set_TraceDepth ( int  val,
double  time 
)

Sets a value to VRayObjectProperties.TraceDepth

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

◆ Set_UseIrradMap()

bool VRay.Plugins.VRayObjectProperties.Set_UseIrradMap ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.UseIrradMap

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

◆ Set_Visibility()

bool VRay.Plugins.VRayObjectProperties.Set_Visibility ( float  val,
double  time 
)

Sets a value to VRayObjectProperties.Visibility

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

◆ Set_WrapperUse()

bool VRay.Plugins.VRayObjectProperties.Set_WrapperUse ( bool  val,
double  time 
)

Sets a value to VRayObjectProperties.WrapperUse

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

Property Documentation

◆ AffectAlpha

bool VRay.Plugins.VRayObjectProperties.AffectAlpha
getset

Turn this on to make shadows affect the alpha contribution of the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=partial

Default value: 0

◆ AlphaContribution

float VRay.Plugins.VRayObjectProperties.AlphaContribution
getset

The contribution of the resulting color to the alpha channel. [UI Guides] startRollout=Matte properties, minValue=-1, maxValue=1, gpuSupport=partial

Default value: 1

◆ CameraVisibility

bool VRay.Plugins.VRayObjectProperties.CameraVisibility
getset

Whether the object is visible from the camera (camera rays) [UI Guides] gpuSupport=full

Default value: 1

◆ GenerateCaustics

float VRay.Plugins.VRayObjectProperties.GenerateCaustics
getset

Controls the caustics generated by the material. [UI Guides] displayName=Generated caustics mult., minValue=0.0, gpuSupport=none

Default value: 1

◆ GenerateGi

float VRay.Plugins.VRayObjectProperties.GenerateGi
getset

Controls the GI generated by the material. [UI Guides] displayName=Generated GI mult., minValue=0.0, gpuSupport=full

Default value: 1

◆ GenerateRenderElements

bool VRay.Plugins.VRayObjectProperties.GenerateRenderElements
getset

Setting this to false makes objects to not affect the render elements. [UI Guides] gpuSupport=none

Default value: 1

◆ GiAmount

float VRay.Plugins.VRayObjectProperties.GiAmount
getset

Determines the amount of gi shadows. [UI Guides] displayName=GI amount, enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=none

Default value: 1

◆ GiQualityMultiplier

float VRay.Plugins.VRayObjectProperties.GiQualityMultiplier
getset

This is a multiplier for the subdivisions of all secondary ray tracing done for the particular surface. [UI Guides] displayName=Subdivs multiplier, minValue0.0, gpuSupport=none

Default value: 1

◆ GiSurfaceId

int VRay.Plugins.VRayObjectProperties.GiSurfaceId
getset

If two objects have different GI surface ids, the light cache samples of the two objects will not be blended. [UI Guides] displayName=GI surface ID, minValue0, startRollout=Miscellaneous, gpuSupport=none

Default value: 0

◆ GiVisibility

bool VRay.Plugins.VRayObjectProperties.GiVisibility
getset

Whether the object is visible to GI (generating and receiving) [UI Guides] gpuSupport=full

Default value: 1

◆ MatteForSecondaryRays

int VRay.Plugins.VRayObjectProperties.MatteForSecondaryRays
getset

Set this to 1 to make the material act as matte for all secondary rays (reflections and refractions); if set to 2, the material will perform automatic projection mapping of the environment map on the matte geometry [UI Guides] displayName=Matte for sec. rays, enum=0:Disable;1:Without Projection Mapping;2:With Projection Mapping, enableIf: ?matte_surface=1, gpuSupport=partial

Default value: 0

◆ MatteSurface

bool VRay.Plugins.VRayObjectProperties.MatteSurface
getset

Makes the material appear as a matte material, which shows the background, instead of the base material, when viewed directly. [UI Guides] gpuSupport=partial

Default value: 0

◆ MayaBackgroundShaderCompatibility

bool VRay.Plugins.VRayObjectProperties.MayaBackgroundShaderCompatibility
getset

Setting this to true will make the matte alpha opaque so that the alpha of objects behind the matte won't be seen. [UI Guides] gpuSupport=none

Default value: 0

◆ NoGiOnOtherMattes

bool VRay.Plugins.VRayObjectProperties.NoGiOnOtherMattes
getset

This will cause the material to appear as a matte object in reflections, refractions, GI etc for other matte objects. [UI Guides] displayName=No GI on other mattes, enableIf: ?matte_surface=1, gpuSupport=none

Default value: 1

◆ ReceiveCaustics

float VRay.Plugins.VRayObjectProperties.ReceiveCaustics
getset

Controls the caustics received by the material. [UI Guides] displayName=Received caustics mult., minValue=0.0, gpuSupport=none

Default value: 1

◆ ReceiveGi

float VRay.Plugins.VRayObjectProperties.ReceiveGi
getset

Controls the GI received by the material. [UI Guides] displayName=Received GI mult., minValue=0.0, gpuSupport=full

Default value: 1

◆ ReflectionAmount

float VRay.Plugins.VRayObjectProperties.ReflectionAmount
getset

Shows the reflections of the base material. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full

Default value: 1

◆ ReflectionListIsInclusive

bool VRay.Plugins.VRayObjectProperties.ReflectionListIsInclusive
getset

Setting this to true will turn the reflection exclude list into inclusive (inverted). [UI Guides] gpuSupport=none

Default value: 0

◆ ReflectionsVisibility

bool VRay.Plugins.VRayObjectProperties.ReflectionsVisibility
getset

Whether the object is visible in reflections [UI Guides] gpuSupport=full

Default value: 1

◆ RefractionAmount

float VRay.Plugins.VRayObjectProperties.RefractionAmount
getset

Shows the refractions of the base material. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full

Default value: 1

◆ RefractionListIsInclusive

bool VRay.Plugins.VRayObjectProperties.RefractionListIsInclusive
getset

Setting this to true will turn the refraction exclude list into inclusive (inverted). [UI Guides] gpuSupport=none

Default value: 0

◆ RefractionsVisibility

bool VRay.Plugins.VRayObjectProperties.RefractionsVisibility
getset

Whether the object is visible in refractions [UI Guides] gpuSupport=full

Default value: 1

◆ RenderStatsUse

bool VRay.Plugins.VRayObjectProperties.RenderStatsUse
getset

Use RenderStats properties.

Default value: 0

◆ ShadowBrightness

float VRay.Plugins.VRayObjectProperties.ShadowBrightness
getset

An optional brightness parameter for the shadows on the matte surface.A value of 0.0 will make the shadows completely invisible, while a value of 1.0 will show the full shadows. [UI Guides] enableIf: ?matte_surface=1, minValue=0, maxValue=1, gpuSupport=full

Default value: 1

◆ Shadows

bool VRay.Plugins.VRayObjectProperties.Shadows
getset

Turn this on to make shadows visible on the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=full

Default value: 0

◆ ShadowsReceive

bool VRay.Plugins.VRayObjectProperties.ShadowsReceive
getset

Whether the object receives shadows [UI Guides] gpuSupport=full

Default value: 1

◆ ShadowsVisibility

bool VRay.Plugins.VRayObjectProperties.ShadowsVisibility
getset

Whether the object casts shadows (visible to lights for shadow rays) [UI Guides] gpuSupport=full

Default value: 1

◆ ShadowTintColor

Color VRay.Plugins.VRayObjectProperties.ShadowTintColor
getset

Tint for the shadows on the matte surface. [UI Guides] enableIf: ?matte_surface=1, gpuSupport=full

Default value: Color(0, 0, 0)

◆ TraceDepth

int VRay.Plugins.VRayObjectProperties.TraceDepth
getset

The maximum reflection depth (-1 is controlled by the global options) [UI Guides] gpuSupport=none

Default value: -1

◆ UseIrradMap

bool VRay.Plugins.VRayObjectProperties.UseIrradMap
getset

Allow enable/disable of irradiance map per surface. [UI Guides] displayName=Use irradiance map, startRollout=Additional surface properties, gpuSupport=none

Default value: 1

◆ Visibility

float VRay.Plugins.VRayObjectProperties.Visibility
getset

Overall visibility [UI Guides] minValue=0, maxValue=1, gpuSupport=full

Default value: 1

◆ WrapperUse

bool VRay.Plugins.VRayObjectProperties.WrapperUse
getset

Use Wrapper properties.

Default value: 0


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