Vuo 2.4.2
|
A list of VuoArtNetOutputDevice elements.
Classes | |
struct | VuoList_VuoArtNetOutputDevice_struct |
A list of VuoArtNetOutputDevice elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoArtNetOutputDevice_struct * | VuoList_VuoArtNetOutputDevice |
A list of VuoArtNetOutputDevice elements. More... | |
#define VUO_LIST_INDEX_TO_C_ARRAY_INDEX |
Definition at line 63 of file VuoList_VuoArtNetOutputDevice.h.
typedef const struct VuoList_VuoArtNetOutputDevice_struct * VuoList_VuoArtNetOutputDevice |
A list of VuoArtNetOutputDevice elements.
struct json_object * VuoList_VuoArtNetOutputDevice_getJson | ( | const VuoList_VuoArtNetOutputDevice | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoArtNetOutputDevice.cc.
char * VuoList_VuoArtNetOutputDevice_getString | ( | const VuoList_VuoArtNetOutputDevice | value | ) |
Automatically generated function.
char * VuoList_VuoArtNetOutputDevice_getSummary | ( | const VuoList_VuoArtNetOutputDevice | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoList_VuoArtNetOutputDevice_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoList_VuoArtNetOutputDevice_release | ( | VuoList_VuoArtNetOutputDevice | value | ) |
Releases the list.
This function is provided for use in polymorphism; it just calls VuoRelease()
.
Definition at line 580 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoList_VuoArtNetOutputDevice_retain | ( | VuoList_VuoArtNetOutputDevice | value | ) |
Retains the list.
This function is provided for use in polymorphism; it just calls VuoRetain()
.
Definition at line 575 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListAppendValue_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list, |
const VuoArtNetOutputDevice | value | ||
) |
Appends value
to list
.
Definition at line 321 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoListCopy_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 187 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoListCreate_VuoArtNetOutputDevice | ( | void | ) |
Creates a new list of VuoArtNetOutputDevice elements.
Definition at line 154 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoListCreateWithCount_VuoArtNetOutputDevice | ( | const unsigned long | count, |
const VuoArtNetOutputDevice | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoArtNetOutputDevice to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoListCreateWithValueArray_VuoArtNetOutputDevice | ( | const VuoArtNetOutputDevice * | values, |
const unsigned long | valueCount | ||
) |
Creates a new list containing the items in the C array values
.
The list retains each item in values
.
The caller may discard values
after this function returns.
Definition at line 174 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListExchangeValues_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 331 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListForeach_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list, |
bool(^)(const VuoArtNetOutputDevice 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 242 of file VuoList_VuoArtNetOutputDevice.cc.
unsigned long VuoListGetCount_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list | ) |
Returns the number of elements in list
.
Definition at line 566 of file VuoList_VuoArtNetOutputDevice.cc.
VuoArtNetOutputDevice * VuoListGetData_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | 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 232 of file VuoList_VuoArtNetOutputDevice.cc.
VuoArtNetOutputDevice VuoListGetValue_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list, |
const unsigned long | index | ||
) |
Returns the VuoArtNetOutputDevice 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_VuoArtNetOutputDevice or VuoListForeach_VuoArtNetOutputDevice.
Definition at line 216 of file VuoList_VuoArtNetOutputDevice.cc.
|
inlinestatic |
Converts a Vuo-style [1..n]
list index into a C-style [0..n-1]
list index.
If the index is less than 1, or larger than the size of the list, the returned index is clamped.
Definition at line 70 of file VuoList_VuoArtNetOutputDevice.h.
void VuoListInsertValue_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list, |
const VuoArtNetOutputDevice | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoArtNetOutputDevice
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 289 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListPrependValue_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list, |
const VuoArtNetOutputDevice | value | ||
) |
Prepends value
to list
.
Definition at line 311 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListRemoveAll_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list | ) |
Removes all values from list
.
Definition at line 540 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListRemoveFirstValue_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list | ) |
Removes the first value from list
.
Definition at line 512 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListRemoveLastValue_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list | ) |
Removes the last value from list
.
Definition at line 526 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListRemoveValue_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list, |
const unsigned long | index | ||
) |
Removes the VuoArtNetOutputDevice
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 549 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListReverse_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | list | ) |
Reverses the order of the items in list
.
Definition at line 435 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListSetValue_VuoArtNetOutputDevice | ( | const VuoList_VuoArtNetOutputDevice | list, |
const VuoArtNetOutputDevice | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoArtNetOutputDevice 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 254 of file VuoList_VuoArtNetOutputDevice.cc.
void VuoListShuffle_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | 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 414 of file VuoList_VuoArtNetOutputDevice.cc.
VuoList_VuoArtNetOutputDevice VuoListSubset_VuoArtNetOutputDevice | ( | VuoList_VuoArtNetOutputDevice | 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 444 of file VuoList_VuoArtNetOutputDevice.cc.