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

Description

A list of VuoImageStereoType elements.

Classes

struct  VuoList_VuoImageStereoType_struct
 A list of VuoImageStereoType elements. More...
 

Typedefs

typedef struct
VuoList_VuoImageStereoType_struct
VuoList_VuoImageStereoType
 A list of VuoImageStereoType elements.
 

Functions

VuoList_VuoImageStereoType VuoListCreate_VuoImageStereoType (void)
 Creates a new list of VuoImageStereoType elements.
 
VuoList_VuoImageStereoType VuoListCreateWithCount_VuoImageStereoType (const unsigned long count, const VuoImageStereoType value)
 Creates a new list of count instances of value.
 
VuoList_VuoImageStereoType VuoListCopy_VuoImageStereoType (const VuoList_VuoImageStereoType list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoImageStereoType VuoListGetValue_VuoImageStereoType (const VuoList_VuoImageStereoType list, const unsigned long index)
 Returns the VuoImageStereoType at index.
 
VuoImageStereoTypeVuoListGetData_VuoImageStereoType (const VuoList_VuoImageStereoType list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoImageStereoType (const VuoList_VuoImageStereoType list, const VuoImageStereoType value, const unsigned long index)
 Changes the VuoImageStereoType at index.
 
void VuoListInsertValue_VuoImageStereoType (const VuoList_VuoImageStereoType list, const VuoImageStereoType value, const unsigned long index)
 Inserts the VuoImageStereoType immediately before index.
 
void VuoListPrependValue_VuoImageStereoType (VuoList_VuoImageStereoType list, const VuoImageStereoType value)
 Prepends value to list.
 
void VuoListAppendValue_VuoImageStereoType (VuoList_VuoImageStereoType list, const VuoImageStereoType value)
 Appends value to list.
 
void VuoListExchangeValues_VuoImageStereoType (VuoList_VuoImageStereoType list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoImageStereoType (VuoList_VuoImageStereoType list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoImageStereoType (VuoList_VuoImageStereoType list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoImageStereoType (VuoList_VuoImageStereoType 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_VuoImageStereoType (VuoList_VuoImageStereoType list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoImageStereoType (VuoList_VuoImageStereoType list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoImageStereoType (VuoList_VuoImageStereoType list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoImageStereoType (VuoList_VuoImageStereoType list, const unsigned long index)
 Removes the VuoImageStereoType at index.
 
unsigned long VuoListGetCount_VuoImageStereoType (const VuoList_VuoImageStereoType list)
 Returns the number of elements in list.
 
VuoList_VuoImageStereoType VuoList_VuoImageStereoType_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoImageStereoType_getJson (const VuoList_VuoImageStereoType value)
 Encodes value as a JSON object.
 
char * VuoList_VuoImageStereoType_getSummary (const VuoList_VuoImageStereoType value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoImageStereoType VuoList_VuoImageStereoType_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoImageStereoType_getString (const VuoList_VuoImageStereoType value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoImageStereoType_struct
Class Members
void * l

Typedef Documentation

A list of VuoImageStereoType elements.

Function Documentation

struct json_object* VuoList_VuoImageStereoType_getJson ( const VuoList_VuoImageStereoType  value)
read

Encodes value as a JSON object.

char* VuoList_VuoImageStereoType_getString ( const VuoList_VuoImageStereoType  value)

Automatically generated function.

char* VuoList_VuoImageStereoType_getSummary ( const VuoList_VuoImageStereoType  value)

Produces a brief human-readable summary of value.

VuoList_VuoImageStereoType VuoList_VuoImageStereoType_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoImageStereoType ( VuoList_VuoImageStereoType  list,
const VuoImageStereoType  value 
)

Appends value to list.

VuoList_VuoImageStereoType VuoListCopy_VuoImageStereoType ( const VuoList_VuoImageStereoType  list)

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

VuoList_VuoImageStereoType VuoListCreate_VuoImageStereoType ( void  )

Creates a new list of VuoImageStereoType elements.

VuoList_VuoImageStereoType VuoListCreateWithCount_VuoImageStereoType ( const unsigned long  count,
const VuoImageStereoType  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoImageStereoType ( VuoList_VuoImageStereoType  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_VuoImageStereoType ( VuoList_VuoImageStereoType  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoImageStereoType ( const VuoList_VuoImageStereoType  list)

Returns the number of elements in list.

VuoImageStereoType* VuoListGetData_VuoImageStereoType ( const VuoList_VuoImageStereoType  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.

VuoImageStereoType VuoListGetValue_VuoImageStereoType ( const VuoList_VuoImageStereoType  list,
const unsigned long  index 
)

Returns the VuoImageStereoType 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_VuoImageStereoType ( const VuoList_VuoImageStereoType  list,
const VuoImageStereoType  value,
const unsigned long  index 
)

Inserts the VuoImageStereoType 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_VuoImageStereoType ( VuoList_VuoImageStereoType  list,
const VuoImageStereoType  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoImageStereoType ( VuoList_VuoImageStereoType  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoImageStereoType ( VuoList_VuoImageStereoType  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoImageStereoType ( VuoList_VuoImageStereoType  list)

Removes the last value from list.

void VuoListRemoveValue_VuoImageStereoType ( VuoList_VuoImageStereoType  list,
const unsigned long  index 
)

Removes the VuoImageStereoType 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_VuoImageStereoType ( VuoList_VuoImageStereoType  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoImageStereoType ( const VuoList_VuoImageStereoType  list,
const VuoImageStereoType  value,
const unsigned long  index 
)

Changes the VuoImageStereoType 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_VuoImageStereoType ( VuoList_VuoImageStereoType  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.