Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoPixelShape

Description

A list of VuoPixelShape elements.

Classes

struct  VuoList_VuoPixelShape_struct
 A list of VuoPixelShape elements. More...
 

Typedefs

typedef const struct VuoList_VuoPixelShape_structVuoList_VuoPixelShape
 A list of VuoPixelShape elements. More...
 

Functions

VuoList_VuoPixelShape VuoListCreate_VuoPixelShape (void)
 Creates a new list of VuoPixelShape elements. More...
 
VuoList_VuoPixelShape VuoListCreateWithCount_VuoPixelShape (const unsigned long count, const VuoPixelShape value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoPixelShape VuoListCopy_VuoPixelShape (const VuoList_VuoPixelShape list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoPixelShape VuoListGetValue_VuoPixelShape (const VuoList_VuoPixelShape list, const unsigned long index)
 Returns the VuoPixelShape at index. More...
 
VuoPixelShapeVuoListGetData_VuoPixelShape (const VuoList_VuoPixelShape list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoPixelShape (const VuoList_VuoPixelShape list, bool(^function)(const VuoPixelShape value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoPixelShape (const VuoList_VuoPixelShape list, const VuoPixelShape value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoPixelShape at index. More...
 
void VuoListInsertValue_VuoPixelShape (const VuoList_VuoPixelShape list, const VuoPixelShape value, const unsigned long index)
 Inserts the VuoPixelShape immediately before index. More...
 
void VuoListPrependValue_VuoPixelShape (VuoList_VuoPixelShape list, const VuoPixelShape value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoPixelShape (VuoList_VuoPixelShape list, const VuoPixelShape value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoPixelShape (VuoList_VuoPixelShape list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoPixelShape (VuoList_VuoPixelShape list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoPixelShape (VuoList_VuoPixelShape list)
 Reverses the order of the items in list. More...
 
VuoList_VuoPixelShape VuoListSubset_VuoPixelShape (VuoList_VuoPixelShape 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_VuoPixelShape (VuoList_VuoPixelShape list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoPixelShape (VuoList_VuoPixelShape list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoPixelShape (VuoList_VuoPixelShape list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoPixelShape (VuoList_VuoPixelShape list, const unsigned long index)
 Removes the VuoPixelShape at index. More...
 
unsigned long VuoListGetCount_VuoPixelShape (const VuoList_VuoPixelShape list)
 Returns the number of elements in list. More...
 
VuoList_VuoPixelShape VuoList_VuoPixelShape_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoPixelShape_getJson (const VuoList_VuoPixelShape value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoPixelShape_getSummary (const VuoList_VuoPixelShape value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoPixelShape VuoList_VuoPixelShape_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoPixelShape_getString (const VuoList_VuoPixelShape value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoPixelShape_struct

struct VuoList_VuoPixelShape_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoPixelShape

A list of VuoPixelShape elements.

Function Documentation

◆ VuoList_VuoPixelShape_getJson()

struct json_object* VuoList_VuoPixelShape_getJson ( const VuoList_VuoPixelShape  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoPixelShape.cc.

◆ VuoList_VuoPixelShape_getString()

char* VuoList_VuoPixelShape_getString ( const VuoList_VuoPixelShape  value)

Automatically generated function.

◆ VuoList_VuoPixelShape_getSummary()

char* VuoList_VuoPixelShape_getSummary ( const VuoList_VuoPixelShape  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoPixelShape.cc.

◆ VuoList_VuoPixelShape_makeFromJson()

VuoList_VuoPixelShape VuoList_VuoPixelShape_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_VuoPixelShape.cc.

◆ VuoList_VuoPixelShape_makeFromString()

VuoList_VuoPixelShape VuoList_VuoPixelShape_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoPixelShape()

void VuoListAppendValue_VuoPixelShape ( VuoList_VuoPixelShape  list,
const VuoPixelShape  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoPixelShape.cc.

◆ VuoListCopy_VuoPixelShape()

VuoList_VuoPixelShape VuoListCopy_VuoPixelShape ( const VuoList_VuoPixelShape  list)

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

Definition at line 174 of file VuoList_VuoPixelShape.cc.

◆ VuoListCreate_VuoPixelShape()

VuoList_VuoPixelShape VuoListCreate_VuoPixelShape ( void  )

Creates a new list of VuoPixelShape elements.

Definition at line 154 of file VuoList_VuoPixelShape.cc.

◆ VuoListCreateWithCount_VuoPixelShape()

VuoList_VuoPixelShape VuoListCreateWithCount_VuoPixelShape ( const unsigned long  count,
const VuoPixelShape  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoPixelShape.cc.

◆ VuoListExchangeValues_VuoPixelShape()

void VuoListExchangeValues_VuoPixelShape ( VuoList_VuoPixelShape  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_VuoPixelShape.cc.

◆ VuoListForeach_VuoPixelShape()

void VuoListForeach_VuoPixelShape ( const VuoList_VuoPixelShape  list,
bool(^)(const VuoPixelShape 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_VuoPixelShape.cc.

◆ VuoListGetCount_VuoPixelShape()

unsigned long VuoListGetCount_VuoPixelShape ( const VuoList_VuoPixelShape  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoPixelShape.cc.

◆ VuoListGetData_VuoPixelShape()

VuoPixelShape* VuoListGetData_VuoPixelShape ( const VuoList_VuoPixelShape  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_VuoPixelShape.cc.

◆ VuoListGetValue_VuoPixelShape()

VuoPixelShape VuoListGetValue_VuoPixelShape ( const VuoList_VuoPixelShape  list,
const unsigned long  index 
)

Returns the VuoPixelShape 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_VuoPixelShape or VuoListForeach_VuoPixelShape.

Definition at line 203 of file VuoList_VuoPixelShape.cc.

◆ VuoListInsertValue_VuoPixelShape()

void VuoListInsertValue_VuoPixelShape ( const VuoList_VuoPixelShape  list,
const VuoPixelShape  value,
const unsigned long  index 
)

Inserts the VuoPixelShape 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_VuoPixelShape.cc.

◆ VuoListPrependValue_VuoPixelShape()

void VuoListPrependValue_VuoPixelShape ( VuoList_VuoPixelShape  list,
const VuoPixelShape  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoPixelShape.cc.

◆ VuoListRemoveAll_VuoPixelShape()

void VuoListRemoveAll_VuoPixelShape ( VuoList_VuoPixelShape  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoPixelShape.cc.

◆ VuoListRemoveFirstValue_VuoPixelShape()

void VuoListRemoveFirstValue_VuoPixelShape ( VuoList_VuoPixelShape  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoPixelShape.cc.

◆ VuoListRemoveLastValue_VuoPixelShape()

void VuoListRemoveLastValue_VuoPixelShape ( VuoList_VuoPixelShape  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoPixelShape.cc.

◆ VuoListRemoveValue_VuoPixelShape()

void VuoListRemoveValue_VuoPixelShape ( VuoList_VuoPixelShape  list,
const unsigned long  index 
)

Removes the VuoPixelShape 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_VuoPixelShape.cc.

◆ VuoListReverse_VuoPixelShape()

void VuoListReverse_VuoPixelShape ( VuoList_VuoPixelShape  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoPixelShape.cc.

◆ VuoListSetValue_VuoPixelShape()

void VuoListSetValue_VuoPixelShape ( const VuoList_VuoPixelShape  list,
const VuoPixelShape  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoPixelShape 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_VuoPixelShape.cc.

◆ VuoListShuffle_VuoPixelShape()

void VuoListShuffle_VuoPixelShape ( VuoList_VuoPixelShape  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_VuoPixelShape.cc.

◆ VuoListSubset_VuoPixelShape()

VuoList_VuoPixelShape VuoListSubset_VuoPixelShape ( VuoList_VuoPixelShape  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_VuoPixelShape.cc.