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

Description

A list of VuoBlurShape elements.

Classes

struct  VuoList_VuoBlurShape_struct
 A list of VuoBlurShape elements. More...
 

Typedefs

typedef struct
VuoList_VuoBlurShape_struct
VuoList_VuoBlurShape
 A list of VuoBlurShape elements.
 

Functions

VuoList_VuoBlurShape VuoListCreate_VuoBlurShape (void)
 Creates a new list of VuoBlurShape elements.
 
VuoList_VuoBlurShape VuoListCreateWithCount_VuoBlurShape (const unsigned long count, const VuoBlurShape value)
 Creates a new list of count instances of value.
 
VuoList_VuoBlurShape VuoListCopy_VuoBlurShape (const VuoList_VuoBlurShape list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoBlurShape VuoListGetValue_VuoBlurShape (const VuoList_VuoBlurShape list, const unsigned long index)
 Returns the VuoBlurShape at index.
 
VuoBlurShapeVuoListGetData_VuoBlurShape (const VuoList_VuoBlurShape list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoBlurShape (const VuoList_VuoBlurShape list, const VuoBlurShape value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoBlurShape at index.
 
void VuoListInsertValue_VuoBlurShape (const VuoList_VuoBlurShape list, const VuoBlurShape value, const unsigned long index)
 Inserts the VuoBlurShape immediately before index.
 
void VuoListPrependValue_VuoBlurShape (VuoList_VuoBlurShape list, const VuoBlurShape value)
 Prepends value to list.
 
void VuoListAppendValue_VuoBlurShape (VuoList_VuoBlurShape list, const VuoBlurShape value)
 Appends value to list.
 
void VuoListExchangeValues_VuoBlurShape (VuoList_VuoBlurShape list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoBlurShape (VuoList_VuoBlurShape list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoBlurShape (VuoList_VuoBlurShape list)
 Reverses the order of the items in list.
 
VuoList_VuoBlurShape VuoListSubset_VuoBlurShape (VuoList_VuoBlurShape 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_VuoBlurShape (VuoList_VuoBlurShape list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoBlurShape (VuoList_VuoBlurShape list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoBlurShape (VuoList_VuoBlurShape list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoBlurShape (VuoList_VuoBlurShape list, const unsigned long index)
 Removes the VuoBlurShape at index.
 
unsigned long VuoListGetCount_VuoBlurShape (const VuoList_VuoBlurShape list)
 Returns the number of elements in list.
 
VuoList_VuoBlurShape VuoList_VuoBlurShape_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoBlurShape_getJson (const VuoList_VuoBlurShape value)
 Encodes value as a JSON object.
 
char * VuoList_VuoBlurShape_getSummary (const VuoList_VuoBlurShape value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoBlurShape VuoList_VuoBlurShape_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoBlurShape_getString (const VuoList_VuoBlurShape value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoBlurShape_struct
Class Members
void * l

Typedef Documentation

typedef struct VuoList_VuoBlurShape_struct * VuoList_VuoBlurShape

A list of VuoBlurShape elements.

Function Documentation

struct json_object* VuoList_VuoBlurShape_getJson ( const VuoList_VuoBlurShape  value)
read

Encodes value as a JSON object.

char* VuoList_VuoBlurShape_getString ( const VuoList_VuoBlurShape  value)

Automatically generated function.

char* VuoList_VuoBlurShape_getSummary ( const VuoList_VuoBlurShape  value)

Produces a brief human-readable summary of value.

VuoList_VuoBlurShape VuoList_VuoBlurShape_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoBlurShape ( VuoList_VuoBlurShape  list,
const VuoBlurShape  value 
)

Appends value to list.

VuoList_VuoBlurShape VuoListCopy_VuoBlurShape ( const VuoList_VuoBlurShape  list)

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

VuoList_VuoBlurShape VuoListCreate_VuoBlurShape ( void  )

Creates a new list of VuoBlurShape elements.

VuoList_VuoBlurShape VuoListCreateWithCount_VuoBlurShape ( const unsigned long  count,
const VuoBlurShape  value 
)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoBlurShape ( VuoList_VuoBlurShape  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoBlurShape ( const VuoList_VuoBlurShape  list)

Returns the number of elements in list.

VuoBlurShape* VuoListGetData_VuoBlurShape ( const VuoList_VuoBlurShape  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.

VuoBlurShape VuoListGetValue_VuoBlurShape ( const VuoList_VuoBlurShape  list,
const unsigned long  index 
)

Returns the VuoBlurShape 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_VuoBlurShape ( const VuoList_VuoBlurShape  list,
const VuoBlurShape  value,
const unsigned long  index 
)

Inserts the VuoBlurShape 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_VuoBlurShape ( VuoList_VuoBlurShape  list,
const VuoBlurShape  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoBlurShape ( VuoList_VuoBlurShape  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoBlurShape ( VuoList_VuoBlurShape  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoBlurShape ( VuoList_VuoBlurShape  list)

Removes the last value from list.

void VuoListRemoveValue_VuoBlurShape ( VuoList_VuoBlurShape  list,
const unsigned long  index 
)

Removes the VuoBlurShape 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_VuoBlurShape ( VuoList_VuoBlurShape  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoBlurShape ( const VuoList_VuoBlurShape  list,
const VuoBlurShape  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoBlurShape 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_VuoBlurShape ( VuoList_VuoBlurShape  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_VuoBlurShape VuoListSubset_VuoBlurShape ( VuoList_VuoBlurShape  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.