VuoLayer

Description

A 2D Object: visible (image), or virtual (group).

Classes
struct	VuoLayer
	A 2D Object: visible (image), or virtual (group). More...

Typedefs
typedef struct VuoLayer	VuoLayer
	A 2D Object: visible (image), or virtual (group).

Functions
VuoLayer	VuoLayer_makeFromJson (json_object *js)
json_object *	VuoLayer_getJson (const VuoLayer value)
char *	VuoLayer_getSummary (const VuoLayer value)
VuoLayer	VuoLayer_makeEmpty (void)
	Creates a new, empty scene object.
VuoLayer	VuoLayer_makeGroup (VuoList_VuoLayer childLayers, VuoTransform2d transform)
	Creates a layer with a group of child layers.
VuoLayer	VuoLayer_make (VuoText name, VuoImage image, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal alpha)
	Creates a visible layer that shows an image.
VuoLayer	VuoLayer_makeWithShadow (VuoText name, VuoImage image, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal alpha, VuoColor shadowColor, VuoReal shadowBlur, VuoReal shadowAngle, VuoReal shadowDistance)
	Creates a visible layer with a shadow.
VuoLayer	VuoLayer_makeRealSize (VuoText name, VuoImage image, VuoPoint2d center, VuoReal alpha)
	Creates a visible layer that shows an image.
VuoLayer	VuoLayer_makeRealSizeWithShadow (VuoText name, VuoImage image, VuoPoint2d center, VuoReal alpha, VuoColor shadowColor, VuoReal shadowBlur, VuoReal shadowAngle, VuoReal shadowDistance)
	Creates a visible layer with a shadow.
VuoLayer	VuoLayer_makeColor (VuoText name, VuoColor color, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal height)
	Creates a rectangular layer with the specified color.
VuoLayer	VuoLayer_makeOval (VuoText name, VuoColor color, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal height, VuoReal sharpness)
	Creates an oval layer with the specified color.
VuoLayer	VuoLayer_makeRoundedRectangle (VuoText name, VuoColor color, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal height, VuoReal sharpness, VuoReal roundness)
	Creates a rounded rectangle layer with the specified color.
VuoLayer	VuoLayer_makeLinearGradient (VuoText name, VuoList_VuoColor colors, VuoPoint2d start, VuoPoint2d end, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal height, VuoReal noiseAmount)
	Creates a visible layer with a linear gradient.
VuoLayer	VuoLayer_makeRadialGradient (VuoText name, VuoList_VuoColor colors, VuoPoint2d gradientCenter, VuoReal radius, VuoPoint2d center, VuoReal rotation, VuoReal width, VuoReal height, VuoReal noiseAmount)
	Creates a visible layer with a radial gradient.
VuoRectangle	VuoLayer_getBoundingRectangle (VuoLayer layer, VuoInteger viewportWidth, VuoInteger viewportHeight, float backingScaleFactor)
	Returns the minimal rectangle enclosing the layer and its child layers.
bool	VuoLayer_isPopulated (VuoLayer layer)
	Returns true if the layer or any of its children have a non-empty type.
VuoLayer	VuoLayer_makeFromString (const char *str)
	Automatically generated function.
char *	VuoLayer_getString (const VuoLayer value)
	Automatically generated function.
void	VuoLayer_retain (VuoLayer value)
	Automatically generated function.
void	VuoLayer_release (VuoLayer value)
	Automatically generated function.

---

Class Documentation

struct VuoLayer

Class Members
VuoSceneObject	sceneObject	A VuoLayer is secretly just a VuoSceneObject.

Typedef Documentation

typedef struct VuoLayer VuoLayer

A 2D Object: visible (image), or virtual (group).

Todo:

Ideally this should just be typedef VuoSceneObject VuoLayer, but https://b33p.net/kosada/node/6824

Function Documentation

VuoRectangle VuoLayer_getBoundingRectangle	(	VuoLayer	layer,
		VuoInteger	viewportWidth,
		VuoInteger	viewportHeight,
		float	backingScaleFactor
	)

Returns the minimal rectangle enclosing the layer and its child layers.

struct json_object * VuoLayer_getJson ( const VuoLayer  value )

read

See Also

VuoSceneObject_getJson

char* VuoLayer_getString

(

const VuoLayer

value

)

Automatically generated function.

char * VuoLayer_getSummary

(

const VuoLayer

value

)

See Also

VuoSceneObject_getSummary

bool VuoLayer_isPopulated

(

VuoLayer

layer

)

Returns true if the layer or any of its children have a non-empty type.

VuoLayer VuoLayer_make	(	VuoText	name,
		VuoImage	image,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	alpha
	)

Creates a visible layer that shows an image.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
image	The image shown on the layer.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
alpha	The opacity of the layer, 0–1.

VuoLayer VuoLayer_makeColor	(	VuoText	name,
		VuoColor	color,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	height
	)

Creates a rectangular layer with the specified color.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
color	The layer's color.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
height	The height of the layer, in Vuo Coordinates.

VuoLayer VuoLayer_makeEmpty

(

void

)

Creates a new, empty scene object.

VuoLayer VuoLayer_makeFromJson

(

json_object *

js

)

See Also

VuoSceneObject_makeFromJson

VuoLayer VuoLayer_makeFromString

(

const char *

str

)

Automatically generated function.

VuoLayer VuoLayer_makeGroup	(	VuoList_VuoLayer	childLayers,
		VuoTransform2d	transform
	)

Creates a layer with a group of child layers.

VuoLayer VuoLayer_makeLinearGradient	(	VuoText	name,
		VuoList_VuoColor	colors,
		VuoPoint2d	start,
		VuoPoint2d	end,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	height,
		VuoReal	noiseAmount
	)

Creates a visible layer with a linear gradient.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colors	The layer's gradient colors.
start	The start point of the gradient, in Vuo Coordinates.
end	The end point of the gradient, in Vuo Coordinates.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
height	The height of the layer, in Vuo Coordinates.
noiseAmount	How much random noise to add to the gradient. Typically between 0 and 1.

VuoLayer VuoLayer_makeOval	(	VuoText	name,
		VuoColor	color,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	height,
		VuoReal	sharpness
	)

Creates an oval layer with the specified color.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
color	The layer's color.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
height	The height of the layer, in Vuo Coordinates.
sharpness	How sharp the edge of the oval is, from 0 (blurry) to 1 (sharp).

VuoLayer VuoLayer_makeRadialGradient	(	VuoText	name,
		VuoList_VuoColor	colors,
		VuoPoint2d	gradientCenter,
		VuoReal	radius,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	height,
		VuoReal	noiseAmount
	)

Creates a visible layer with a radial gradient.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colors	The layer's gradient colors.
gradientCenter	The center point of the gradient, in Vuo Coordinates.
radius	The radius of the gradient, in Vuo Coordinates.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
height	The height of the layer, in Vuo Coordinates.
noiseAmount	How much random noise to add to the gradient. Typically between 0 and 1.

VuoLayer VuoLayer_makeRealSize	(	VuoText	name,
		VuoImage	image,
		VuoPoint2d	center,
		VuoReal	alpha
	)

Creates a visible layer that shows an image.

The layer is the exact pixel-perfect size of the image (regardless of transform), and the position is quantized so edges land on whole pixels.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
image	The image shown on the layer.
center	The center of the layer, in Vuo Coordinates.
alpha	The opacity of the layer, 0–1.

VuoLayer VuoLayer_makeRealSizeWithShadow	(	VuoText	name,
		VuoImage	image,
		VuoPoint2d	center,
		VuoReal	alpha,
		VuoColor	shadowColor,
		VuoReal	shadowBlur,
		VuoReal	shadowAngle,
		VuoReal	shadowDistance
	)

Creates a visible layer with a shadow.

The layer is the exact pixel-perfect size of the image (regardless of transform), and the position is quantized so edges land on whole pixels.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
image	The image shown on the layer.
center	The center of the layer, in Vuo Coordinates.
alpha	The opacity of the layer, 0–1.
shadowColor	The color of the layer's shadow.
shadowBlur	The amount to blur the layer's shadow, in pixels.
shadowAngle	The angle of the layer's shadow, in degrees.
shadowDistance	The distance that the shadow is offset from the layer, in Vuo Coordinates.

VuoLayer VuoLayer_makeRoundedRectangle	(	VuoText	name,
		VuoColor	color,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	height,
		VuoReal	sharpness,
		VuoReal	roundness
	)

Creates a rounded rectangle layer with the specified color.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
color	The layer's color.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
height	The height of the layer, in Vuo Coordinates.
sharpness	How sharp the edges of the rectangle are, from 0 (blurry) to 1 (sharp).
roundness	How round the corners of the rectangle are, from 0 (rectangular) to 1 (circular / capsular).

VuoLayer VuoLayer_makeWithShadow	(	VuoText	name,
		VuoImage	image,
		VuoPoint2d	center,
		VuoReal	rotation,
		VuoReal	width,
		VuoReal	alpha,
		VuoColor	shadowColor,
		VuoReal	shadowBlur,
		VuoReal	shadowAngle,
		VuoReal	shadowDistance
	)

Creates a visible layer with a shadow.

Parameters

name	The layer's name (used by, e.g., VuoRenderedLayers_findLayer).
image	The image shown on the layer.
center	The center of the layer, in Vuo Coordinates.
rotation	The layer's angle, in degrees.
width	The width of the layer, in Vuo Coordinates.
alpha	The opacity of the layer, 0–1.
shadowColor	The color of the layer's shadow.
shadowBlur	The amount to blur the layer's shadow, in pixels.
shadowAngle	The angle of the layer's shadow, in degrees.
shadowDistance	The distance that the shadow is offset from the layer, in Vuo Coordinates.

void VuoLayer_release

(

VuoLayer

value

)

Automatically generated function.

void VuoLayer_retain

(

VuoLayer

value

)

Automatically generated function.