VuoList_VuoLeapTouchZone

Description

A list of VuoLeapTouchZone elements.

Classes
struct	VuoList_VuoLeapTouchZone_struct
	A list of VuoLeapTouchZone elements. More...

Typedefs
typedef struct VuoList_VuoLeapTouchZone_struct *	VuoList_VuoLeapTouchZone
	A list of VuoLeapTouchZone elements.

Functions
VuoList_VuoLeapTouchZone	VuoListCreate_VuoLeapTouchZone (void)
	Creates a new list of VuoLeapTouchZone elements.
VuoList_VuoLeapTouchZone	VuoListCreateWithCount_VuoLeapTouchZone (const unsigned long count, const VuoLeapTouchZone value)
	Creates a new list of count instances of value.
VuoList_VuoLeapTouchZone	VuoListCopy_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoLeapTouchZone	VuoListGetValue_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list, const unsigned long index)
	Returns the VuoLeapTouchZone at index.
VuoLeapTouchZone *	VuoListGetData_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list)
	Returns a pointer to a C array containing the list items.
void	VuoListSetValue_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list, const VuoLeapTouchZone value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoLeapTouchZone at index.
void	VuoListInsertValue_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list, const VuoLeapTouchZone value, const unsigned long index)
	Inserts the VuoLeapTouchZone immediately before index.
void	VuoListPrependValue_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list, const VuoLeapTouchZone value)
	Prepends value to list.
void	VuoListAppendValue_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list, const VuoLeapTouchZone value)
	Appends value to list.
void	VuoListExchangeValues_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list)
	Reverses the order of the items in list.
VuoList_VuoLeapTouchZone	VuoListSubset_VuoLeapTouchZone (VuoList_VuoLeapTouchZone 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_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list)
	Removes the first value from list.
void	VuoListRemoveLastValue_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list)
	Removes the last value from list.
void	VuoListRemoveAll_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list)
	Removes all values from list.
void	VuoListRemoveValue_VuoLeapTouchZone (VuoList_VuoLeapTouchZone list, const unsigned long index)
	Removes the VuoLeapTouchZone at index.
unsigned long	VuoListGetCount_VuoLeapTouchZone (const VuoList_VuoLeapTouchZone list)
	Returns the number of elements in list.
VuoList_VuoLeapTouchZone	VuoList_VuoLeapTouchZone_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoList_VuoLeapTouchZone_getJson (const VuoList_VuoLeapTouchZone value)
	Encodes value as a JSON object.
char *	VuoList_VuoLeapTouchZone_getSummary (const VuoList_VuoLeapTouchZone value)
	Produces a brief human-readable summary of value.
VuoList_VuoLeapTouchZone	VuoList_VuoLeapTouchZone_makeFromString (const char *str)
	Automatically generated function.
char *	VuoList_VuoLeapTouchZone_getString (const VuoList_VuoLeapTouchZone value)
	Automatically generated function.

---

Class Documentation

struct VuoList_VuoLeapTouchZone_struct

Class Members
void *	l

Typedef Documentation

typedef struct VuoList_VuoLeapTouchZone_struct * VuoList_VuoLeapTouchZone

A list of VuoLeapTouchZone elements.

Function Documentation

struct json_object* VuoList_VuoLeapTouchZone_getJson ( const VuoList_VuoLeapTouchZone  value )

read

Encodes value as a JSON object.

char* VuoList_VuoLeapTouchZone_getString

(

const VuoList_VuoLeapTouchZone

value

)

Automatically generated function.

char* VuoList_VuoLeapTouchZone_getSummary

(

const VuoList_VuoLeapTouchZone

value

)

Produces a brief human-readable summary of value.

VuoList_VuoLeapTouchZone VuoList_VuoLeapTouchZone_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

["uno", "dos", "tres", "catorce"]

VuoList_VuoLeapTouchZone VuoList_VuoLeapTouchZone_makeFromString

(

const char *

str

)

Automatically generated function.

void VuoListAppendValue_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	list,
		const VuoLeapTouchZone	value
	)

Appends value to list.

VuoList_VuoLeapTouchZone VuoListCopy_VuoLeapTouchZone

(

const VuoList_VuoLeapTouchZone

list

)

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

VuoList_VuoLeapTouchZone VuoListCreate_VuoLeapTouchZone

(

void

)

Creates a new list of VuoLeapTouchZone elements.

VuoList_VuoLeapTouchZone VuoListCreateWithCount_VuoLeapTouchZone	(	const unsigned long	count,
		const VuoLeapTouchZone	value
	)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoLeapTouchZone

(

const VuoList_VuoLeapTouchZone

list

)

Returns the number of elements in list.

VuoLeapTouchZone* VuoListGetData_VuoLeapTouchZone

(

const VuoList_VuoLeapTouchZone

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.

VuoLeapTouchZone VuoListGetValue_VuoLeapTouchZone	(	const VuoList_VuoLeapTouchZone	list,
		const unsigned long	index
	)

Returns the VuoLeapTouchZone 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_VuoLeapTouchZone	(	const VuoList_VuoLeapTouchZone	list,
		const VuoLeapTouchZone	value,
		const unsigned long	index
	)

Inserts the VuoLeapTouchZone 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_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	list,
		const VuoLeapTouchZone	value
	)

Prepends value to list.

void VuoListRemoveAll_VuoLeapTouchZone

(

VuoList_VuoLeapTouchZone

list

)

Removes all values from list.

void VuoListRemoveFirstValue_VuoLeapTouchZone

(

VuoList_VuoLeapTouchZone

list

)

Removes the first value from list.

void VuoListRemoveLastValue_VuoLeapTouchZone

(

VuoList_VuoLeapTouchZone

list

)

Removes the last value from list.

void VuoListRemoveValue_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	list,
		const unsigned long	index
	)

Removes the VuoLeapTouchZone 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_VuoLeapTouchZone

(

VuoList_VuoLeapTouchZone

list

)

Reverses the order of the items in list.

void VuoListSetValue_VuoLeapTouchZone	(	const VuoList_VuoLeapTouchZone	list,
		const VuoLeapTouchZone	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoLeapTouchZone 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_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	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_VuoLeapTouchZone VuoListSubset_VuoLeapTouchZone	(	VuoList_VuoLeapTouchZone	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.