Class Guacamole.Display.VisibleLayer

Extends Guacamole.Layer.

Defined in: Display.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Guacamole.Display.VisibleLayer(width, height) Simple container for Guacamole.Layer, allowing layers to be easily repositioned and nested.

Field Summary
Field Attributes	Field Name and Description
	alpha The opacity of the layer container, where 255 is fully opaque and 0 is fully transparent.
	children Set of all children of this layer, indexed by layer index.
	matrix The affine transformation applied to this layer container.
	parent The parent layer container of this layer, if any.
	x X coordinate of the upper-left corner of this layer container within its parent, in pixels.
	y Y coordinate of the upper-left corner of this layer container within its parent, in pixels.
	z Z stacking order of this layer relative to other sibling layers.

Fields borrowed from class Guacamole.Layer:: autosize, height, width

Method Summary
Method Attributes	Method Name and Description
	dispose() Removes this layer container entirely, such that it is no longer contained within its parent layer, if any.
	distort(a, b, c, d, e, f) Applies the given affine transform (defined with six values from the transform's matrix).
	getElement() Returns the element containing the canvas and any other elements associated with this layer.
	move(parent, x, y, z) Moves the upper-left corner of this LayerContainer to the given X and Y coordinate, sets the Z stacking order, and reparents this LayerContainer to the given LayerContainer.
	shade(a) Sets the opacity of this layer to the given value, where 255 is fully opaque and 0 is fully transparent.
	translate(x, y) Moves the upper-left corner of this layer to the given X and Y coordinate.

Methods borrowed from class Guacamole.Layer:: arc, clip, close, copy, curveTo, drawImage, fillColor, fillLayer, getCanvas, lineTo, moveTo, pop, push, put, rect, reset, resize, setChannelMask, setMiterLimit, setTransform, strokeColor, strokeLayer, transfer, transform

Class Detail

Guacamole.Display.VisibleLayer(width, height)

Simple container for Guacamole.Layer, allowing layers to be easily repositioned and nested. This allows certain operations to be accelerated through DOM manipulation, rather than raster operations.

Parameters:
{Number} width: The width of the Layer, in pixels. The canvas element backing this Layer will be given this width.
{Number} height: The height of the Layer, in pixels. The canvas element backing this Layer will be given this height.

Field Detail

alpha

The opacity of the layer container, where 255 is fully opaque and 0 is fully transparent.

children

Set of all children of this layer, indexed by layer index. This object will have one property per child.

{Number[]} matrix

The affine transformation applied to this layer container. Each element corresponds to a value from the transformation matrix, with the first three values being the first row, and the last three values being the second row. There are six values total.

{Guacamole.Display.LayerContainer} parent

The parent layer container of this layer, if any.

{Number} x

X coordinate of the upper-left corner of this layer container within its parent, in pixels.

{Number} y

Y coordinate of the upper-left corner of this layer container within its parent, in pixels.

{Number} z

Z stacking order of this layer relative to other sibling layers.

Method Detail

dispose()

Removes this layer container entirely, such that it is no longer contained within its parent layer, if any.

distort(a, b, c, d, e, f)

Applies the given affine transform (defined with six values from the transform's matrix).

Parameters:
{Number} a: The first value in the affine transform's matrix.
{Number} b: The second value in the affine transform's matrix.
{Number} c: The third value in the affine transform's matrix.
{Number} d: The fourth value in the affine transform's matrix.
{Number} e: The fifth value in the affine transform's matrix.
{Number} f: The sixth value in the affine transform's matrix.

{Element} getElement()

Returns the element containing the canvas and any other elements associated with this layer.

Returns:: {Element} The element containing this layer's canvas.

move(parent, x, y, z)

Moves the upper-left corner of this LayerContainer to the given X and Y coordinate, sets the Z stacking order, and reparents this LayerContainer to the given LayerContainer.

Parameters:
{Guacamole.Display.LayerContainer} parent: The parent to set.
{Number} x: The X coordinate to move to.
{Number} y: The Y coordinate to move to.
{Number} z: The Z coordinate to move to.

shade(a)

Sets the opacity of this layer to the given value, where 255 is fully opaque and 0 is fully transparent.

Parameters:
{Number} a: The opacity to set.

translate(x, y)

Moves the upper-left corner of this layer to the given X and Y coordinate.

Parameters:
{Number} x: The X coordinate to move to.
{Number} y: The Y coordinate to move to.

Classes

Class Guacamole.Display.VisibleLayer