Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoEdgeBlend

Description

A list of VuoEdgeBlend elements.

Classes

struct  VuoList_VuoEdgeBlend_struct
 A list of VuoEdgeBlend elements. More...
 

Typedefs

typedef const struct VuoList_VuoEdgeBlend_structVuoList_VuoEdgeBlend
 A list of VuoEdgeBlend elements. More...
 

Functions

VuoList_VuoEdgeBlend VuoListCreate_VuoEdgeBlend (void)
 Creates a new list of VuoEdgeBlend elements. More...
 
VuoList_VuoEdgeBlend VuoListCreateWithCount_VuoEdgeBlend (const unsigned long count, const VuoEdgeBlend value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoEdgeBlend VuoListCopy_VuoEdgeBlend (const VuoList_VuoEdgeBlend list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoEdgeBlend VuoListGetValue_VuoEdgeBlend (const VuoList_VuoEdgeBlend list, const unsigned long index)
 Returns the VuoEdgeBlend at index. More...
 
VuoEdgeBlendVuoListGetData_VuoEdgeBlend (const VuoList_VuoEdgeBlend list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoEdgeBlend (const VuoList_VuoEdgeBlend list, bool(^function)(const VuoEdgeBlend value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoEdgeBlend (const VuoList_VuoEdgeBlend list, const VuoEdgeBlend value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoEdgeBlend at index. More...
 
void VuoListInsertValue_VuoEdgeBlend (const VuoList_VuoEdgeBlend list, const VuoEdgeBlend value, const unsigned long index)
 Inserts the VuoEdgeBlend immediately before index. More...
 
void VuoListPrependValue_VuoEdgeBlend (VuoList_VuoEdgeBlend list, const VuoEdgeBlend value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoEdgeBlend (VuoList_VuoEdgeBlend list, const VuoEdgeBlend value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoEdgeBlend (VuoList_VuoEdgeBlend list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoEdgeBlend (VuoList_VuoEdgeBlend list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoEdgeBlend (VuoList_VuoEdgeBlend list)
 Reverses the order of the items in list. More...
 
VuoList_VuoEdgeBlend VuoListSubset_VuoEdgeBlend (VuoList_VuoEdgeBlend 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_VuoEdgeBlend (VuoList_VuoEdgeBlend list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoEdgeBlend (VuoList_VuoEdgeBlend list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoEdgeBlend (VuoList_VuoEdgeBlend list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoEdgeBlend (VuoList_VuoEdgeBlend list, const unsigned long index)
 Removes the VuoEdgeBlend at index. More...
 
unsigned long VuoListGetCount_VuoEdgeBlend (const VuoList_VuoEdgeBlend list)
 Returns the number of elements in list. More...
 
VuoList_VuoEdgeBlend VuoList_VuoEdgeBlend_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoEdgeBlend_getJson (const VuoList_VuoEdgeBlend value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoEdgeBlend_getSummary (const VuoList_VuoEdgeBlend value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoEdgeBlend VuoList_VuoEdgeBlend_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoEdgeBlend_getString (const VuoList_VuoEdgeBlend value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoEdgeBlend_struct

struct VuoList_VuoEdgeBlend_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoEdgeBlend

A list of VuoEdgeBlend elements.

Function Documentation

◆ VuoList_VuoEdgeBlend_getJson()

struct json_object* VuoList_VuoEdgeBlend_getJson ( const VuoList_VuoEdgeBlend  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoEdgeBlend.cc.

◆ VuoList_VuoEdgeBlend_getString()

char* VuoList_VuoEdgeBlend_getString ( const VuoList_VuoEdgeBlend  value)

Automatically generated function.

◆ VuoList_VuoEdgeBlend_getSummary()

char* VuoList_VuoEdgeBlend_getSummary ( const VuoList_VuoEdgeBlend  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoEdgeBlend.cc.

◆ VuoList_VuoEdgeBlend_makeFromJson()

VuoList_VuoEdgeBlend VuoList_VuoEdgeBlend_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoEdgeBlend.cc.

◆ VuoList_VuoEdgeBlend_makeFromString()

VuoList_VuoEdgeBlend VuoList_VuoEdgeBlend_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoEdgeBlend()

void VuoListAppendValue_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list,
const VuoEdgeBlend  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListCopy_VuoEdgeBlend()

VuoList_VuoEdgeBlend VuoListCopy_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

Definition at line 174 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListCreate_VuoEdgeBlend()

VuoList_VuoEdgeBlend VuoListCreate_VuoEdgeBlend ( void  )

Creates a new list of VuoEdgeBlend elements.

Definition at line 154 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListCreateWithCount_VuoEdgeBlend()

VuoList_VuoEdgeBlend VuoListCreateWithCount_VuoEdgeBlend ( const unsigned long  count,
const VuoEdgeBlend  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoEdgeBlend to quickly initialize a large list.

Definition at line 161 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListExchangeValues_VuoEdgeBlend()

void VuoListExchangeValues_VuoEdgeBlend ( VuoList_VuoEdgeBlend  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_VuoEdgeBlend.cc.

◆ VuoListForeach_VuoEdgeBlend()

void VuoListForeach_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list,
bool(^)(const VuoEdgeBlend 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).

Changed in Vuo 2.0.0:
New.

Definition at line 229 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListGetCount_VuoEdgeBlend()

unsigned long VuoListGetCount_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListGetData_VuoEdgeBlend()

VuoEdgeBlend* VuoListGetData_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  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_VuoEdgeBlend.cc.

◆ VuoListGetValue_VuoEdgeBlend()

VuoEdgeBlend VuoListGetValue_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list,
const unsigned long  index 
)

Returns the VuoEdgeBlend 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_VuoEdgeBlend or VuoListForeach_VuoEdgeBlend.

Definition at line 203 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListInsertValue_VuoEdgeBlend()

void VuoListInsertValue_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list,
const VuoEdgeBlend  value,
const unsigned long  index 
)

Inserts the VuoEdgeBlend 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_VuoEdgeBlend.cc.

◆ VuoListPrependValue_VuoEdgeBlend()

void VuoListPrependValue_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list,
const VuoEdgeBlend  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListRemoveAll_VuoEdgeBlend()

void VuoListRemoveAll_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListRemoveFirstValue_VuoEdgeBlend()

void VuoListRemoveFirstValue_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListRemoveLastValue_VuoEdgeBlend()

void VuoListRemoveLastValue_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListRemoveValue_VuoEdgeBlend()

void VuoListRemoveValue_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list,
const unsigned long  index 
)

Removes the VuoEdgeBlend 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_VuoEdgeBlend.cc.

◆ VuoListReverse_VuoEdgeBlend()

void VuoListReverse_VuoEdgeBlend ( VuoList_VuoEdgeBlend  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoEdgeBlend.cc.

◆ VuoListSetValue_VuoEdgeBlend()

void VuoListSetValue_VuoEdgeBlend ( const VuoList_VuoEdgeBlend  list,
const VuoEdgeBlend  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoEdgeBlend 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_VuoEdgeBlend.cc.

◆ VuoListShuffle_VuoEdgeBlend()

void VuoListShuffle_VuoEdgeBlend ( VuoList_VuoEdgeBlend  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_VuoEdgeBlend.cc.

◆ VuoListSubset_VuoEdgeBlend()

VuoList_VuoEdgeBlend VuoListSubset_VuoEdgeBlend ( VuoList_VuoEdgeBlend  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_VuoEdgeBlend.cc.