Vuo
1.2.6
|
A list of VuoVerticalAlignment elements.
Classes | |
struct | VuoList_VuoVerticalAlignment_struct |
A list of VuoVerticalAlignment elements. More... | |
Typedefs | |
typedef struct VuoList_VuoVerticalAlignment_struct * | VuoList_VuoVerticalAlignment |
A list of VuoVerticalAlignment elements. | |
typedef struct VuoList_VuoVerticalAlignment_struct * VuoList_VuoVerticalAlignment |
A list of VuoVerticalAlignment elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoVerticalAlignment_getString | ( | const VuoList_VuoVerticalAlignment | value | ) |
Automatically generated function.
char* VuoList_VuoVerticalAlignment_getSummary | ( | const VuoList_VuoVerticalAlignment | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoVerticalAlignment VuoList_VuoVerticalAlignment_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoVerticalAlignment VuoList_VuoVerticalAlignment_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list, |
const VuoVerticalAlignment | value | ||
) |
Appends value
to list
.
VuoList_VuoVerticalAlignment VuoListCopy_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoVerticalAlignment VuoListCreate_VuoVerticalAlignment | ( | void | ) |
Creates a new list of VuoVerticalAlignment elements.
VuoList_VuoVerticalAlignment VuoListCreateWithCount_VuoVerticalAlignment | ( | const unsigned long | count, |
const VuoVerticalAlignment | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoVerticalAlignment to quickly initialize a large list.
void VuoListExchangeValues_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | list | ) |
Returns the number of elements in list
.
VuoVerticalAlignment* VuoListGetData_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | 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.
VuoVerticalAlignment VuoListGetValue_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | list, |
const unsigned long | index | ||
) |
Returns the VuoVerticalAlignment 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_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | list, |
const VuoVerticalAlignment | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoVerticalAlignment
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_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list, |
const VuoVerticalAlignment | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list, |
const unsigned long | index | ||
) |
Removes the VuoVerticalAlignment
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_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoVerticalAlignment | ( | const VuoList_VuoVerticalAlignment | list, |
const VuoVerticalAlignment | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoVerticalAlignment 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
.
void VuoListShuffle_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | 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.
VuoList_VuoVerticalAlignment VuoListSubset_VuoVerticalAlignment | ( | VuoList_VuoVerticalAlignment | 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.