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

Description

A list of VuoPoint2d elements.

Classes

struct  VuoList_VuoPoint2d_struct
 A list of VuoPoint2d elements. More...
 

Typedefs

typedef struct
VuoList_VuoPoint2d_struct
VuoList_VuoPoint2d
 A list of VuoPoint2d elements.
 

Functions

VuoList_VuoPoint2d VuoListCreate_VuoPoint2d (void)
 Creates a new list of VuoPoint2d elements.
 
VuoList_VuoPoint2d VuoListCreateWithCount_VuoPoint2d (const unsigned long count, const VuoPoint2d value)
 Creates a new list of count instances of value.
 
VuoList_VuoPoint2d VuoListCopy_VuoPoint2d (const VuoList_VuoPoint2d list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoPoint2d VuoListGetValue_VuoPoint2d (const VuoList_VuoPoint2d list, const unsigned long index)
 Returns the VuoPoint2d at index.
 
VuoPoint2dVuoListGetData_VuoPoint2d (const VuoList_VuoPoint2d list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoPoint2d (const VuoList_VuoPoint2d list, const VuoPoint2d value, const unsigned long index)
 Changes the VuoPoint2d at index.
 
void VuoListInsertValue_VuoPoint2d (const VuoList_VuoPoint2d list, const VuoPoint2d value, const unsigned long index)
 Inserts the VuoPoint2d immediately before index.
 
void VuoListPrependValue_VuoPoint2d (VuoList_VuoPoint2d list, const VuoPoint2d value)
 Prepends value to list.
 
void VuoListAppendValue_VuoPoint2d (VuoList_VuoPoint2d list, const VuoPoint2d value)
 Appends value to list.
 
void VuoListExchangeValues_VuoPoint2d (VuoList_VuoPoint2d list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoPoint2d (VuoList_VuoPoint2d list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoPoint2d (VuoList_VuoPoint2d list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoPoint2d (VuoList_VuoPoint2d 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_VuoPoint2d (VuoList_VuoPoint2d list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoPoint2d (VuoList_VuoPoint2d list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoPoint2d (VuoList_VuoPoint2d list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoPoint2d (VuoList_VuoPoint2d list, const unsigned long index)
 Removes the VuoPoint2d at index.
 
unsigned long VuoListGetCount_VuoPoint2d (const VuoList_VuoPoint2d list)
 Returns the number of elements in list.
 
VuoList_VuoPoint2d VuoList_VuoPoint2d_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoPoint2d_getJson (const VuoList_VuoPoint2d value)
 Encodes value as a JSON object.
 
char * VuoList_VuoPoint2d_getSummary (const VuoList_VuoPoint2d value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoPoint2d VuoList_VuoPoint2d_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoPoint2d_getString (const VuoList_VuoPoint2d value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoPoint2d_struct
Class Members
void * l

Typedef Documentation

A list of VuoPoint2d elements.

Function Documentation

struct json_object* VuoList_VuoPoint2d_getJson ( const VuoList_VuoPoint2d  value)
read

Encodes value as a JSON object.

char* VuoList_VuoPoint2d_getString ( const VuoList_VuoPoint2d  value)

Automatically generated function.

char* VuoList_VuoPoint2d_getSummary ( const VuoList_VuoPoint2d  value)

Produces a brief human-readable summary of value.

VuoList_VuoPoint2d VuoList_VuoPoint2d_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoPoint2d ( VuoList_VuoPoint2d  list,
const VuoPoint2d  value 
)

Appends value to list.

VuoList_VuoPoint2d VuoListCopy_VuoPoint2d ( const VuoList_VuoPoint2d  list)

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

VuoList_VuoPoint2d VuoListCreate_VuoPoint2d ( void  )

Creates a new list of VuoPoint2d elements.

VuoList_VuoPoint2d VuoListCreateWithCount_VuoPoint2d ( const unsigned long  count,
const VuoPoint2d  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoPoint2d ( VuoList_VuoPoint2d  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_VuoPoint2d ( VuoList_VuoPoint2d  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoPoint2d ( const VuoList_VuoPoint2d  list)

Returns the number of elements in list.

VuoPoint2d* VuoListGetData_VuoPoint2d ( const VuoList_VuoPoint2d  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.

VuoPoint2d VuoListGetValue_VuoPoint2d ( const VuoList_VuoPoint2d  list,
const unsigned long  index 
)

Returns the VuoPoint2d 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_VuoPoint2d ( const VuoList_VuoPoint2d  list,
const VuoPoint2d  value,
const unsigned long  index 
)

Inserts the VuoPoint2d 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_VuoPoint2d ( VuoList_VuoPoint2d  list,
const VuoPoint2d  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoPoint2d ( VuoList_VuoPoint2d  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoPoint2d ( VuoList_VuoPoint2d  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoPoint2d ( VuoList_VuoPoint2d  list)

Removes the last value from list.

void VuoListRemoveValue_VuoPoint2d ( VuoList_VuoPoint2d  list,
const unsigned long  index 
)

Removes the VuoPoint2d 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_VuoPoint2d ( VuoList_VuoPoint2d  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoPoint2d ( const VuoList_VuoPoint2d  list,
const VuoPoint2d  value,
const unsigned long  index 
)

Changes the VuoPoint2d 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_VuoPoint2d ( VuoList_VuoPoint2d  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.