Dragengine.Scenery.CanvasView Class Reference

Canvas view. More...

Inheritance diagram for Dragengine.Scenery.CanvasView:

Public Member Functions
Constructors
CanvasView	new ()
	Create canvas view.
Management
int	getCanvasCount ()
	Number of child canvas.
Canvas	getCanvasAt (int index)
	Child canvas at index.
void	addCanvas (Canvas canvas)
	Add child canvas.
bool	hasCanvas (Canvas canvas)
	Child canvas is present.
void	removeCanvas (Canvas canvas)
	Remove child canvas.
void	removeAllCanvas ()
	Remove all child canvas.
bool	equals (Object other)
	Canvas is equal to another object.
int	hashCode ()
	Hash code for use as dictionary keys.
Public Member Functions inherited from Dragengine.Scenery.Canvas
Point	getPosition ()
	Position in parent canvas view units.
void	setPosition (Point position)
	Set position in parent canvas view units.
Point	getSize ()
	Size in parent canvas view units.
void	setSize (Point size)
	Set size in parent canvas view units.
TexMatrix2	getTransform ()
	Transformation matrix affecting the canvas and all its content.
void	setTransform (TexMatrix2 transform)
	Set transformation matrix affecting the canvas and all its content.
ColorMatrix	getColorTransform ()
	Color transformation matrix affecting the canvas and all its content.
void	setColorTransform (ColorMatrix transform)
	Set color transformation matrix affecting the canvas and all its content.
bool	getVisible ()
	Canvas is visible.
void	setVisible (bool visible)
	Set if canvas is visible.
float	getOrder ()
	Render order. Larger renders ontop of smaller.
void	setOrder (float order)
	Set render order. Larger renders ontop of smaller.
float	getTransparency ()
	Transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent.
void	setTransparency (float transparency)
	Set transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent.
CanvasBlendMode	getBlendMode ()
	Blend mode used to blend canvas over previous content.
void	setBlendMode (CanvasBlendMode blendMode)
	Set blend mode used to blend canvas over previous content.
Canvas	getMask ()
	Mask canvas or null.
void	setMask (Canvas mask)
	Set mask canvas or null.
CanvasView	getParentView ()
	Parent canvas view or null.
Canvas	getParentMask ()
	Parent canvas mask or null.

Additional Inherited Members

Constructors

Detailed Description

Canvas view.

This is a native class.

Member Function Documentation

addCanvas()

void Dragengine.Scenery.CanvasView.addCanvas

(

Canvas

canvas

)

Add child canvas.

equals()

bool Dragengine.Scenery.CanvasView.equals

(

Object

other

)

Canvas is equal to another object.

Implements Object.equals(Object).

Returns

true if other is of type canvas and components are equal.

Reimplemented from Dragengine.Scenery.Canvas.

getCanvasAt()

Canvas Dragengine.Scenery.CanvasView.getCanvasAt

(

int

index

)

Child canvas at index.

Warning

This method can be expensive since child has to be searched for.

Exceptions

EInvalidParam	index is less than 0.
EInvalidParam	index is larger than or equal to getCanvasCount().

getCanvasCount()

int Dragengine.Scenery.CanvasView.getCanvasCount

(

)

Number of child canvas.

hasCanvas()

bool Dragengine.Scenery.CanvasView.hasCanvas

(

Canvas

canvas

)

Child canvas is present.

Version

1.11

hashCode()

int Dragengine.Scenery.CanvasView.hashCode

(

)

Hash code for use as dictionary keys.

Implements Object.hashCode().

Reimplemented from Dragengine.Scenery.Canvas.

new()

CanvasView Dragengine.Scenery.CanvasView.new

(

)

Create canvas view.

Reimplemented from Dragengine.Scenery.Canvas.

removeAllCanvas()

void Dragengine.Scenery.CanvasView.removeAllCanvas

(

)

Remove all child canvas.

removeCanvas()

void Dragengine.Scenery.CanvasView.removeCanvas

(

Canvas

canvas

)

Remove child canvas.

---

The documentation for this class was generated from the following file:

• CanvasView.ds