Vuo  1.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoModifierKey

Description

A list of VuoModifierKey elements.

Classes

struct  VuoList_VuoModifierKey_struct
 A list of VuoModifierKey elements. More...
 

Typedefs

typedef struct
VuoList_VuoModifierKey_struct
VuoList_VuoModifierKey
 A list of VuoModifierKey elements.
 

Functions

VuoList_VuoModifierKey VuoListCreate_VuoModifierKey (void)
 Creates a new list of VuoModifierKey elements.
 
VuoList_VuoModifierKey VuoListCreateWithCount_VuoModifierKey (const unsigned long count, const VuoModifierKey value)
 Creates a new list of count instances of value.
 
VuoList_VuoModifierKey VuoListCopy_VuoModifierKey (const VuoList_VuoModifierKey list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoModifierKey VuoListGetValue_VuoModifierKey (const VuoList_VuoModifierKey list, const unsigned long index)
 Returns the VuoModifierKey at index.
 
VuoModifierKeyVuoListGetData_VuoModifierKey (const VuoList_VuoModifierKey list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoModifierKey (const VuoList_VuoModifierKey list, const VuoModifierKey value, const unsigned long index)
 Changes the VuoModifierKey at index.
 
void VuoListInsertValue_VuoModifierKey (const VuoList_VuoModifierKey list, const VuoModifierKey value, const unsigned long index)
 Inserts the VuoModifierKey immediately before index.
 
void VuoListPrependValue_VuoModifierKey (VuoList_VuoModifierKey list, const VuoModifierKey value)
 Prepends value to list.
 
void VuoListAppendValue_VuoModifierKey (VuoList_VuoModifierKey list, const VuoModifierKey value)
 Appends value to list.
 
void VuoListExchangeValues_VuoModifierKey (VuoList_VuoModifierKey list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoModifierKey (VuoList_VuoModifierKey list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoModifierKey (VuoList_VuoModifierKey list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoModifierKey (VuoList_VuoModifierKey list, const signed long startIndex, const unsigned long itemCount)
 Removes items from the list except those in the range specified by startIndex and itemCount.
 
void VuoListRemoveFirstValue_VuoModifierKey (VuoList_VuoModifierKey list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoModifierKey (VuoList_VuoModifierKey list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoModifierKey (VuoList_VuoModifierKey list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoModifierKey (VuoList_VuoModifierKey list, const unsigned long index)
 Removes the VuoModifierKey at index.
 
unsigned long VuoListGetCount_VuoModifierKey (const VuoList_VuoModifierKey list)
 Returns the number of elements in list.
 
VuoList_VuoModifierKey VuoList_VuoModifierKey_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoModifierKey_getJson (const VuoList_VuoModifierKey value)
 Encodes value as a JSON object.
 
char * VuoList_VuoModifierKey_getSummary (const VuoList_VuoModifierKey value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoModifierKey VuoList_VuoModifierKey_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoModifierKey_getString (const VuoList_VuoModifierKey value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoModifierKey_struct
Class Members
void * l

Typedef Documentation

A list of VuoModifierKey elements.

Function Documentation

struct json_object* VuoList_VuoModifierKey_getJson ( const VuoList_VuoModifierKey  value)
read

Encodes value as a JSON object.

char* VuoList_VuoModifierKey_getString ( const VuoList_VuoModifierKey  value)

Automatically generated function.

char* VuoList_VuoModifierKey_getSummary ( const VuoList_VuoModifierKey  value)

Produces a brief human-readable summary of value.

VuoList_VuoModifierKey VuoList_VuoModifierKey_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoModifierKey VuoList_VuoModifierKey_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoModifierKey ( VuoList_VuoModifierKey  list,
const VuoModifierKey  value 
)

Appends value to list.

VuoList_VuoModifierKey VuoListCopy_VuoModifierKey ( const VuoList_VuoModifierKey  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

VuoList_VuoModifierKey VuoListCreate_VuoModifierKey ( void  )

Creates a new list of VuoModifierKey elements.

VuoList_VuoModifierKey VuoListCreateWithCount_VuoModifierKey ( const unsigned long  count,
const VuoModifierKey  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoModifierKey to quickly initialize a large list.

void VuoListCut_VuoModifierKey ( VuoList_VuoModifierKey  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoModifierKey ( VuoList_VuoModifierKey  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoModifierKey ( const VuoList_VuoModifierKey  list)

Returns the number of elements in list.

VuoModifierKey* VuoListGetData_VuoModifierKey ( const VuoList_VuoModifierKey  list)

Returns a pointer to a C array containing the list items.

Use this if you need a fast way to get or change multiple list items.

You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.

The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.

If the list has no items, returns NULL.

The pointer remains owned by the list; don't free it.

VuoModifierKey VuoListGetValue_VuoModifierKey ( const VuoList_VuoModifierKey  list,
const unsigned long  index 
)

Returns the VuoModifierKey at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

void VuoListInsertValue_VuoModifierKey ( const VuoList_VuoModifierKey  list,
const VuoModifierKey  value,
const unsigned long  index 
)

Inserts the VuoModifierKey immediately before index.

Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.

void VuoListPrependValue_VuoModifierKey ( VuoList_VuoModifierKey  list,
const VuoModifierKey  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoModifierKey ( VuoList_VuoModifierKey  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoModifierKey ( VuoList_VuoModifierKey  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoModifierKey ( VuoList_VuoModifierKey  list)

Removes the last value from list.

void VuoListRemoveValue_VuoModifierKey ( VuoList_VuoModifierKey  list,
const unsigned long  index 
)

Removes the VuoModifierKey at index.

Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.

void VuoListReverse_VuoModifierKey ( VuoList_VuoModifierKey  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoModifierKey ( const VuoList_VuoModifierKey  list,
const VuoModifierKey  value,
const unsigned long  index 
)

Changes the VuoModifierKey at index.

Index values start at 1. If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

void VuoListShuffle_VuoModifierKey ( VuoList_VuoModifierKey  list,
const double  chaos 
)

Generates a random permutation of list.

chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.