VuoCoordinateUnit

Description

The unit a coordinate uses.

Macros
#define	VuoCoordinateUnit_SUPPORTS_COMPARISON
	Instances of this type can be compared and sorted.

Enumerations
enum	VuoCoordinateUnit { VuoCoordinateUnit_Points , VuoCoordinateUnit_Pixels , VuoCoordinateUnit_VuoCoordinates }
	The unit a coordinate uses. More...

Functions
VuoCoordinateUnit	VuoCoordinateUnit_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoCoordinateUnit_getJson (const VuoCoordinateUnit value)
	Encodes value as a JSON object.
VuoList_VuoCoordinateUnit	VuoCoordinateUnit_getAllowedValues (void)
	Returns a list of values that instances of this type can have.
char *	VuoCoordinateUnit_getSummary (const VuoCoordinateUnit value)
	Returns a compact string representation of value.
bool	VuoCoordinateUnit_areEqual (const VuoCoordinateUnit valueA, const VuoCoordinateUnit valueB)
	Returns true if the two values are equal.
bool	VuoCoordinateUnit_isLessThan (const VuoCoordinateUnit valueA, const VuoCoordinateUnit valueB)
	Returns true if valueA is less than valueB.
char *	VuoCoordinateUnit_getString (const VuoCoordinateUnit value)
	Automatically generated function.
void	VuoCoordinateUnit_retain (VuoCoordinateUnit value)
	Automatically generated function.
void	VuoCoordinateUnit_release (VuoCoordinateUnit value)
	Automatically generated function.

Macro Definition Documentation

VuoCoordinateUnit_SUPPORTS_COMPARISON

#define VuoCoordinateUnit_SUPPORTS_COMPARISON

Instances of this type can be compared and sorted.

Definition at line 35 of file VuoCoordinateUnit.h.

Enumeration Type Documentation

VuoCoordinateUnit

enum VuoCoordinateUnit

The unit a coordinate uses.

Definition at line 28 of file VuoCoordinateUnit.h.

Function Documentation

VuoCoordinateUnit_areEqual()

bool VuoCoordinateUnit_areEqual	(	const VuoCoordinateUnit	valueA,
		const VuoCoordinateUnit	valueB
	)

Returns true if the two values are equal.

Definition at line 95 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_getAllowedValues()

VuoList_VuoCoordinateUnit VuoCoordinateUnit_getAllowedValues

(

void

)

Returns a list of values that instances of this type can have.

Definition at line 68 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_getJson()

struct json_object * VuoCoordinateUnit_getJson

(

const VuoCoordinateUnit

value

)

Encodes value as a JSON object.

Definition at line 53 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_getString()

char * VuoCoordinateUnit_getString

(

const VuoCoordinateUnit

value

)

Automatically generated function.

VuoCoordinateUnit_getSummary()

char * VuoCoordinateUnit_getSummary

(

const VuoCoordinateUnit

value

)

Returns a compact string representation of value.

Definition at line 80 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_isLessThan()

bool VuoCoordinateUnit_isLessThan	(	const VuoCoordinateUnit	valueA,
		const VuoCoordinateUnit	valueB
	)

Returns true if valueA is less than valueB.

Definition at line 103 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_makeFromJson()

VuoCoordinateUnit VuoCoordinateUnit_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

"pixels"

Definition at line 34 of file VuoCoordinateUnit.c.

VuoCoordinateUnit_release()

void VuoCoordinateUnit_release

(

VuoCoordinateUnit

value

)

Automatically generated function.

VuoCoordinateUnit_retain()

void VuoCoordinateUnit_retain

(

VuoCoordinateUnit

value

)

Automatically generated function.