DFGToolData (struct)¶
バージョン 2.2.1 で追加.
DFGToolData structure is used to propagates the manipulated values to the DFG graph by using inputs ports.
It contains a list of the name of the DFG ports to drive + the previous and new manipulated values of the tooltarget so users can create commands.
Members¶
| Boolean | bake | If true, bake the value into a command. |
| String[] | portNames | Lists of the ports to drive. |
| RTVal[] | prevRTVals | Previous manipulated values. |
| RTVal[] | newRTVals | New manipulated values. |
Methods¶
| DFGToolData ( in DFGToolData other ) | |
| DFGToolData ( in String portName ) | |
| DFGToolData ( in String portNames[] ) | |
| DFGToolData () | |
| Boolean | bakeValue ? () |
| DFGToolData | clone ? () |
| String | getPortAtIndex ? ( in UInt32 index ) |
| UInt32 | getPortCount ? () |
| UInt32 | getPortIndex ? ( in String port ) |
| RTVal | getRTValAtPort ? ( in String port, in Boolean prev ) |
| RTVal | getRTValAtPortIndex ? ( in UInt32 index, in Boolean prev ) |
| init ! ( in UInt32 portCount ) | |
| setPortAtIndex ! ( in UInt32 index, in String name ) | |
| setRTValAtPort ! ( in String port, in RTVal val, in Boolean prev, in Boolean bake ) | |
| setRTValAtPortIndex ! ( in UInt32 index, in RTVal val, in Boolean prev, in Boolean bake ) |
Methods in detail¶
DFGToolData ( in DFGToolData other )
copy constructor
DFGToolData ( in String portName )
Constructs a DFGToolData.
| portName | Name of the port to drive. |
DFGToolData ( in String portNames[] )
Constructs a DFGToolData.
| portNames | List of names of the ports to drive. |
DFGToolData ()
default constructor
Boolean DFGToolData.bakeValue? ()
Checks if the current values should be bake in commands.
| port | Port’s name. |
DFGToolData DFGToolData.clone? ()
clone method
String DFGToolData.getPortAtIndex? ( in UInt32 index )
Gets the name of the port at index.
| index | Index of the port. |
UInt32 DFGToolData.getPortCount? ()
Gets the number of ports to drive.
UInt32 DFGToolData.getPortIndex? ( in String port )
Gets the index of the port.
| port | Port’s name. |
RTVal DFGToolData.getRTValAtPort? ( in String port, in Boolean prev )
Gets the port variable.
| port | Port’s name. |
| prev | If true, gets the variable’s value before manipulation, if false gets the new value. |
RTVal DFGToolData.getRTValAtPortIndex? ( in UInt32 index, in Boolean prev )
Gets the port variable.
| index | Port’s index. |
| prev | If true, gets the variable’s value before manipulation, if false gets the new value. |
DFGToolData.init! ( in UInt32 portCount )
Inititializes a DFGToolData.
| portCount | Number of port to drive. |
DFGToolData.setPortAtIndex! ( in UInt32 index, in String name )
Sets the name of the port at index.
| index | Index of the port. |
| name | Name of the port. |
DFGToolData.setRTValAtPort! ( in String port, in RTVal val, in Boolean prev, in Boolean bake )
Sets the port variable.
| port | Port’s name. |
| val | Variable value. |
| prev | If true, sets the variable’s value before manipulation, if false sets the new value. |
| bake | If true, creates a commands. |
DFGToolData.setRTValAtPortIndex! ( in UInt32 index, in RTVal val, in Boolean prev, in Boolean bake )
Sets the port variable.
| index | Port’s index. |
| val | Variable value. |
| prev | If true, sets the variable’s value before manipulation, if false sets the new value. |
| bake | If true, creates a commands. |
