Vuo
2.0.0
|
A list of VuoOrientation elements.
Classes | |
struct | VuoList_VuoOrientation_struct |
List type. More... | |
Typedefs | |
typedef const struct VuoList_VuoOrientation_struct * | VuoList_VuoOrientation |
A list of VuoOrientation elements. More... | |
Functions | |
VuoList_VuoOrientation | VuoListCreate_VuoOrientation (void) |
Creates a new list of VuoOrientation elements. More... | |
VuoList_VuoOrientation | VuoListCreateWithCount_VuoOrientation (const unsigned long count, const VuoOrientation value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoOrientation | VuoListCopy_VuoOrientation (const VuoList_VuoOrientation list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoOrientation | VuoListGetValue_VuoOrientation (const VuoList_VuoOrientation list, const unsigned long index) |
Returns the VuoOrientation at index . More... | |
VuoOrientation * | VuoListGetData_VuoOrientation (const VuoList_VuoOrientation list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListSetValue_VuoOrientation (const VuoList_VuoOrientation list, const VuoOrientation value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoOrientation at index . More... | |
void | VuoListInsertValue_VuoOrientation (const VuoList_VuoOrientation list, const VuoOrientation value, const unsigned long index) |
Inserts the VuoOrientation immediately before index . More... | |
void | VuoListPrependValue_VuoOrientation (VuoList_VuoOrientation list, const VuoOrientation value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoOrientation (VuoList_VuoOrientation list, const VuoOrientation value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoOrientation (VuoList_VuoOrientation list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoOrientation (VuoList_VuoOrientation list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoOrientation (VuoList_VuoOrientation list) |
Reverses the order of the items in list . More... | |
VuoList_VuoOrientation | VuoListSubset_VuoOrientation (VuoList_VuoOrientation 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 . More... | |
void | VuoListRemoveFirstValue_VuoOrientation (VuoList_VuoOrientation list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoOrientation (VuoList_VuoOrientation list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoOrientation (VuoList_VuoOrientation list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoOrientation (VuoList_VuoOrientation list, const unsigned long index) |
Removes the VuoOrientation at index . More... | |
unsigned long | VuoListGetCount_VuoOrientation (const VuoList_VuoOrientation list) |
Returns the number of elements in list . More... | |
VuoList_VuoOrientation | VuoList_VuoOrientation_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoOrientation_getJson (const VuoList_VuoOrientation value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoOrientation_getSummary (const VuoList_VuoOrientation value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoOrientation | VuoList_VuoOrientation_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoOrientation_getString (const VuoList_VuoOrientation value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoOrientation_struct * VuoList_VuoOrientation |
A list of VuoOrientation elements.
struct json_object* VuoList_VuoOrientation_getJson | ( | const VuoList_VuoOrientation | value | ) |
Encodes value
as a JSON object.
Definition at line 81 of file VuoList_VuoOrientation.cc.
char* VuoList_VuoOrientation_getString | ( | const VuoList_VuoOrientation | value | ) |
Automatically generated function.
char* VuoList_VuoOrientation_getSummary | ( | const VuoList_VuoOrientation | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 113 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoList_VuoOrientation_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoList_VuoOrientation_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const VuoOrientation | value | ||
) |
Appends value
to list
.
Definition at line 287 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCopy_VuoOrientation | ( | const VuoList_VuoOrientation | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 165 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCreate_VuoOrientation | ( | void | ) |
Creates a new list of VuoOrientation elements.
Definition at line 151 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCreateWithCount_VuoOrientation | ( | const unsigned long | count, |
const VuoOrientation | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoOrientation to quickly initialize a large list.
Definition at line 158 of file VuoList_VuoOrientation.cc.
void VuoListExchangeValues_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 297 of file VuoList_VuoOrientation.cc.
unsigned long VuoListGetCount_VuoOrientation | ( | const VuoList_VuoOrientation | list | ) |
Returns the number of elements in list
.
Definition at line 532 of file VuoList_VuoOrientation.cc.
VuoOrientation* VuoListGetData_VuoOrientation | ( | const VuoList_VuoOrientation | 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 210 of file VuoList_VuoOrientation.cc.
VuoOrientation VuoListGetValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const unsigned long | index | ||
) |
Returns the VuoOrientation 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).
Definition at line 194 of file VuoList_VuoOrientation.cc.
void VuoListInsertValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const VuoOrientation | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoOrientation
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 255 of file VuoList_VuoOrientation.cc.
void VuoListPrependValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const VuoOrientation | value | ||
) |
Prepends value
to list
.
Definition at line 277 of file VuoList_VuoOrientation.cc.
void VuoListRemoveAll_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes all values from list
.
Definition at line 506 of file VuoList_VuoOrientation.cc.
void VuoListRemoveFirstValue_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes the first value from list
.
Definition at line 478 of file VuoList_VuoOrientation.cc.
void VuoListRemoveLastValue_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes the last value from list
.
Definition at line 492 of file VuoList_VuoOrientation.cc.
void VuoListRemoveValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const unsigned long | index | ||
) |
Removes the VuoOrientation
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 515 of file VuoList_VuoOrientation.cc.
void VuoListReverse_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Reverses the order of the items in list
.
Definition at line 401 of file VuoList_VuoOrientation.cc.
void VuoListSetValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const VuoOrientation | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoOrientation 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 220 of file VuoList_VuoOrientation.cc.
void VuoListShuffle_VuoOrientation | ( | VuoList_VuoOrientation | 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 380 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListSubset_VuoOrientation | ( | VuoList_VuoOrientation | 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 410 of file VuoList_VuoOrientation.cc.