Vuo
2.3.2
|
A list of VuoSceneObjectType elements.
Classes | |
struct | VuoList_VuoSceneObjectType_struct |
List type. More... | |
Typedefs | |
typedef const struct VuoList_VuoSceneObjectType_struct * | VuoList_VuoSceneObjectType |
A list of VuoSceneObjectType elements. More... | |
typedef const struct VuoList_VuoSceneObjectType_struct * VuoList_VuoSceneObjectType |
A list of VuoSceneObjectType elements.
struct json_object* VuoList_VuoSceneObjectType_getJson | ( | const VuoList_VuoSceneObjectType | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoSceneObjectType.cc.
char* VuoList_VuoSceneObjectType_getString | ( | const VuoList_VuoSceneObjectType | value | ) |
Automatically generated function.
char* VuoList_VuoSceneObjectType_getSummary | ( | const VuoList_VuoSceneObjectType | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoList_VuoSceneObjectType_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoList_VuoSceneObjectType_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list, |
const VuoSceneObjectType | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoListCopy_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoListCreate_VuoSceneObjectType | ( | void | ) |
Creates a new list of VuoSceneObjectType elements.
Definition at line 154 of file VuoList_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoListCreateWithCount_VuoSceneObjectType | ( | const unsigned long | count, |
const VuoSceneObjectType | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoSceneObjectType to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoSceneObjectType.cc.
void VuoListExchangeValues_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | 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_VuoSceneObjectType.cc.
void VuoListForeach_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list, |
bool(^)(const VuoSceneObjectType 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_VuoSceneObjectType.cc.
unsigned long VuoListGetCount_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoSceneObjectType.cc.
VuoSceneObjectType* VuoListGetData_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | 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_VuoSceneObjectType.cc.
VuoSceneObjectType VuoListGetValue_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list, |
const unsigned long | index | ||
) |
Returns the VuoSceneObjectType 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_VuoSceneObjectType or VuoListForeach_VuoSceneObjectType.
Definition at line 203 of file VuoList_VuoSceneObjectType.cc.
void VuoListInsertValue_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list, |
const VuoSceneObjectType | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoSceneObjectType
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_VuoSceneObjectType.cc.
void VuoListPrependValue_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list, |
const VuoSceneObjectType | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoSceneObjectType.cc.
void VuoListRemoveAll_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoSceneObjectType.cc.
void VuoListRemoveFirstValue_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoSceneObjectType.cc.
void VuoListRemoveLastValue_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoSceneObjectType.cc.
void VuoListRemoveValue_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list, |
const unsigned long | index | ||
) |
Removes the VuoSceneObjectType
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_VuoSceneObjectType.cc.
void VuoListReverse_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoSceneObjectType.cc.
void VuoListSetValue_VuoSceneObjectType | ( | const VuoList_VuoSceneObjectType | list, |
const VuoSceneObjectType | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoSceneObjectType 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_VuoSceneObjectType.cc.
void VuoListShuffle_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | 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_VuoSceneObjectType.cc.
VuoList_VuoSceneObjectType VuoListSubset_VuoSceneObjectType | ( | VuoList_VuoSceneObjectType | 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_VuoSceneObjectType.cc.