RenderOverlay

Description

The overlay module provides an interface for manipulating 2D overlay objects rendered on the 3D window.

Functions

OverlayNode

String name ()

void / Object {red, green, blue, alpha} color ([Object {red, green, blue, alpha}])

• This function sets the value if the object is sent as an argument and returns void, and returns the current color value if argument is not sent as an argument.

OverlayTextNode (inherits OverlayNode)

String text ([String text])

• Get/Set

Object { length, height } size ()

OverlayGroupNode (inherits OverlayNode)

Node lookup (String name)

Bool add (Object o)

Bool remove (Object o)

Number childCount ()

OverlaySwitchNode (inherits OverlayGroupNode)

Bool switchState (Number which, Bool state)

Bool setSwitchStateAll (Bool state)

Bool enableSingleSwitchState (Bool state)

OverlayTransformNode (inherits OverlayGroupNode)

Number[] position ({x: Number, y: Number})

Number[] position (Number x, Number y)

Number[] position ([Number, Number])

Number[] position (Number)

Number rotation ([Number])

• Get/Set

Number[] scale ({x: Number, y: Number})

Number[] scale (Number x, Number y)

Number[] scale ([Number, Number])

Number[] scale (Number)

API

Found in "dmz/components/overlay"

API Functions

void / Object {red, green, blue, alpha} color ([Object {red, green, blue, alpha}])

Node lookup (String name)

Node instance (String name)

Bool destroy (*Object {handle} *)

Bool isNode (Node n)

Bool isText (Node n)

Bool isGroup (Node n)

Bool isSwitch (Node n)

Bool isTransform (Node n)