Class Guacamole.Client.LayerContainer

Defined in: Client.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Guacamole.Client.LayerContainer(index, 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.
	height The height of this layer in pixels.
	index Unique integer identifying this layer container.
	matrix The affine transformation applied to this layer container.
	parent The parent layer container of this layer, if any.
	width The width of this layer in pixels.
	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.

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.
	getElement() Returns the element containing the Layer within this LayerContainer.
	getLayer() Returns the Layer contained within this LayerContainer.
	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.
	resize(width, height) Changes the size of this LayerContainer and the contained Layer to the given width and height.
	shade(a) Sets the opacity of this layer to the given value, where 255 is fully opaque and 0 is fully transparent.
	transform(a, b, c, d, e, f) Applies the given affine transform (defined with six values from the transform's matrix).
	translate(x, y) Moves the upper-left corner of this LayerContainer to the given X and Y coordinate.

Class Detail

Guacamole.Client.LayerContainer(index, 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} index: The unique integer which identifies this layer.
{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} height

The height of this layer in pixels.

{Number} index

Unique integer identifying this layer container.

{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.Client.LayerContainer} parent

The parent layer container of this layer, if any.

{Number} width

The width of this layer in pixels.

{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.

{Element} getElement()

Returns the element containing the Layer within this LayerContainer.

Returns:: {Element} The element containing the Layer within this LayerContainer.

{Guacamole.Layer} getLayer()

Returns the Layer contained within this LayerContainer.

Returns:: {Guacamole.Layer} The Layer contained within this LayerContainer.

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.Client.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.

resize(width, height)

Changes the size of this LayerContainer and the contained Layer to the given width and height.

Parameters:
{Number} width: The new width to assign to this Layer.
{Number} height: The new height to assign to this Layer.

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.

transform(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.

translate(x, y)

Moves the upper-left corner of this LayerContainer 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.Client.LayerContainer