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

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_objectVuoLayer_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.
 
VuoList_VuoLayer VuoLayer_getChildLayers (VuoLayer layer)
 Returns a list of this layer's 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_makeWithTransform (VuoText name, VuoImage image, VuoTransform2d transform, 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, VuoBoolean preservePhysicalSize)
 Creates a visible layer that shows an image.
 
VuoLayer VuoLayer_makeRealSizeWithShadow (VuoText name, VuoImage image, VuoPoint2d center, VuoReal alpha, VuoBoolean preservePhysicalSize, 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.
 
VuoLayer VuoLayer_setAnchor (VuoLayer child, VuoAnchor anchor, VuoInteger viewportWidth, VuoInteger viewportHeight, float backingScaleFactor)
 Moves the pivot point of child by creating a parent layer and assigning child with an offset.
 
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.

VuoList_VuoLayer VuoLayer_getChildLayers ( VuoLayer  layer)

Returns a list of this layer's child layers.

struct json_object * VuoLayer_getJson ( const VuoLayer  value)
read
char* VuoLayer_getString ( const VuoLayer  value)

Automatically generated function.

char * VuoLayer_getSummary ( const VuoLayer  value)
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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
imageThe image shown on the layer.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
alphaThe 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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colorThe layer's color.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
heightThe height of the layer, in Vuo Coordinates.
VuoLayer VuoLayer_makeEmpty ( void  )

Creates a new, empty scene object.

VuoLayer VuoLayer_makeFromJson ( json_object js)
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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colorsThe layer's gradient colors.
startThe start point of the gradient, in Vuo Coordinates.
endThe end point of the gradient, in Vuo Coordinates.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
heightThe height of the layer, in Vuo Coordinates.
noiseAmountHow 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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colorThe layer's color.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
heightThe height of the layer, in Vuo Coordinates.
sharpnessHow 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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colorsThe layer's gradient colors.
gradientCenterThe center point of the gradient, in Vuo Coordinates.
radiusThe radius of the gradient, in Vuo Coordinates.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
heightThe height of the layer, in Vuo Coordinates.
noiseAmountHow much random noise to add to the gradient. Typically between 0 and 1.
VuoLayer VuoLayer_makeRealSize ( VuoText  name,
VuoImage  image,
VuoPoint2d  center,
VuoReal  alpha,
VuoBoolean  preservePhysicalSize 
)

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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
imageThe image shown on the layer.
centerThe center of the layer, in Vuo Coordinates.
alphaThe opacity of the layer, 0–1.
preservePhysicalSizeSee VuoSceneObject::preservePhysicalSize
VuoLayer VuoLayer_makeRealSizeWithShadow ( VuoText  name,
VuoImage  image,
VuoPoint2d  center,
VuoReal  alpha,
VuoBoolean  preservePhysicalSize,
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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
imageThe image shown on the layer.
centerThe center of the layer, in Vuo Coordinates.
alphaThe opacity of the layer, 0–1.
preservePhysicalSizeSee VuoSceneObject::preservePhysicalSize
shadowColorThe color of the layer's shadow.
shadowBlurThe amount to blur the layer's shadow, in pixels.
shadowAngleThe angle of the layer's shadow, in degrees.
shadowDistanceThe 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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
colorThe layer's color.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
heightThe height of the layer, in Vuo Coordinates.
sharpnessHow sharp the edges of the rectangle are, from 0 (blurry) to 1 (sharp).
roundnessHow 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
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
imageThe image shown on the layer.
centerThe center of the layer, in Vuo Coordinates.
rotationThe layer's angle, in degrees.
widthThe width of the layer, in Vuo Coordinates.
alphaThe opacity of the layer, 0–1.
shadowColorThe color of the layer's shadow.
shadowBlurThe amount to blur the layer's shadow, in pixels.
shadowAngleThe angle of the layer's shadow, in degrees.
shadowDistanceThe distance that the shadow is offset from the layer, in Vuo Coordinates.
VuoLayer VuoLayer_makeWithTransform ( VuoText  name,
VuoImage  image,
VuoTransform2d  transform,
VuoReal  alpha 
)

Creates a visible layer that shows an image.

Parameters
nameThe layer's name (used by, e.g., VuoRenderedLayers_findLayer).
imageThe image shown on the layer.
transformThe 2d transform that specifies translation, rotation, and scale relative to this layer's parent.
alphaThe opacity of the layer, 0–1.
void VuoLayer_release ( VuoLayer  value)

Automatically generated function.

void VuoLayer_retain ( VuoLayer  value)

Automatically generated function.

VuoLayer VuoLayer_setAnchor ( VuoLayer  child,
VuoAnchor  anchor,
VuoInteger  viewportWidth,
VuoInteger  viewportHeight,
float  backingScaleFactor 
)

Moves the pivot point of child by creating a parent layer and assigning child with an offset.

If anchor is { Center, Center } the unmodified layer is returned.