The IValueConfig type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | GetMatrix |
Used to retrieve a 4x4 Matrix from the pin at the specified slice.
|
| GetValue |
Used to retrieve a Value from the pin at the specified slice.
|
| GetValue2D |
Used to retrieve a 2D Vector from the pin at the specified slice.
|
| GetValue3D |
Used to retrieve a 3D Vector from the pin at the specified slice.
|
| GetValue4D |
Used to retrieve a 4D Vector from the pin at the specified slice.
|
| GetValuePointer(Int32*%, Double**%) | |
| GetValuePointer(Int32%, Double*%) |
Used to retrieve a Pointer to the Values of the pin.
|
| SetMatrix |
Used to write a Matrix to the pin at the specified slice.
|
| SetSubType |
Used to set the SubType of a Value pin, which is a set of limitations to the pins value range, used by the GUI to guide the user to insert correct values.
Note though that this does not prevent a user from setting "wrong" values on a pin. Ultimately each node is responsible for dealing with all possible inputs correctly.
Should only be called once immediately after the pin has been created in IPlugin.SetPluginHost.
|
| SetSubType2D |
Used to set the SubType of a 2D Vector pin, which is a set of limitations to the pins value range, used by the GUI to guide the user to insert correct values.
Note though that this does not prevent a user from setting "wrong" values on a pin. Ultimately each node is responsible for dealing with all possible inputs correctly.
Should only be called once immediately after the pin has been created in IPlugin.SetPluginHost.
|
| SetSubType3D |
Used to set the SubType of a 3D Vector pin, which is a set of limitations to the pins value range, used by the GUI to guide the user to insert correct values.
Note though that this does not prevent a user from setting "wrong" values on a pin. Ultimately each node is responsible for dealing with all possible inputs correctly.
Should only be called once immediately after the pin has been created in IPlugin.SetPluginHost.
|
| SetSubType4D |
Used to set the SubType of a 4D Vector pin, which is a set of limitations to the pins value range, used by the GUI to guide the user to insert correct values.
Note though that this does not prevent a user from setting "wrong" values on a pin. Ultimately each node is responsible for dealing with all possible inputs correctly.
Should only be called once immediately after the pin has been created in IPlugin.SetPluginHost.
|
| SetValue |
Used to write a Value to the pin at the specified slice.
|
| SetValue2D |
Used to write a 2D Vector to the pin at the specified slice.
|
| SetValue3D |
Used to write a 3D Vector to the pin at the specified slice.
|
| SetValue4D |
Used to write a 4D Vector to the pin at the specified slice.
|
Properties
| Name | Description | |
|---|---|---|
 | IsConnected |
Specifies whether the pin is connected in the patch or not.
(Inherited from IPluginIO.) |
| Name |
The pins name.
(Inherited from IPluginIO.) |
| Order |
The order property helps the node to arrange its pins visually. The higher the order, the more right the pin appears on the node.
(Inherited from IPluginIO.) |
| PinIsChanged |
Returns whether any slice of this pin has been changed in the current frame. This information is typically used to determine if
further processing is needed or can be ommited.
(Inherited from IPluginConfig.) |
| PluginHost |
Gets the plugin host which created this plugin io.
(Inherited from IPluginIO.) |
| SliceCount |
The pins SliceCount specifies the number of Values (2D Vector, String...) it carries. This is like the length of an array or list.
(Inherited from IPluginConfig.) |
| SpreadAsString |
Returns a String of the pins concatenated Values. Typcally used internally only to save a pins state to disk.
(Inherited from IPluginConfig.) |
