Vuo  1.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoLayer

Description

A list of VuoLayer elements.

Classes

struct  VuoList_VuoLayer_struct
 A list of VuoLayer elements. More...
 

Typedefs

typedef struct
VuoList_VuoLayer_struct
VuoList_VuoLayer
 A list of VuoLayer elements.
 

Functions

VuoList_VuoLayer VuoListCreate_VuoLayer (void)
 Creates a new list of VuoLayer elements.
 
VuoList_VuoLayer VuoListCreateWithCount_VuoLayer (const unsigned long count, const VuoLayer value)
 Creates a new list of count instances of value.
 
VuoList_VuoLayer VuoListCopy_VuoLayer (const VuoList_VuoLayer list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoLayer VuoListGetValue_VuoLayer (const VuoList_VuoLayer list, const unsigned long index)
 Returns the VuoLayer at index.
 
VuoLayerVuoListGetData_VuoLayer (const VuoList_VuoLayer list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoLayer (const VuoList_VuoLayer list, const VuoLayer value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoLayer at index.
 
void VuoListInsertValue_VuoLayer (const VuoList_VuoLayer list, const VuoLayer value, const unsigned long index)
 Inserts the VuoLayer immediately before index.
 
void VuoListPrependValue_VuoLayer (VuoList_VuoLayer list, const VuoLayer value)
 Prepends value to list.
 
void VuoListAppendValue_VuoLayer (VuoList_VuoLayer list, const VuoLayer value)
 Appends value to list.
 
void VuoListExchangeValues_VuoLayer (VuoList_VuoLayer list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoLayer (VuoList_VuoLayer list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoLayer (VuoList_VuoLayer list)
 Reverses the order of the items in list.
 
VuoList_VuoLayer VuoListSubset_VuoLayer (VuoList_VuoLayer 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.
 
void VuoListRemoveFirstValue_VuoLayer (VuoList_VuoLayer list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoLayer (VuoList_VuoLayer list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoLayer (VuoList_VuoLayer list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoLayer (VuoList_VuoLayer list, const unsigned long index)
 Removes the VuoLayer at index.
 
unsigned long VuoListGetCount_VuoLayer (const VuoList_VuoLayer list)
 Returns the number of elements in list.
 
VuoList_VuoLayer VuoList_VuoLayer_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoLayer_getJson (const VuoList_VuoLayer value)
 Encodes value as a JSON object.
 
char * VuoList_VuoLayer_getSummary (const VuoList_VuoLayer value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoLayer VuoList_VuoLayer_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoLayer_getString (const VuoList_VuoLayer value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoLayer_struct
Class Members
void * l

Typedef Documentation

A list of VuoLayer elements.

Function Documentation

struct json_object* VuoList_VuoLayer_getJson ( const VuoList_VuoLayer  value)
read

Encodes value as a JSON object.

char* VuoList_VuoLayer_getString ( const VuoList_VuoLayer  value)

Automatically generated function.

char* VuoList_VuoLayer_getSummary ( const VuoList_VuoLayer  value)

Produces a brief human-readable summary of value.

VuoList_VuoLayer VuoList_VuoLayer_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoLayer VuoList_VuoLayer_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoLayer ( VuoList_VuoLayer  list,
const VuoLayer  value 
)

Appends value to list.

VuoList_VuoLayer VuoListCopy_VuoLayer ( const VuoList_VuoLayer  list)

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

VuoList_VuoLayer VuoListCreate_VuoLayer ( void  )

Creates a new list of VuoLayer elements.

VuoList_VuoLayer VuoListCreateWithCount_VuoLayer ( const unsigned long  count,
const VuoLayer  value 
)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoLayer ( VuoList_VuoLayer  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoLayer ( const VuoList_VuoLayer  list)

Returns the number of elements in list.

VuoLayer* VuoListGetData_VuoLayer ( const VuoList_VuoLayer  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.

VuoLayer VuoListGetValue_VuoLayer ( const VuoList_VuoLayer  list,
const unsigned long  index 
)

Returns the VuoLayer 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_VuoLayer ( const VuoList_VuoLayer  list,
const VuoLayer  value,
const unsigned long  index 
)

Inserts the VuoLayer 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_VuoLayer ( VuoList_VuoLayer  list,
const VuoLayer  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoLayer ( VuoList_VuoLayer  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoLayer ( VuoList_VuoLayer  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoLayer ( VuoList_VuoLayer  list)

Removes the last value from list.

void VuoListRemoveValue_VuoLayer ( VuoList_VuoLayer  list,
const unsigned long  index 
)

Removes the VuoLayer 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_VuoLayer ( VuoList_VuoLayer  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoLayer ( const VuoList_VuoLayer  list,
const VuoLayer  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoLayer 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_VuoLayer ( VuoList_VuoLayer  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_VuoLayer VuoListSubset_VuoLayer ( VuoList_VuoLayer  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.