Vuo
1.2.0
|
A list of VuoLeapPointableType elements.
Classes | |
struct | VuoList_VuoLeapPointableType_struct |
A list of VuoLeapPointableType elements. More... | |
Typedefs | |
typedef struct VuoList_VuoLeapPointableType_struct * | VuoList_VuoLeapPointableType |
A list of VuoLeapPointableType elements. | |
typedef struct VuoList_VuoLeapPointableType_struct * VuoList_VuoLeapPointableType |
A list of VuoLeapPointableType elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoLeapPointableType_getString | ( | const VuoList_VuoLeapPointableType | value | ) |
Automatically generated function.
char* VuoList_VuoLeapPointableType_getSummary | ( | const VuoList_VuoLeapPointableType | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoLeapPointableType VuoList_VuoLeapPointableType_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoLeapPointableType VuoList_VuoLeapPointableType_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value | ||
) |
Appends value
to list
.
VuoList_VuoLeapPointableType VuoListCopy_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoLeapPointableType VuoListCreate_VuoLeapPointableType | ( | void | ) |
Creates a new list of VuoLeapPointableType elements.
VuoList_VuoLeapPointableType VuoListCreateWithCount_VuoLeapPointableType | ( | const unsigned long | count, |
const VuoLeapPointableType | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoLeapPointableType to quickly initialize a large list.
void VuoListCut_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | 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_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list | ) |
Returns the number of elements in list
.
VuoLeapPointableType* VuoListGetData_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | 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.
VuoLeapPointableType VuoListGetValue_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list, |
const unsigned long | index | ||
) |
Returns the VuoLeapPointableType 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_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoLeapPointableType
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_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const unsigned long | index | ||
) |
Removes the VuoLeapPointableType
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_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value, | ||
const unsigned long | index | ||
) |
Changes the VuoLeapPointableType 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_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | 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.