Vuo  2.3.2
Classes | Macros | Functions
VuoInteraction

Description

Holds information about an input device's status.

Classes

struct  VuoInteraction
 Holds information about an input device's status. More...
 

Functions

VuoInteraction VuoInteraction_makeFromJson (json_object *js)
 Decodes the JSON object js to create a new value. More...
 
json_objectVuoInteraction_getJson (const VuoInteraction value)
 Encodes value as a JSON object. More...
 
char * VuoInteraction_getSummary (const VuoInteraction value)
 Returns a compact string representation of value (comma-separated components). More...
 
bool VuoInteraction_update (const VuoPoint2d position, const VuoBoolean isPressed, VuoInteraction *interaction) VuoWarnUnusedResult
 Update an interaction with new input position and isPressed values. More...
 
static VuoInteraction VuoInteraction_make () __attribute__((const))
 Returns a new VuoInteraction. More...
 
bool VuoInteraction_areEqual (const VuoInteraction a, const VuoInteraction b)
 Returns true if both interactions are identical (value-wise). More...
 
bool VuoInteraction_isLessThan (const VuoInteraction a, const VuoInteraction b)
 Returns true if a < b. More...
 
VuoInteraction VuoInteraction_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoInteraction_getString (const VuoInteraction value)
 Automatically generated function. More...
 
void VuoInteraction_retain (VuoInteraction value)
 Automatically generated function. More...
 
void VuoInteraction_release (VuoInteraction value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoInteraction

struct VuoInteraction
Class Members
VuoInteger clickCount
bool isPressed
VuoPoint2d origin
VuoPoint2d position
double timestamp
VuoInteractionType type
VuoUuid uuid

Function Documentation

◆ VuoInteraction_areEqual()

bool VuoInteraction_areEqual ( const VuoInteraction  value1,
const VuoInteraction  value2 
)

Returns true if both interactions are identical (value-wise).

Interaction uuids may differ.

Changed in Vuo 2.0.0:
New.

Definition at line 127 of file VuoInteraction.c.

◆ VuoInteraction_getJson()

struct json_object * VuoInteraction_getJson ( const VuoInteraction  value)

Encodes value as a JSON object.

Changed in Vuo 2.0.0:
New.

Definition at line 86 of file VuoInteraction.c.

◆ VuoInteraction_getString()

char* VuoInteraction_getString ( const VuoInteraction  value)

Automatically generated function.

◆ VuoInteraction_getSummary()

char * VuoInteraction_getSummary ( const VuoInteraction  value)

Returns a compact string representation of value (comma-separated components).

Changed in Vuo 2.0.0:
New.

Definition at line 107 of file VuoInteraction.c.

◆ VuoInteraction_isLessThan()

bool VuoInteraction_isLessThan ( const VuoInteraction  a,
const VuoInteraction  b 
)

Returns true if a < b.

Changed in Vuo 2.0.0:
New.

Definition at line 141 of file VuoInteraction.c.

◆ VuoInteraction_make()

static VuoInteraction VuoInteraction_make ( ) const
inlinestatic

Returns a new VuoInteraction.

Definition at line 58 of file VuoInteraction.h.

◆ VuoInteraction_makeFromJson()

VuoInteraction VuoInteraction_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"@todo"
}
Changed in Vuo 2.0.0:
New.

Definition at line 50 of file VuoInteraction.c.

◆ VuoInteraction_makeFromString()

VuoInteraction VuoInteraction_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoInteraction_release()

void VuoInteraction_release ( VuoInteraction  value)

Automatically generated function.

◆ VuoInteraction_retain()

void VuoInteraction_retain ( VuoInteraction  value)

Automatically generated function.

◆ VuoInteraction_update()

bool VuoInteraction_update ( const VuoPoint2d  position,
const VuoBoolean  isPressed,
VuoInteraction interaction 
)

Update an interaction with new input position and isPressed values.

Returns true if the interaction has changed since the last update.

Changed in Vuo 2.0.0:
New.

Definition at line 188 of file VuoInteraction.c.