Vuo
2.3.2
|
A list of VuoLeapPointableType elements.
Classes | |
struct | VuoList_VuoLeapPointableType_struct |
List type. More... | |
Typedefs | |
typedef const struct VuoList_VuoLeapPointableType_struct * | VuoList_VuoLeapPointableType |
A list of VuoLeapPointableType elements. More... | |
typedef const struct VuoList_VuoLeapPointableType_struct * VuoList_VuoLeapPointableType |
A list of VuoLeapPointableType elements.
struct json_object* VuoList_VuoLeapPointableType_getJson | ( | const VuoList_VuoLeapPointableType | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoLeapPointableType.cc.
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
.
Definition at line 119 of file VuoList_VuoLeapPointableType.cc.
VuoList_VuoLeapPointableType VuoList_VuoLeapPointableType_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoLeapPointableType.cc.
VuoList_VuoLeapPointableType VuoList_VuoLeapPointableType_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoLeapPointableType.cc.
VuoList_VuoLeapPointableType VuoListCopy_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoLeapPointableType.cc.
VuoList_VuoLeapPointableType VuoListCreate_VuoLeapPointableType | ( | void | ) |
Creates a new list of VuoLeapPointableType elements.
Definition at line 154 of file VuoList_VuoLeapPointableType.cc.
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.
Definition at line 161 of file VuoList_VuoLeapPointableType.cc.
void VuoListExchangeValues_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 318 of file VuoList_VuoLeapPointableType.cc.
void VuoListForeach_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list, |
bool(^)(const VuoLeapPointableType value) | function | ||
) |
Applies function
to each of list
's items, serially in order of index.
If function
returns false, visiting will stop immediately (possibly before all items have been visited).
Definition at line 229 of file VuoList_VuoLeapPointableType.cc.
unsigned long VuoListGetCount_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoLeapPointableType.cc.
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.
Definition at line 219 of file VuoList_VuoLeapPointableType.cc.
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).
If iterating over an entire list, consider using VuoListGetData_VuoLeapPointableType or VuoListForeach_VuoLeapPointableType.
Definition at line 203 of file VuoList_VuoLeapPointableType.cc.
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.
Definition at line 276 of file VuoList_VuoLeapPointableType.cc.
void VuoListPrependValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoLeapPointableType.cc.
void VuoListRemoveAll_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoLeapPointableType.cc.
void VuoListRemoveFirstValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoLeapPointableType.cc.
void VuoListRemoveLastValue_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoLeapPointableType.cc.
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.
Definition at line 536 of file VuoList_VuoLeapPointableType.cc.
void VuoListReverse_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoLeapPointableType.cc.
void VuoListSetValue_VuoLeapPointableType | ( | const VuoList_VuoLeapPointableType | list, |
const VuoLeapPointableType | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoLeapPointableType at index
.
Index values start at 1.
If expandListIfNeeded
is false: 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).
If expandListIfNeeded
is true: If the list has less than index
elements, it is expanded to accommodate the specified index
. If index
is 0, the list is resized to contain 1 item set to value
.
Definition at line 241 of file VuoList_VuoLeapPointableType.cc.
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.
Definition at line 401 of file VuoList_VuoLeapPointableType.cc.
VuoList_VuoLeapPointableType VuoListSubset_VuoLeapPointableType | ( | VuoList_VuoLeapPointableType | list, |
const signed long | startIndex, | ||
const unsigned long | itemCount | ||
) |
Returns a new list containing items from the original list in the range specified by startIndex
and itemCount
.
Items in the new list are retained (not copied) from the original list.
Definition at line 431 of file VuoList_VuoLeapPointableType.cc.