new Pin(pinname, direction, init_values, node, type)
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
pinname |
String | Pin Name |
|
direction |
String | see PinDirection |
|
init_values |
Array | the array of initial values |
|
node |
VVVV.Core.Node | the node this pin is attached to |
|
type |
Object |
<optional> |
the PinType, default is see {@link VVVV.PinTypes |
- Source:
Members
-
changed
-
- Source:
-
connectionChangedHandlers
-
contains a row of named callback functions, each fired if the pin's connection has changed
- Source:
-
direction
-
see PinDirection
- Source:
-
enumOptions
-
contains the options used if the pin is of type VVVV.PinTypes.Enum
- Source:
-
links
-
- Source:
-
masterPin
-
if the pin is a subpatch's output pin, the masterPin is the corresponding IOBox output pin INSIDE the subpatch
- Source:
-
node
-
- Source:
-
pinname
-
- Source:
-
slavePin
-
if the pin is a subpatch's input pin, the slavePin is the corresponding IOBox input pin INSIDE the subpatch
- Source:
-
values
-
- Source:
Methods
-
connectionChanged()
-
called when the pin gets connected or disconnected; subsequently calls the callbacks registered in VVVV.Core.Pin#connectionChangedHandlers
- Source:
-
getSliceCount() → {Integer}
-
- Source:
Returns:
the number of slices
- Type
- Integer
-
getValue(i, binSize)
-
retreives pin's slices
Parameters:
Name Type Argument Description i
Integer the slice/bin number
binSize
Integer <optional>
the bin size, default is 1
- Source:
Returns:
if binSize is 1, the value of the slice is returned; if binSize is > 1, an array with the slice values is returned
-
isConnected()
-
used do find out if a pin is connected
- Source:
Returns:
true, if there are incoming or outgoing links to or from this pin (and its masterPin, if preset)
-
markPinAsChanged()
-
used to mark a pin as changed without actually using VVVV.Core.Pin#setValue
- Source:
-
pinIsChanged() → {Boolean}
-
used to find out if a pin has changed since last evaluation
- Source:
Returns:
true if changed, false if not changed
- Type
- Boolean
-
setSliceCount(len)
-
sets the number of slices; also sets the slice number of connected downstream pins and the slavePin if present; absolutely necessary if the slice number decreases
Parameters:
Name Type Description len
Integer the slice count
- Source:
-
setType(newType)
-
used to change the pin's type during runtime. Also sets the value to the new pin type's default value
Parameters:
Name Type Description newType
Object the new type, see VVVV.PinTypes
- Source:
-
setValue(i, v, stopPropagation)
-
set a pin's slice value; if an output pin, it also sets the values of connected input pins. If the pin is a subpatch input pin, it also sets the slavePin inside the subpatch
Parameters:
Name Type Argument Description i
Integer the slice number
v
the value to set
stopPropagation
Boolean <optional>
default is false; if true, the function does not update slavePins to avoid infinite loops; this parameter should not be used in node implementations
- Source: