Description

A floating-point 2-dimensional Cartesian spatial location.

Classes
struct	VuoList_VuoPoint2d_struct
	List type. More...

Functions
VuoPoint2d	VuoPoint2d_makeFromJson (json_object *js)

json_object *	VuoPoint2d_getJson (const VuoPoint2d value)

char *	VuoPoint2d_getSummary (const VuoPoint2d value)

bool	VuoPoint2d_areEqual (const VuoPoint2d value1, const VuoPoint2d value2)
	Returns true if the two points are equal (within tolerance). More...

bool	VuoPoint2d_areEqualListWithinTolerance (VuoList_VuoPoint2d values, VuoPoint2d tolerance)
	Returns true if the two values are equal within component-wise `tolerance`. More...

bool	VuoPoint2d_isLessThan (const VuoPoint2d a, const VuoPoint2d b)
	Compares `a` to `b` primarily by `x`-value and secondarily by `y`-value, returning true if `a` is less than `b`. More...

bool	VuoPoint2d_isWithinRange (VuoPoint2d value, VuoPoint2d minimum, VuoPoint2d maximum)
	Returns true if each component of `value` is between `minimum` and `maximum`. More...

VuoPoint2d	VuoPoint2d_minList (VuoList_VuoPoint2d values, VuoInteger *outputPosition)
	Returns the minimum of a list of terms, or 0 if the array is empty. More...

VuoPoint2d	VuoPoint2d_maxList (VuoList_VuoPoint2d values, VuoInteger *outputPosition)
	Returns the maximum of a list of terms, or 0 if the array is empty. More...

VuoPoint2d	VuoPoint2d_average (VuoList_VuoPoint2d values)
	Returns the average of the values in the list, or 0 if the list is empty. More...

VuoPoint2d	VuoPoint2d_random (const VuoPoint2d minimum, const VuoPoint2d maximum)
	Returns a pseudorandom value where each component is between `minimum` and `maximum`. More...

VuoPoint2d	VuoPoint2d_randomWithState (unsigned short state[3], const VuoPoint2d minimum, const VuoPoint2d maximum)
	Returns a pseudorandom value where each component is between `minimum` and `maximum`. More...

static VuoPoint2d	VuoPoint2d_make (float x, float y) __attribute__((const))
	Returns a point with the specified coordinates. More...

static VuoPoint2d	VuoPoint2d_makeFromArray (float *f)
	Returns a point using the first 2 elements in the specified array. More...

static void	VuoPoint2d_setArray (float *f, VuoPoint2d p)
	Sets the first 2 elements in the specified array to the specified point. More...

static VuoPoint2d	VuoPoint2d_add (VuoPoint2d a, VuoPoint2d b) __attribute__((const))
	`a` + `b`. More...

static VuoPoint2d	VuoPoint2d_subtract (VuoPoint2d a, VuoPoint2d b) __attribute__((const))
	`a` - `b`. More...

static float	VuoPoint2d_squaredMagnitude (VuoPoint2d a) __attribute__((const))
	Returns the squared magnitude of the vector. More...

static VuoPoint2d	VuoPoint2d_divide (VuoPoint2d a, VuoPoint2d b) __attribute__((const))
	Component-wise division. More...

static VuoPoint2d	VuoPoint2d_makeNonzero (VuoPoint2d a) __attribute__((const))
	If any component of the value is zero or very close to zero, moves it further from zero (either 0.000001 or -0.000001). More...

static float	VuoPoint2d_magnitude (VuoPoint2d a) __attribute__((const))
	Returns the magnitude of the vector. More...

static VuoPoint2d	VuoPoint2d_normalize (VuoPoint2d a) __attribute__((const))
	Returns the normalization of `a`. More...

static VuoPoint2d	VuoPoint2d_multiply (VuoPoint2d a, float b) __attribute__((const))
	`a` * `b` More...

static float	VuoPoint2d_dotProduct (VuoPoint2d u, VuoPoint2d v) __attribute__((const))
	Returns the dot product of `u`, `v`. More...

static float	VuoPoint2d_distance (VuoPoint2d a, VuoPoint2d b) __attribute__((const))
	Distance between `a` and `b`. More...

static VuoPoint2d	VuoPoint2d_min (const VuoPoint2d l, const VuoPoint2d r) __attribute__((const))
	Returns component-wise min. More...

static VuoPoint2d	VuoPoint2d_max (const VuoPoint2d l, const VuoPoint2d r) __attribute__((const))
	Returns component-wise max. More...

static VuoPoint2d	VuoPoint2d_lerp (VuoPoint2d a, VuoPoint2d b, float t) __attribute__((const))
	Returns a linearly interpolated value between `a` and `b` using time `t`. More...

static VuoPoint2d	VuoPoint2d_scale (VuoPoint2d a, VuoPoint2d b) __attribute__((const))
	Returns component-wise multiplication of two VuoPoint2d vectors. More...

static VuoPoint2d	VuoPoint2d_spring (VuoReal timeSinceDrop, VuoPoint2d dropPosition, VuoPoint2d restingPosition, VuoReal period, VuoReal damping)
	Calculates a position along the path of an oscillating spring. More...

static VuoPoint2d	VuoPoint2d_clamp (VuoPoint2d point, VuoReal limitA, VuoReal limitB)
	Limits `point` to values between `limitA` and `limitB`, inclusive. More...

static VuoPoint2d	VuoPoint2d_clampn (VuoPoint2d point, VuoPoint2d limitA, VuoPoint2d limitB)
	Limits `point` to values between `limitA` and `limitB`, inclusive. More...

static VuoPoint2d	VuoPoint2d_bezier3 (VuoPoint2d p0, VuoPoint2d p1, VuoPoint2d p2, VuoPoint2d p3, VuoReal time)
	Calculates a position along a cubic bezier curve. More...

static VuoPoint2d	VuoPoint2d_snap (VuoPoint2d a, VuoPoint2d center, VuoPoint2d snap)
	Snap value a to the nearest increment of value snap. More...

json_object *	VuoPoint3d_getJson (const VuoPoint3d value)

typedef const struct VuoList_VuoPoint2d_struct *	VuoList_VuoPoint2d
	List type. More...

#define	VuoList_VuoPoint2d_TYPE_DEFINED
	List type. More...

VuoPoint2d	VuoPoint2d_makeFromString (const char *str)
	Automatically generated function. More...

char *	VuoPoint2d_getString (const VuoPoint2d value)
	Automatically generated function. More...

void	VuoPoint2d_retain (VuoPoint2d value)
	Automatically generated function. More...

void	VuoPoint2d_release (VuoPoint2d value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoPoint2d_struct

struct VuoList_VuoPoint2d_struct

Class Members
void *	l

Macro Definition Documentation

◆ VuoList_VuoPoint2d_TYPE_DEFINED

#define VuoList_VuoPoint2d_TYPE_DEFINED

List type.

Definition at line 36 of file VuoPoint2d.h.

Typedef Documentation

◆ VuoList_VuoPoint2d

typedef const struct VuoList_VuoPoint2d_struct * VuoList_VuoPoint2d

List type.

Function Documentation

◆ VuoPoint2d_add()

static VuoPoint2d VuoPoint2d_add	(	VuoPoint2d	a,
		VuoPoint2d	b
	)		const

inlinestatic

a + b.

Definition at line 99 of file VuoPoint2d.h.

◆ VuoPoint2d_areEqual()

bool VuoPoint2d_areEqual	(	const VuoPoint2d	value1,
		const VuoPoint2d	value2
	)

Returns true if the two points are equal (within tolerance).

Definition at line 107 of file VuoPoint2d.c.

◆ VuoPoint2d_areEqualListWithinTolerance()

bool VuoPoint2d_areEqualListWithinTolerance	(	VuoList_VuoPoint2d	values,
		VuoPoint2d	tolerance
	)

Returns true if the two values are equal within component-wise tolerance.

Definition at line 116 of file VuoPoint2d.c.

◆ VuoPoint2d_average()

VuoPoint2d VuoPoint2d_average ( VuoList_VuoPoint2d values )

Returns the average of the values in the list, or 0 if the list is empty.

Definition at line 208 of file VuoPoint2d.c.

◆ VuoPoint2d_bezier3()

static VuoPoint2d VuoPoint2d_bezier3	(	VuoPoint2d	p0,
		VuoPoint2d	p1,
		VuoPoint2d	p2,
		VuoPoint2d	p3,
		VuoReal	time
	)

inlinestatic

Calculates a position along a cubic bezier curve.

Parameters

p0	The curve's starting position.
p1	The control point for the curve's starting position.
p2	The control point for the curve's ending position.
p3	The curve's ending position.
time	Which value along the curve should be returned. 0 = starting position, 1 = ending position.

Definition at line 272 of file VuoPoint2d.h.

◆ VuoPoint2d_clamp()

static VuoPoint2d VuoPoint2d_clamp	(	VuoPoint2d	point,
		VuoReal	limitA,
		VuoReal	limitB
	)

inlinestatic

Limits point to values between limitA and limitB, inclusive.

Definition at line 244 of file VuoPoint2d.h.

◆ VuoPoint2d_clampn()

static VuoPoint2d VuoPoint2d_clampn	(	VuoPoint2d	point,
		VuoPoint2d	limitA,
		VuoPoint2d	limitB
	)

inlinestatic

Limits point to values between limitA and limitB, inclusive.

Definition at line 255 of file VuoPoint2d.h.

◆ VuoPoint2d_distance()

static float VuoPoint2d_distance	(	VuoPoint2d	a,
		VuoPoint2d	b
	)		const

inlinestatic

Distance between a and b.

Definition at line 185 of file VuoPoint2d.h.

◆ VuoPoint2d_divide()

static VuoPoint2d VuoPoint2d_divide	(	VuoPoint2d	a,
		VuoPoint2d	b
	)		const

inlinestatic

Component-wise division.

Definition at line 127 of file VuoPoint2d.h.

◆ VuoPoint2d_dotProduct()

static float VuoPoint2d_dotProduct	(	VuoPoint2d	u,
		VuoPoint2d	v
	)		const

inlinestatic

Returns the dot product of u, v.

Definition at line 176 of file VuoPoint2d.h.

◆ VuoPoint2d_getJson()

struct json_object * VuoPoint2d_getJson ( const VuoPoint2d value )

Encodes value as a JSON object.

Definition at line 82 of file VuoPoint2d.c.

◆ VuoPoint2d_getString()

char* VuoPoint2d_getString ( const VuoPoint2d value )

Automatically generated function.

◆ VuoPoint2d_getSummary()

char * VuoPoint2d_getSummary ( const VuoPoint2d value )

Returns a compact string representation of value (comma-separated coordinates).

Definition at line 99 of file VuoPoint2d.c.

◆ VuoPoint2d_isLessThan()

bool VuoPoint2d_isLessThan	(	const VuoPoint2d	a,
		const VuoPoint2d	b
	)

Compares a to b primarily by x-value and secondarily by y-value, returning true if a is less than b.

Changed in Vuo 2.0.0:: New.

Definition at line 141 of file VuoPoint2d.c.

◆ VuoPoint2d_isWithinRange()

bool VuoPoint2d_isWithinRange	(	VuoPoint2d	value,
		VuoPoint2d	minimum,
		VuoPoint2d	maximum
	)

Returns true if each component of value is between minimum and maximum.

Definition at line 151 of file VuoPoint2d.c.

◆ VuoPoint2d_lerp()

static VuoPoint2d VuoPoint2d_lerp	(	VuoPoint2d	a,
		VuoPoint2d	b,
		float	t
	)		const

inlinestatic

Returns a linearly interpolated value between a and b using time t.

t is between 0 and 1.

Definition at line 216 of file VuoPoint2d.h.

◆ VuoPoint2d_magnitude()

static float VuoPoint2d_magnitude ( VuoPoint2d a ) const

inlinestatic

Returns the magnitude of the vector.

Definition at line 149 of file VuoPoint2d.h.

◆ VuoPoint2d_make()

static VuoPoint2d VuoPoint2d_make	(	float	x,
		float	y
	)		const

inlinestatic

Returns a point with the specified coordinates.

Changed in Vuo 2.0.0:: New.

Definition at line 71 of file VuoPoint2d.h.

◆ VuoPoint2d_makeFromArray()

static VuoPoint2d VuoPoint2d_makeFromArray ( float * f )

inlinestatic

Returns a point using the first 2 elements in the specified array.

Changed in Vuo 2.0.0:: New.

Definition at line 81 of file VuoPoint2d.h.

◆ VuoPoint2d_makeFromJson()

VuoPoint2d VuoPoint2d_makeFromJson ( json_object * js )

Decodes the JSON object js to create a new value.

Example:: {

"x" : 0.5,

"y" : 1

}

Definition at line 41 of file VuoPoint2d.c.

◆ VuoPoint2d_makeFromString()

VuoPoint2d VuoPoint2d_makeFromString ( const char * str )

Automatically generated function.

◆ VuoPoint2d_makeNonzero()

static VuoPoint2d VuoPoint2d_makeNonzero ( VuoPoint2d a ) const

inlinestatic

If any component of the value is zero or very close to zero, moves it further from zero (either 0.000001 or -0.000001).

Definition at line 136 of file VuoPoint2d.h.

◆ VuoPoint2d_max()

static VuoPoint2d VuoPoint2d_max	(	const VuoPoint2d	l,
		const VuoPoint2d	r
	)		const

inlinestatic

Returns component-wise max.

Definition at line 205 of file VuoPoint2d.h.

◆ VuoPoint2d_maxList()

VuoPoint2d VuoPoint2d_maxList	(	VuoList_VuoPoint2d	values,
		VuoInteger *	outputPosition
	)

Returns the maximum of a list of terms, or 0 if the array is empty.

Definition at line 184 of file VuoPoint2d.c.

◆ VuoPoint2d_min()

static VuoPoint2d VuoPoint2d_min	(	const VuoPoint2d	l,
		const VuoPoint2d	r
	)		const

inlinestatic

Returns component-wise min.

Definition at line 194 of file VuoPoint2d.h.

◆ VuoPoint2d_minList()

VuoPoint2d VuoPoint2d_minList	(	VuoList_VuoPoint2d	values,
		VuoInteger *	outputPosition
	)

Returns the minimum of a list of terms, or 0 if the array is empty.

Definition at line 160 of file VuoPoint2d.c.

◆ VuoPoint2d_multiply()

static VuoPoint2d VuoPoint2d_multiply	(	VuoPoint2d	a,
		float	b
	)		const

inlinestatic

a * b

Definition at line 167 of file VuoPoint2d.h.

◆ VuoPoint2d_normalize()

static VuoPoint2d VuoPoint2d_normalize ( VuoPoint2d a ) const

inlinestatic

Returns the normalization of a.

Definition at line 158 of file VuoPoint2d.h.

◆ VuoPoint2d_random()

VuoPoint2d VuoPoint2d_random	(	const VuoPoint2d	minimum,
		const VuoPoint2d	maximum
	)

Returns a pseudorandom value where each component is between minimum and maximum.

See also: VuoInteger_random

Definition at line 227 of file VuoPoint2d.c.

◆ VuoPoint2d_randomWithState()

VuoPoint2d VuoPoint2d_randomWithState	(	unsigned short	state[3],
		const VuoPoint2d	minimum,
		const VuoPoint2d	maximum
	)

Returns a pseudorandom value where each component is between minimum and maximum.

See also: VuoInteger_randomWithState

Definition at line 239 of file VuoPoint2d.c.

◆ VuoPoint2d_release()

void VuoPoint2d_release ( VuoPoint2d value )

Automatically generated function.

◆ VuoPoint2d_retain()

void VuoPoint2d_retain ( VuoPoint2d value )

Automatically generated function.

◆ VuoPoint2d_scale()

static VuoPoint2d VuoPoint2d_scale	(	VuoPoint2d	a,
		VuoPoint2d	b
	)		const

inlinestatic

Returns component-wise multiplication of two VuoPoint2d vectors.

Definition at line 225 of file VuoPoint2d.h.

◆ VuoPoint2d_setArray()

static void VuoPoint2d_setArray	(	float *	f,
		VuoPoint2d	p
	)

inlinestatic

Sets the first 2 elements in the specified array to the specified point.

Definition at line 89 of file VuoPoint2d.h.

◆ VuoPoint2d_snap()

static VuoPoint2d VuoPoint2d_snap	(	VuoPoint2d	a,
		VuoPoint2d	center,
		VuoPoint2d	snap
	)

inlinestatic

Snap value a to the nearest increment of value snap.

Definition at line 283 of file VuoPoint2d.h.

◆ VuoPoint2d_spring()

static VuoPoint2d VuoPoint2d_spring	(	VuoReal	timeSinceDrop,
		VuoPoint2d	dropPosition,
		VuoPoint2d	restingPosition,
		VuoReal	period,
		VuoReal	damping
	)

inlinestatic

Calculates a position along the path of an oscillating spring.

Definition at line 233 of file VuoPoint2d.h.

◆ VuoPoint2d_squaredMagnitude()

static float VuoPoint2d_squaredMagnitude ( VuoPoint2d a ) const

inlinestatic

Returns the squared magnitude of the vector.

Definition at line 118 of file VuoPoint2d.h.

◆ VuoPoint2d_subtract()

static VuoPoint2d VuoPoint2d_subtract	(	VuoPoint2d	a,
		VuoPoint2d	b
	)		const

inlinestatic

a - b.

Definition at line 108 of file VuoPoint2d.h.

◆ VuoPoint3d_getJson()

json_object* VuoPoint3d_getJson ( const VuoPoint3d value )

Encodes value as a JSON object.

Definition at line 91 of file VuoPoint3d.c.

Description

Classes

Functions

Class Documentation

◆ VuoList_VuoPoint2d_struct

Macro Definition Documentation

◆ VuoList_VuoPoint2d_TYPE_DEFINED

Typedef Documentation

◆ VuoList_VuoPoint2d

Function Documentation

◆ VuoPoint2d_add()

◆ VuoPoint2d_areEqual()

◆ VuoPoint2d_areEqualListWithinTolerance()

◆ VuoPoint2d_average()

◆ VuoPoint2d_bezier3()

◆ VuoPoint2d_clamp()

◆ VuoPoint2d_clampn()

◆ VuoPoint2d_distance()

◆ VuoPoint2d_divide()

◆ VuoPoint2d_dotProduct()

◆ VuoPoint2d_getJson()

◆ VuoPoint2d_getString()

◆ VuoPoint2d_getSummary()

◆ VuoPoint2d_isLessThan()

◆ VuoPoint2d_isWithinRange()

◆ VuoPoint2d_lerp()

◆ VuoPoint2d_magnitude()

◆ VuoPoint2d_make()

◆ VuoPoint2d_makeFromArray()

◆ VuoPoint2d_makeFromJson()

◆ VuoPoint2d_makeFromString()

◆ VuoPoint2d_makeNonzero()

◆ VuoPoint2d_max()

◆ VuoPoint2d_maxList()

◆ VuoPoint2d_min()

◆ VuoPoint2d_minList()

◆ VuoPoint2d_multiply()

◆ VuoPoint2d_normalize()

◆ VuoPoint2d_random()

◆ VuoPoint2d_randomWithState()

◆ VuoPoint2d_release()

◆ VuoPoint2d_retain()

◆ VuoPoint2d_scale()

◆ VuoPoint2d_setArray()

◆ VuoPoint2d_snap()

◆ VuoPoint2d_spring()

◆ VuoPoint2d_squaredMagnitude()

◆ VuoPoint2d_subtract()

◆ VuoPoint3d_getJson()