Vuo
0.6.1
|
Parameter decorations to be used by node classes.
Each parameter of nodeEvent(), nodeInstanceEvent(), and other node class functions refers to one of the node's ports or the node's instance data. This is indicated by its decoration.
Macros | |
#define | VuoInstanceData(type) |
Use this to decorate parameters referring to a stateful node's instance data. | |
#define | VuoInputData(type,...) |
Use this to decorate parameters referring to the data part of a data-and-event input port. | |
#define | VuoInputEvent(eventBlocking, name) |
Use this to decorate parameters referring to an event-only input port or the event part of a data-and-event input port. | |
#define | VuoOutputData(type) |
Use this to decorate parameters referring to the data part of a data-and-event output port. | |
#define | VuoOutputEvent(name) |
Use this to decorate parameters referring to an event-only output port or the event part of a data-and-event output port. | |
#define | VuoOutputTrigger(name, type) |
Use this to decorate parameters referring to a trigger output port. | |
Enumerations | |
enum | VuoPortEventBlocking { VuoPortEventBlocking_None, VuoPortEventBlocking_Door, VuoPortEventBlocking_Wall } |
Options for input ports to block events. More... | |
#define VuoInputData | ( | type, | |
... | |||
) |
Use this to decorate parameters referring to the data part of a data-and-event input port.
The parameter's name becomes the port name.
When this parameter's function is called, the argument passed will be a value of type type
that holds the input port's data.
If type
is heap data (a pointer), the parameter's function should not modify the heap data. See Developing Node Classes for more information.
type | The port type. See Built-in Types. |
... | Optionally, a JSON object specification containing additional details about the data, such as its default value. The "default" key is recognized for all port types, and should have the format accepted by the port type's MyType_valueFromJson() function. Additional keys may be recognized by the port type's input editor (see Developing an Input Editor). |
#define VuoInputEvent | ( | eventBlocking, | |
name | |||
) |
Use this to decorate parameters referring to an event-only input port or the event part of a data-and-event input port.
When this parameter's function is called, the argument passed will be a bool
that is true if the port received an event.
For an event-only port, the parameter's name becomes the port name.
eventBlocking | A value of type VuoPortEventBlocking, indicating the port's event-blocking behavior. |
name | The identifier of the corresponding data port, or blank if this is intended to be an event-only input port. |
#define VuoInstanceData | ( | type | ) |
Use this to decorate parameters referring to a stateful node's instance data.
When this parameter's function is called, the argument passed will be a pointer to the instance data created by nodeInstanceEvent().
type | The instance data's C type. |
#define VuoOutputData | ( | type | ) |
Use this to decorate parameters referring to the data part of a data-and-event output port.
When this parameter's function is called, the argument passed will be a value of type type*
that points to the output port's data. Set this data to set the output port's value.
The parameter's name becomes the port name.
If type
is heap data (a pointer), the node should not modify the heap data after the node function returns. See Developing Node Classes for more information.
type | The port type. See Built-in Types. |
#define VuoOutputEvent | ( | name | ) |
Use this to decorate parameters referring to an event-only output port or the event part of a data-and-event output port.
When this parameter's function is called, the argument passed will be a bool*
. Set this to true if an event should be sent through the output port. However, if any input port with the VuoPortEventBlocking_None option received an event, then an event will be sent through the output port regardless of this parameter's value.
For an event-only port, the parameter's name becomes the port name.
name | The identifier of the corresponding data port, or blank if this is intended to be an event-only output port. |
#define VuoOutputTrigger | ( | name, | |
type | |||
) |
Use this to decorate parameters referring to a trigger output port.
When this parameter's function is called, the argument passed will be a callback function. Call the function to fire an event through the trigger port.
name | The name of the trigger port. |
type | The port type, or void for an event-only trigger port. See Built-in Types. |
enum VuoPortEventBlocking |
Options for input ports to block events.