Geometry source plugin that feeds a top-level plugin such as Node. Efficiently instances objects in the scene. Often used for particles and vegetation. [gpuSupport=(partial)] More...

Inherits VRay.Plugins.Plugin, VRay.Plugins.IPluginRef< Instancer2 >, and VRay.Plugins.IGeometrySourcePluginCategory.

Public Member Functions
IList< Color >	Get_AccelerationPp (double time)
	Gets the value of Instancer2.AccelerationPp More...

IList< float >	Get_AgePp (double time)
	Gets the value of Instancer2.AgePp More...

IList< Color >	Get_Colors (double time)
	Gets the value of Instancer2.Colors More...

IList< Color >	Get_EmissionPp (double time)
	Gets the value of Instancer2.EmissionPp More...

IList< object >	Get_ExtraChannels (double time)
	Gets the value of Instancer2.ExtraChannels More...

IList< object >	Get_Instances (double time)
	Gets the value of Instancer2.Instances More...

IPluginRef	Get_InstancesMaterialOverride (double time)
	Gets the value of Instancer2.InstancesMaterialOverride More...

IList< float >	Get_LifespanPp (double time)
	Gets the value of Instancer2.LifespanPp More...

int	Get_Nsamples (double time)
	Gets the value of Instancer2.Nsamples More...

IList< float >	Get_OpacityPp (double time)
	Gets the value of Instancer2.OpacityPp More...

int	Get_RenderIdsGenMode (double time)
	Gets the value of Instancer2.RenderIdsGenMode More...

bool	Get_ShadingNeedsIds (double time)
	Gets the value of Instancer2.ShadingNeedsIds More...

bool	Get_UseAdditionalParams (double time)
	Gets the value of Instancer2.UseAdditionalParams More...

bool	Get_UseDirectVelocity (double time)
	Gets the value of Instancer2.UseDirectVelocity More...

IList< Color >	Get_UserColorPp1 (double time)
	Gets the value of Instancer2.UserColorPp1 More...

IList< Color >	Get_UserColorPp2 (double time)
	Gets the value of Instancer2.UserColorPp2 More...

IList< Color >	Get_UserColorPp3 (double time)
	Gets the value of Instancer2.UserColorPp3 More...

IList< Color >	Get_UserColorPp4 (double time)
	Gets the value of Instancer2.UserColorPp4 More...

IList< Color >	Get_UserColorPp5 (double time)
	Gets the value of Instancer2.UserColorPp5 More...

IList< float >	Get_UserFloatPp1 (double time)
	Gets the value of Instancer2.UserFloatPp1 More...

IList< float >	Get_UserFloatPp2 (double time)
	Gets the value of Instancer2.UserFloatPp2 More...

IList< float >	Get_UserFloatPp3 (double time)
	Gets the value of Instancer2.UserFloatPp3 More...

IList< float >	Get_UserFloatPp4 (double time)
	Gets the value of Instancer2.UserFloatPp4 More...

IList< float >	Get_UserFloatPp5 (double time)
	Gets the value of Instancer2.UserFloatPp5 More...

int	Get_UseTimeInstancing (double time)
	Gets the value of Instancer2.UseTimeInstancing More...

bool	Get_UseVisibility (double time)
	Gets the value of Instancer2.UseVisibility More...

bool	Get_Visible (double time)
	Gets the value of Instancer2.Visible More...

bool	Set_AccelerationPp (IList< Color > val, double time)
	Sets a value to Instancer2.AccelerationPp More...

bool	Set_AgePp (IList< float > val, double time)
	Sets a value to Instancer2.AgePp More...

bool	Set_Colors (IList< Color > val, double time)
	Sets a value to Instancer2.Colors More...

bool	Set_EmissionPp (IList< Color > val, double time)
	Sets a value to Instancer2.EmissionPp More...

bool	Set_ExtraChannels (IList< object > val, double time)
	Sets a value to Instancer2.ExtraChannels More...

bool	Set_Instances (IList< object > val, double time)
	Sets a value to Instancer2.Instances More...

bool	Set_InstancesMaterialOverride (IPluginRef val, double time)
	Sets a value to Instancer2.InstancesMaterialOverride More...

bool	Set_LifespanPp (IList< float > val, double time)
	Sets a value to Instancer2.LifespanPp More...

bool	Set_Nsamples (int val, double time)
	Sets a value to Instancer2.Nsamples More...

bool	Set_OpacityPp (IList< float > val, double time)
	Sets a value to Instancer2.OpacityPp More...

bool	Set_RenderIdsGenMode (int val, double time)
	Sets a value to Instancer2.RenderIdsGenMode More...

bool	Set_ShadingNeedsIds (bool val, double time)
	Sets a value to Instancer2.ShadingNeedsIds More...

bool	Set_UseAdditionalParams (bool val, double time)
	Sets a value to Instancer2.UseAdditionalParams More...

bool	Set_UseDirectVelocity (bool val, double time)
	Sets a value to Instancer2.UseDirectVelocity More...

bool	Set_UserColorPp1 (IList< Color > val, double time)
	Sets a value to Instancer2.UserColorPp1 More...

bool	Set_UserColorPp2 (IList< Color > val, double time)
	Sets a value to Instancer2.UserColorPp2 More...

bool	Set_UserColorPp3 (IList< Color > val, double time)
	Sets a value to Instancer2.UserColorPp3 More...

bool	Set_UserColorPp4 (IList< Color > val, double time)
	Sets a value to Instancer2.UserColorPp4 More...

bool	Set_UserColorPp5 (IList< Color > val, double time)
	Sets a value to Instancer2.UserColorPp5 More...

bool	Set_UserFloatPp1 (IList< float > val, double time)
	Sets a value to Instancer2.UserFloatPp1 More...

bool	Set_UserFloatPp2 (IList< float > val, double time)
	Sets a value to Instancer2.UserFloatPp2 More...

bool	Set_UserFloatPp3 (IList< float > val, double time)
	Sets a value to Instancer2.UserFloatPp3 More...

bool	Set_UserFloatPp4 (IList< float > val, double time)
	Sets a value to Instancer2.UserFloatPp4 More...

bool	Set_UserFloatPp5 (IList< float > val, double time)
	Sets a value to Instancer2.UserFloatPp5 More...

bool	Set_UseTimeInstancing (int val, double time)
	Sets a value to Instancer2.UseTimeInstancing More...

bool	Set_UseVisibility (bool val, double time)
	Sets a value to Instancer2.UseVisibility More...

bool	Set_Visible (bool val, double time)
	Sets a value to Instancer2.Visible 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< Instancer2 >
string	ToString ()

new string	ToString ()

Static Public Member Functions
static Instancer2	GetInstance (VRayRenderer renderer, string name)
	Use renderer to find and return a Instancer2 instance with the given name

static Instancer2	NewInstance (VRayRenderer renderer, string name)
	Use renderer to create and return a Instancer2 instance

Properties
IList< Color >	AccelerationPp `[get, set]`
	Per-particle acceleration. [UI Guides] gpuSupport=none More...

IList< float >	AgePp `[get, set]`
	Per-particle age. [UI Guides] gpuSupport=none More...

IList< Color >	Colors `[get, set]`
	Per-particle diffuse color. [UI Guides] gpuSupport=none More...

IList< Color >	EmissionPp `[get, set]`
	Per-particle emission color. [UI Guides] gpuSupport=none More...

IList< object >	ExtraChannels `[get, set]`
	Extra channels that hold auxiliary instances data [UI Guides] gpuSupport=full

IList< object >	Instances `[get, set]`
	A list of N+1 elements where N is the number of instances; the first element is a time value, the rest are lists with elements: particle id, transform, velocity transform, hasInstanceTime, instanceTime, additional_params_flags, additional_param_1, ..., additional_param_N, visibility, node, node, node, ... [UI Guides] gpuSupport=full

IPluginRef	InstancesMaterialOverride `[get, set]`
	Use override material even if particle has a material specified.

IList< float >	LifespanPp `[get, set]`
	Per-particle lifespan. [UI Guides] gpuSupport=none More...

int	Nsamples `[get, set]`
	Number of transform samples for motion blur [UI Guides] gpuSupport=full More...

IList< float >	OpacityPp `[get, set]`
	Per-particle opacity. [UI Guides] gpuSupport=none More...

int	RenderIdsGenMode `[get, set]`
	Values for this parameter other than 0 are EXPERIMENTAL and WORK IN PROGRESS. This parameter tells the Instancer how to generate the render IDs for its instances. 0 - each instance has the same render ID as its source Node. 1 - all instances have the same render ID even those generated from different Nodes. 2 - all instances have different render IDs even those generated from the same Node. [UI Guides] displayName=Render IDs Mode, enum=0:Same as source Node;1:Same for all instances;2:Different for all instances More...

bool	ShadingNeedsIds `[get, set]`
	Set to true if the particle shade data sent to the instanced geometry needs to include the particle ID. [UI Guides] gpuSupport=none More...

bool	UseAdditionalParams `[get, set]`
	If this is set to 'true' the lists in the 'instances' parameter have additional parameters after 'time instancing' parameters - an int with flags indicating what parameters follow and after that the parameters that follow. Their types depend on the flags in the int and are in a strictly defined order. New flags may be added and additional parameters for them can be added at the end of the chain. The flags are defined in HierarchicalParameterizedNodeParameters in an enum. [UI Guides] gpuSupport=full More...

bool	UseDirectVelocity `[get, set]`
	Directly interpolate particle velocity. [UI Guides] gpuSupport=full More...

IList< Color >	UserColorPp1 `[get, set]`
	Corresponds to Maya's userVector1PP. [UI Guides] gpuSupport=none More...

IList< Color >	UserColorPp2 `[get, set]`
	Corresponds to Maya's userVector2PP. [UI Guides] gpuSupport=none More...

IList< Color >	UserColorPp3 `[get, set]`
	Corresponds to Maya's userVector3PP. [UI Guides] gpuSupport=none More...

IList< Color >	UserColorPp4 `[get, set]`
	Corresponds to Maya's userVector4PP. [UI Guides] gpuSupport=none More...

IList< Color >	UserColorPp5 `[get, set]`
	Corresponds to Maya's userVector5PP. [UI Guides] gpuSupport=none More...

IList< float >	UserFloatPp1 `[get, set]`
	Corresponds to Maya's userScalar1PP. [UI Guides] gpuSupport=none More...

IList< float >	UserFloatPp2 `[get, set]`
	Corresponds to Maya's userScalar2PP. [UI Guides] gpuSupport=none More...

IList< float >	UserFloatPp3 `[get, set]`
	Corresponds to Maya's userScalar3PP. [UI Guides] gpuSupport=none More...

IList< float >	UserFloatPp4 `[get, set]`
	Corresponds to Maya's userScalar4PP. [UI Guides] gpuSupport=none More...

IList< float >	UserFloatPp5 `[get, set]`
	Corresponds to Maya's userScalar5PP. [UI Guides] gpuSupport=none More...

int	UseTimeInstancing `[get, set]`
	If this is set to 1 or 2 the 'instances' parameter will contain the elements hasInstanceTime (bool) and instanceTime (double). Otherwise, they should not be present.0 - no time instancing applied. 1 - time instancing applied - only sequential times/samples permitted2 - time instancing applied - arbitrary times/samples permitted (used along with TimeInstancedGeom) [UI Guides] gpuSupport=full More...

bool	UseVisibility `[get, set]`
	Use particle visibility. If set to 'true' the lists in the 'instances' parameter have particle visibility parameter after 'additional parameters'. [UI Guides] gpuSupport=full More...

bool	Visible `[get, set]`
	If false, no geometry will be generated and rendered [UI Guides] 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< Instancer2 >
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

Geometry source plugin that feeds a top-level plugin such as Node. Efficiently instances objects in the scene. Often used for particles and vegetation. [gpuSupport=(partial)]

Member Function Documentation

◆ Get_AccelerationPp()

IList< Color > VRay.Plugins.Instancer2.Get_AccelerationPp ( double time )

Gets the value of Instancer2.AccelerationPp

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_AgePp()

IList< float > VRay.Plugins.Instancer2.Get_AgePp ( double time )

Gets the value of Instancer2.AgePp

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_Colors()

IList< Color > VRay.Plugins.Instancer2.Get_Colors ( double time )

Gets the value of Instancer2.Colors

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_EmissionPp()

IList< Color > VRay.Plugins.Instancer2.Get_EmissionPp ( double time )

Gets the value of Instancer2.EmissionPp

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ExtraChannels()

IList< object > VRay.Plugins.Instancer2.Get_ExtraChannels ( double time )

Gets the value of Instancer2.ExtraChannels

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_Instances()

IList< object > VRay.Plugins.Instancer2.Get_Instances ( double time )

Gets the value of Instancer2.Instances

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_InstancesMaterialOverride()

IPluginRef VRay.Plugins.Instancer2.Get_InstancesMaterialOverride ( double time )

Gets the value of Instancer2.InstancesMaterialOverride

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_LifespanPp()

IList< float > VRay.Plugins.Instancer2.Get_LifespanPp ( double time )

Gets the value of Instancer2.LifespanPp

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_Nsamples()

int VRay.Plugins.Instancer2.Get_Nsamples ( double time )

Gets the value of Instancer2.Nsamples

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_OpacityPp()

IList< float > VRay.Plugins.Instancer2.Get_OpacityPp ( double time )

Gets the value of Instancer2.OpacityPp

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_RenderIdsGenMode()

int VRay.Plugins.Instancer2.Get_RenderIdsGenMode ( double time )

Gets the value of Instancer2.RenderIdsGenMode

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ShadingNeedsIds()

bool VRay.Plugins.Instancer2.Get_ShadingNeedsIds ( double time )

Gets the value of Instancer2.ShadingNeedsIds

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UseAdditionalParams()

bool VRay.Plugins.Instancer2.Get_UseAdditionalParams ( double time )

Gets the value of Instancer2.UseAdditionalParams

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UseDirectVelocity()

bool VRay.Plugins.Instancer2.Get_UseDirectVelocity ( double time )

Gets the value of Instancer2.UseDirectVelocity

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserColorPp1()

IList< Color > VRay.Plugins.Instancer2.Get_UserColorPp1 ( double time )

Gets the value of Instancer2.UserColorPp1

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserColorPp2()

IList< Color > VRay.Plugins.Instancer2.Get_UserColorPp2 ( double time )

Gets the value of Instancer2.UserColorPp2

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserColorPp3()

IList< Color > VRay.Plugins.Instancer2.Get_UserColorPp3 ( double time )

Gets the value of Instancer2.UserColorPp3

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserColorPp4()

IList< Color > VRay.Plugins.Instancer2.Get_UserColorPp4 ( double time )

Gets the value of Instancer2.UserColorPp4

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserColorPp5()

IList< Color > VRay.Plugins.Instancer2.Get_UserColorPp5 ( double time )

Gets the value of Instancer2.UserColorPp5

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserFloatPp1()

IList< float > VRay.Plugins.Instancer2.Get_UserFloatPp1 ( double time )

Gets the value of Instancer2.UserFloatPp1

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserFloatPp2()

IList< float > VRay.Plugins.Instancer2.Get_UserFloatPp2 ( double time )

Gets the value of Instancer2.UserFloatPp2

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserFloatPp3()

IList< float > VRay.Plugins.Instancer2.Get_UserFloatPp3 ( double time )

Gets the value of Instancer2.UserFloatPp3

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserFloatPp4()

IList< float > VRay.Plugins.Instancer2.Get_UserFloatPp4 ( double time )

Gets the value of Instancer2.UserFloatPp4

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UserFloatPp5()

IList< float > VRay.Plugins.Instancer2.Get_UserFloatPp5 ( double time )

Gets the value of Instancer2.UserFloatPp5

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UseTimeInstancing()

int VRay.Plugins.Instancer2.Get_UseTimeInstancing ( double time )

Gets the value of Instancer2.UseTimeInstancing

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_UseVisibility()

bool VRay.Plugins.Instancer2.Get_UseVisibility ( double time )

Gets the value of Instancer2.UseVisibility

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_Visible()

bool VRay.Plugins.Instancer2.Get_Visible ( double time )

Gets the value of Instancer2.Visible

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Set_AccelerationPp()

bool VRay.Plugins.Instancer2.Set_AccelerationPp	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.AccelerationPp

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_AgePp()

bool VRay.Plugins.Instancer2.Set_AgePp	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.AgePp

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_Colors()

bool VRay.Plugins.Instancer2.Set_Colors	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.Colors

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_EmissionPp()

bool VRay.Plugins.Instancer2.Set_EmissionPp	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.EmissionPp

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ExtraChannels()

bool VRay.Plugins.Instancer2.Set_ExtraChannels	(	IList< object >	val,
		double	time
	)

Sets a value to Instancer2.ExtraChannels

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_Instances()

bool VRay.Plugins.Instancer2.Set_Instances	(	IList< object >	val,
		double	time
	)

Sets a value to Instancer2.Instances

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_InstancesMaterialOverride()

bool VRay.Plugins.Instancer2.Set_InstancesMaterialOverride	(	IPluginRef	val,
		double	time
	)

Sets a value to Instancer2.InstancesMaterialOverride

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_LifespanPp()

bool VRay.Plugins.Instancer2.Set_LifespanPp	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.LifespanPp

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_Nsamples()

bool VRay.Plugins.Instancer2.Set_Nsamples	(	int	val,
		double	time
	)

Sets a value to Instancer2.Nsamples

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_OpacityPp()

bool VRay.Plugins.Instancer2.Set_OpacityPp	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.OpacityPp

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_RenderIdsGenMode()

bool VRay.Plugins.Instancer2.Set_RenderIdsGenMode	(	int	val,
		double	time
	)

Sets a value to Instancer2.RenderIdsGenMode

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ShadingNeedsIds()

bool VRay.Plugins.Instancer2.Set_ShadingNeedsIds	(	bool	val,
		double	time
	)

Sets a value to Instancer2.ShadingNeedsIds

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UseAdditionalParams()

bool VRay.Plugins.Instancer2.Set_UseAdditionalParams	(	bool	val,
		double	time
	)

Sets a value to Instancer2.UseAdditionalParams

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UseDirectVelocity()

bool VRay.Plugins.Instancer2.Set_UseDirectVelocity	(	bool	val,
		double	time
	)

Sets a value to Instancer2.UseDirectVelocity

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserColorPp1()

bool VRay.Plugins.Instancer2.Set_UserColorPp1	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.UserColorPp1

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserColorPp2()

bool VRay.Plugins.Instancer2.Set_UserColorPp2	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.UserColorPp2

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserColorPp3()

bool VRay.Plugins.Instancer2.Set_UserColorPp3	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.UserColorPp3

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserColorPp4()

bool VRay.Plugins.Instancer2.Set_UserColorPp4	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.UserColorPp4

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserColorPp5()

bool VRay.Plugins.Instancer2.Set_UserColorPp5	(	IList< Color >	val,
		double	time
	)

Sets a value to Instancer2.UserColorPp5

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserFloatPp1()

bool VRay.Plugins.Instancer2.Set_UserFloatPp1	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.UserFloatPp1

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserFloatPp2()

bool VRay.Plugins.Instancer2.Set_UserFloatPp2	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.UserFloatPp2

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserFloatPp3()

bool VRay.Plugins.Instancer2.Set_UserFloatPp3	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.UserFloatPp3

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserFloatPp4()

bool VRay.Plugins.Instancer2.Set_UserFloatPp4	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.UserFloatPp4

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UserFloatPp5()

bool VRay.Plugins.Instancer2.Set_UserFloatPp5	(	IList< float >	val,
		double	time
	)

Sets a value to Instancer2.UserFloatPp5

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UseTimeInstancing()

bool VRay.Plugins.Instancer2.Set_UseTimeInstancing	(	int	val,
		double	time
	)

Sets a value to Instancer2.UseTimeInstancing

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_UseVisibility()

bool VRay.Plugins.Instancer2.Set_UseVisibility	(	bool	val,
		double	time
	)

Sets a value to Instancer2.UseVisibility

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_Visible()

bool VRay.Plugins.Instancer2.Set_Visible	(	bool	val,
		double	time
	)

Sets a value to Instancer2.Visible

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

Property Documentation

◆ AccelerationPp

IList<Color> VRay.Plugins.Instancer2.AccelerationPp

getset

Per-particle acceleration. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ AgePp

IList<float> VRay.Plugins.Instancer2.AgePp

getset

Per-particle age. [UI Guides] gpuSupport=none

Default value: 0

◆ Colors

IList<Color> VRay.Plugins.Instancer2.Colors

getset

Per-particle diffuse color. [UI Guides] gpuSupport=none

Default value: Color(1, 1, 1)

◆ EmissionPp

IList<Color> VRay.Plugins.Instancer2.EmissionPp

getset

Per-particle emission color. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ LifespanPp

IList<float> VRay.Plugins.Instancer2.LifespanPp

getset

Per-particle lifespan. [UI Guides] gpuSupport=none

Default value: 0

◆ Nsamples

int VRay.Plugins.Instancer2.Nsamples

getset

Number of transform samples for motion blur [UI Guides] gpuSupport=full

Default value: 0

◆ OpacityPp

IList<float> VRay.Plugins.Instancer2.OpacityPp

getset

Per-particle opacity. [UI Guides] gpuSupport=none

Default value: 0

◆ RenderIdsGenMode

int VRay.Plugins.Instancer2.RenderIdsGenMode

getset

Values for this parameter other than 0 are EXPERIMENTAL and WORK IN PROGRESS. This parameter tells the Instancer how to generate the render IDs for its instances. 0 - each instance has the same render ID as its source Node. 1 - all instances have the same render ID even those generated from different Nodes. 2 - all instances have different render IDs even those generated from the same Node. [UI Guides] displayName=Render IDs Mode, enum=0:Same as source Node;1:Same for all instances;2:Different for all instances

Default value: 0

◆ ShadingNeedsIds

bool VRay.Plugins.Instancer2.ShadingNeedsIds

getset

Set to true if the particle shade data sent to the instanced geometry needs to include the particle ID. [UI Guides] gpuSupport=none

Default value: 0

◆ UseAdditionalParams

bool VRay.Plugins.Instancer2.UseAdditionalParams

getset

If this is set to 'true' the lists in the 'instances' parameter have additional parameters after 'time instancing' parameters - an int with flags indicating what parameters follow and after that the parameters that follow. Their types depend on the flags in the int and are in a strictly defined order. New flags may be added and additional parameters for them can be added at the end of the chain. The flags are defined in HierarchicalParameterizedNodeParameters in an enum. [UI Guides] gpuSupport=full

Default value: 0

◆ UseDirectVelocity

bool VRay.Plugins.Instancer2.UseDirectVelocity

getset

Directly interpolate particle velocity. [UI Guides] gpuSupport=full

Default value: 0

◆ UserColorPp1

IList<Color> VRay.Plugins.Instancer2.UserColorPp1

getset

Corresponds to Maya's userVector1PP. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ UserColorPp2

IList<Color> VRay.Plugins.Instancer2.UserColorPp2

getset

Corresponds to Maya's userVector2PP. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ UserColorPp3

IList<Color> VRay.Plugins.Instancer2.UserColorPp3

getset

Corresponds to Maya's userVector3PP. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ UserColorPp4

IList<Color> VRay.Plugins.Instancer2.UserColorPp4

getset

Corresponds to Maya's userVector4PP. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ UserColorPp5

IList<Color> VRay.Plugins.Instancer2.UserColorPp5

getset

Corresponds to Maya's userVector5PP. [UI Guides] gpuSupport=none

Default value: Color(0, 0, 0)

◆ UserFloatPp1

IList<float> VRay.Plugins.Instancer2.UserFloatPp1

getset

Corresponds to Maya's userScalar1PP. [UI Guides] gpuSupport=none

Default value: 0

◆ UserFloatPp2

IList<float> VRay.Plugins.Instancer2.UserFloatPp2

getset

Corresponds to Maya's userScalar2PP. [UI Guides] gpuSupport=none

Default value: 0

◆ UserFloatPp3

IList<float> VRay.Plugins.Instancer2.UserFloatPp3

getset

Corresponds to Maya's userScalar3PP. [UI Guides] gpuSupport=none

Default value: 0

◆ UserFloatPp4

IList<float> VRay.Plugins.Instancer2.UserFloatPp4

getset

Corresponds to Maya's userScalar4PP. [UI Guides] gpuSupport=none

Default value: 0

◆ UserFloatPp5

IList<float> VRay.Plugins.Instancer2.UserFloatPp5

getset

Corresponds to Maya's userScalar5PP. [UI Guides] gpuSupport=none

Default value: 0

◆ UseTimeInstancing

int VRay.Plugins.Instancer2.UseTimeInstancing

getset

If this is set to 1 or 2 the 'instances' parameter will contain the elements hasInstanceTime (bool) and instanceTime (double). Otherwise, they should not be present.0 - no time instancing applied. 1 - time instancing applied - only sequential times/samples permitted2 - time instancing applied - arbitrary times/samples permitted (used along with TimeInstancedGeom) [UI Guides] gpuSupport=full

Default value: 1

◆ UseVisibility

bool VRay.Plugins.Instancer2.UseVisibility

getset

Use particle visibility. If set to 'true' the lists in the 'instances' parameter have particle visibility parameter after 'additional parameters'. [UI Guides] gpuSupport=full

Default value: 0

◆ Visible

bool VRay.Plugins.Instancer2.Visible

getset

If false, no geometry will be generated and rendered [UI Guides] gpuSupport=full

Default value: 1

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

/home/jenkins/ci/j/workspace/core/vray_appsdk_lin_build/build/APPSDK/centos7/appsdk/cpp/generated/Plugins.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Get_AccelerationPp()

◆ Get_AgePp()

◆ Get_Colors()

◆ Get_EmissionPp()

◆ Get_ExtraChannels()

◆ Get_Instances()

◆ Get_InstancesMaterialOverride()

◆ Get_LifespanPp()

◆ Get_Nsamples()

◆ Get_OpacityPp()

◆ Get_RenderIdsGenMode()

◆ Get_ShadingNeedsIds()

◆ Get_UseAdditionalParams()

◆ Get_UseDirectVelocity()

◆ Get_UserColorPp1()

◆ Get_UserColorPp2()

◆ Get_UserColorPp3()

◆ Get_UserColorPp4()

◆ Get_UserColorPp5()

◆ Get_UserFloatPp1()

◆ Get_UserFloatPp2()

◆ Get_UserFloatPp3()

◆ Get_UserFloatPp4()

◆ Get_UserFloatPp5()

◆ Get_UseTimeInstancing()

◆ Get_UseVisibility()

◆ Get_Visible()

◆ Set_AccelerationPp()

◆ Set_AgePp()

◆ Set_Colors()

◆ Set_EmissionPp()

◆ Set_ExtraChannels()

◆ Set_Instances()

◆ Set_InstancesMaterialOverride()

◆ Set_LifespanPp()

◆ Set_Nsamples()

◆ Set_OpacityPp()

◆ Set_RenderIdsGenMode()

◆ Set_ShadingNeedsIds()

◆ Set_UseAdditionalParams()

◆ Set_UseDirectVelocity()

◆ Set_UserColorPp1()

◆ Set_UserColorPp2()

◆ Set_UserColorPp3()

◆ Set_UserColorPp4()

◆ Set_UserColorPp5()

◆ Set_UserFloatPp1()

◆ Set_UserFloatPp2()

◆ Set_UserFloatPp3()

◆ Set_UserFloatPp4()

◆ Set_UserFloatPp5()

◆ Set_UseTimeInstancing()

◆ Set_UseVisibility()

◆ Set_Visible()

Property Documentation

◆ AccelerationPp

◆ AgePp

◆ Colors

◆ EmissionPp

◆ LifespanPp

◆ Nsamples

◆ OpacityPp

◆ RenderIdsGenMode

◆ ShadingNeedsIds

◆ UseAdditionalParams

◆ UseDirectVelocity

◆ UserColorPp1

◆ UserColorPp2

◆ UserColorPp3

◆ UserColorPp4

◆ UserColorPp5

◆ UserFloatPp1

◆ UserFloatPp2

◆ UserFloatPp3