SetInstanceValue (Parameter)
Introduced
5.0
Description
Sets an instance value for specified object. Instance values only applied to Property objects that can be shared or Shader objects connected under shared Material object. For example, the ImageShader.tspace_id parameter is an instance value.
For parameters supporting object binding (such as a texturespace parameter) this method will accept a valid SIObject as an instance value. It will validate that the object is supported and will set the value using the name of the object. If the object is not supported it will return false.
If the object does not exist you can set the instance value using the name of the object and set the Bind argument to false.
Note: Instance values cannot be animated, so this method doesn't take a time argument.
Scripting Syntax
Parameter.SetInstanceValue( Object, Value, [Bind] )
C# Syntax
Boolean Parameter.SetInstanceValue( Object in_obj, Object, Boolean );Parameters
|
Parameter |
Type |
Description |
|
Object |
Object such as a X3DObject |
Object nesting the shared property |
|
Value |
New value for instance. This may be the object itself, such as the UVW texture property or the name of the object. |
|
|
Bind |
If the instance value supports object binding and the value passed is a string then the method will attempt to test for the existence of a supported object specified by the string. If the object does not exist the method will return False. Default Value: False |
Return Value
See Also
Examples
• See Parameter.SetInstanceValue.1.js
Autodesk Softimage 2011