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

Description

A list of VuoWrapMode elements.

Classes

struct  VuoList_VuoWrapMode_struct
 A list of VuoWrapMode elements. More...
 

Typedefs

typedef struct
VuoList_VuoWrapMode_struct
VuoList_VuoWrapMode
 A list of VuoWrapMode elements.
 

Functions

VuoList_VuoWrapMode VuoListCreate_VuoWrapMode (void)
 Creates a new list of VuoWrapMode elements.
 
VuoList_VuoWrapMode VuoListCreateWithCount_VuoWrapMode (const unsigned long count, const VuoWrapMode value)
 Creates a new list of count instances of value.
 
VuoList_VuoWrapMode VuoListCopy_VuoWrapMode (const VuoList_VuoWrapMode list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoWrapMode VuoListGetValue_VuoWrapMode (const VuoList_VuoWrapMode list, const unsigned long index)
 Returns the VuoWrapMode at index.
 
VuoWrapModeVuoListGetData_VuoWrapMode (const VuoList_VuoWrapMode list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoWrapMode (const VuoList_VuoWrapMode list, const VuoWrapMode value, const unsigned long index)
 Changes the VuoWrapMode at index.
 
void VuoListInsertValue_VuoWrapMode (const VuoList_VuoWrapMode list, const VuoWrapMode value, const unsigned long index)
 Inserts the VuoWrapMode immediately before index.
 
void VuoListPrependValue_VuoWrapMode (VuoList_VuoWrapMode list, const VuoWrapMode value)
 Prepends value to list.
 
void VuoListAppendValue_VuoWrapMode (VuoList_VuoWrapMode list, const VuoWrapMode value)
 Appends value to list.
 
void VuoListExchangeValues_VuoWrapMode (VuoList_VuoWrapMode list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoWrapMode (VuoList_VuoWrapMode list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoWrapMode (VuoList_VuoWrapMode list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoWrapMode (VuoList_VuoWrapMode list, const signed long startIndex, const unsigned long itemCount)
 Removes items from the list except those in the range specified by startIndex and itemCount.
 
void VuoListRemoveFirstValue_VuoWrapMode (VuoList_VuoWrapMode list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoWrapMode (VuoList_VuoWrapMode list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoWrapMode (VuoList_VuoWrapMode list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoWrapMode (VuoList_VuoWrapMode list, const unsigned long index)
 Removes the VuoWrapMode at index.
 
unsigned long VuoListGetCount_VuoWrapMode (const VuoList_VuoWrapMode list)
 Returns the number of elements in list.
 
VuoList_VuoWrapMode VuoList_VuoWrapMode_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoWrapMode_getJson (const VuoList_VuoWrapMode value)
 Encodes value as a JSON object.
 
char * VuoList_VuoWrapMode_getSummary (const VuoList_VuoWrapMode value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoWrapMode VuoList_VuoWrapMode_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoWrapMode_getString (const VuoList_VuoWrapMode value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoWrapMode_struct
Class Members
void * l

Typedef Documentation

A list of VuoWrapMode elements.

Function Documentation

struct json_object* VuoList_VuoWrapMode_getJson ( const VuoList_VuoWrapMode  value)
read

Encodes value as a JSON object.

char* VuoList_VuoWrapMode_getString ( const VuoList_VuoWrapMode  value)

Automatically generated function.

char* VuoList_VuoWrapMode_getSummary ( const VuoList_VuoWrapMode  value)

Produces a brief human-readable summary of value.

VuoList_VuoWrapMode VuoList_VuoWrapMode_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoWrapMode ( VuoList_VuoWrapMode  list,
const VuoWrapMode  value 
)

Appends value to list.

VuoList_VuoWrapMode VuoListCopy_VuoWrapMode ( const VuoList_VuoWrapMode  list)

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

VuoList_VuoWrapMode VuoListCreate_VuoWrapMode ( void  )

Creates a new list of VuoWrapMode elements.

VuoList_VuoWrapMode VuoListCreateWithCount_VuoWrapMode ( const unsigned long  count,
const VuoWrapMode  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoWrapMode ( VuoList_VuoWrapMode  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoWrapMode ( VuoList_VuoWrapMode  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoWrapMode ( const VuoList_VuoWrapMode  list)

Returns the number of elements in list.

VuoWrapMode* VuoListGetData_VuoWrapMode ( const VuoList_VuoWrapMode  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.

VuoWrapMode VuoListGetValue_VuoWrapMode ( const VuoList_VuoWrapMode  list,
const unsigned long  index 
)

Returns the VuoWrapMode 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_VuoWrapMode ( const VuoList_VuoWrapMode  list,
const VuoWrapMode  value,
const unsigned long  index 
)

Inserts the VuoWrapMode 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_VuoWrapMode ( VuoList_VuoWrapMode  list,
const VuoWrapMode  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoWrapMode ( VuoList_VuoWrapMode  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoWrapMode ( VuoList_VuoWrapMode  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoWrapMode ( VuoList_VuoWrapMode  list)

Removes the last value from list.

void VuoListRemoveValue_VuoWrapMode ( VuoList_VuoWrapMode  list,
const unsigned long  index 
)

Removes the VuoWrapMode 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_VuoWrapMode ( VuoList_VuoWrapMode  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoWrapMode ( const VuoList_VuoWrapMode  list,
const VuoWrapMode  value,
const unsigned long  index 
)

Changes the VuoWrapMode at index.

Index values start at 1. 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).

void VuoListShuffle_VuoWrapMode ( VuoList_VuoWrapMode  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.