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

Description

A list of VuoLeapFrame elements.

Classes

struct  VuoList_VuoLeapFrame_struct
 A list of VuoLeapFrame elements. More...
 

Typedefs

typedef struct
VuoList_VuoLeapFrame_struct
VuoList_VuoLeapFrame
 A list of VuoLeapFrame elements.
 

Functions

VuoList_VuoLeapFrame VuoListCreate_VuoLeapFrame (void)
 Creates a new list of VuoLeapFrame elements.
 
VuoList_VuoLeapFrame VuoListCreateWithCount_VuoLeapFrame (const unsigned long count, const VuoLeapFrame value)
 Creates a new list of count instances of value.
 
VuoList_VuoLeapFrame VuoListCopy_VuoLeapFrame (const VuoList_VuoLeapFrame list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoLeapFrame VuoListGetValue_VuoLeapFrame (const VuoList_VuoLeapFrame list, const unsigned long index)
 Returns the VuoLeapFrame at index.
 
VuoLeapFrameVuoListGetData_VuoLeapFrame (const VuoList_VuoLeapFrame list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoLeapFrame (const VuoList_VuoLeapFrame list, const VuoLeapFrame value, const unsigned long index)
 Changes the VuoLeapFrame at index.
 
void VuoListInsertValue_VuoLeapFrame (const VuoList_VuoLeapFrame list, const VuoLeapFrame value, const unsigned long index)
 Inserts the VuoLeapFrame immediately before index.
 
void VuoListPrependValue_VuoLeapFrame (VuoList_VuoLeapFrame list, const VuoLeapFrame value)
 Prepends value to list.
 
void VuoListAppendValue_VuoLeapFrame (VuoList_VuoLeapFrame list, const VuoLeapFrame value)
 Appends value to list.
 
void VuoListExchangeValues_VuoLeapFrame (VuoList_VuoLeapFrame list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoLeapFrame (VuoList_VuoLeapFrame list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoLeapFrame (VuoList_VuoLeapFrame list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoLeapFrame (VuoList_VuoLeapFrame 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_VuoLeapFrame (VuoList_VuoLeapFrame list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoLeapFrame (VuoList_VuoLeapFrame list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoLeapFrame (VuoList_VuoLeapFrame list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoLeapFrame (VuoList_VuoLeapFrame list, const unsigned long index)
 Removes the VuoLeapFrame at index.
 
unsigned long VuoListGetCount_VuoLeapFrame (const VuoList_VuoLeapFrame list)
 Returns the number of elements in list.
 
VuoList_VuoLeapFrame VuoList_VuoLeapFrame_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoLeapFrame_getJson (const VuoList_VuoLeapFrame value)
 Encodes value as a JSON object.
 
char * VuoList_VuoLeapFrame_getSummary (const VuoList_VuoLeapFrame value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoLeapFrame VuoList_VuoLeapFrame_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoLeapFrame_getString (const VuoList_VuoLeapFrame value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoLeapFrame_struct
Class Members
void * l

Typedef Documentation

A list of VuoLeapFrame elements.

Function Documentation

struct json_object* VuoList_VuoLeapFrame_getJson ( const VuoList_VuoLeapFrame  value)
read

Encodes value as a JSON object.

char* VuoList_VuoLeapFrame_getString ( const VuoList_VuoLeapFrame  value)

Automatically generated function.

char* VuoList_VuoLeapFrame_getSummary ( const VuoList_VuoLeapFrame  value)

Produces a brief human-readable summary of value.

VuoList_VuoLeapFrame VuoList_VuoLeapFrame_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoLeapFrame ( VuoList_VuoLeapFrame  list,
const VuoLeapFrame  value 
)

Appends value to list.

VuoList_VuoLeapFrame VuoListCopy_VuoLeapFrame ( const VuoList_VuoLeapFrame  list)

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

VuoList_VuoLeapFrame VuoListCreate_VuoLeapFrame ( void  )

Creates a new list of VuoLeapFrame elements.

VuoList_VuoLeapFrame VuoListCreateWithCount_VuoLeapFrame ( const unsigned long  count,
const VuoLeapFrame  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoLeapFrame ( VuoList_VuoLeapFrame  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_VuoLeapFrame ( VuoList_VuoLeapFrame  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoLeapFrame ( const VuoList_VuoLeapFrame  list)

Returns the number of elements in list.

VuoLeapFrame* VuoListGetData_VuoLeapFrame ( const VuoList_VuoLeapFrame  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.

VuoLeapFrame VuoListGetValue_VuoLeapFrame ( const VuoList_VuoLeapFrame  list,
const unsigned long  index 
)

Returns the VuoLeapFrame 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_VuoLeapFrame ( const VuoList_VuoLeapFrame  list,
const VuoLeapFrame  value,
const unsigned long  index 
)

Inserts the VuoLeapFrame 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_VuoLeapFrame ( VuoList_VuoLeapFrame  list,
const VuoLeapFrame  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoLeapFrame ( VuoList_VuoLeapFrame  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoLeapFrame ( VuoList_VuoLeapFrame  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoLeapFrame ( VuoList_VuoLeapFrame  list)

Removes the last value from list.

void VuoListRemoveValue_VuoLeapFrame ( VuoList_VuoLeapFrame  list,
const unsigned long  index 
)

Removes the VuoLeapFrame 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_VuoLeapFrame ( VuoList_VuoLeapFrame  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoLeapFrame ( const VuoList_VuoLeapFrame  list,
const VuoLeapFrame  value,
const unsigned long  index 
)

Changes the VuoLeapFrame 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_VuoLeapFrame ( VuoList_VuoLeapFrame  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.