Dragengine.Gui.CanvasView Class Reference
Inheritance diagram for Dragengine.Gui.CanvasView:
Public Member Functions | |
Constructors | |
| CanvasView | new () |
| Create canvas view. More... | |
Management | |
| int | getCanvasCount () |
| Number of child canvas. More... | |
| Canvas | getCanvasAt (int index) |
| Child canvas at index. More... | |
| void | addCanvas (Canvas canvas) |
| Add child canvas. More... | |
| bool | hasCanvas (Canvas canvas) |
| Child canvas is present. More... | |
| void | removeCanvas (Canvas canvas) |
| Remove child canvas. More... | |
| void | removeAllCanvas () |
| Remove all child canvas. More... | |
| bool | equals (Object other) |
| Canvas is equal to another object. More... | |
| int | hashCode () |
| Hash code for use as dictionary keys. More... | |
 Public Member Functions inherited from Dragengine.Gui.Canvas | |
| Point | getPosition () |
| Position in parent canvas view units. More... | |
| void | setPosition (Point position) |
| Set position in parent canvas view units. More... | |
| Point | getSize () |
| Size in parent canvas view units. More... | |
| void | setSize (Point size) |
| Set size in parent canvas view units. More... | |
| TexMatrix2 | getTransform () |
| Transformation matrix affecting the canvas and all its content. More... | |
| void | setTransform (TexMatrix2 transform) |
| Set transformation matrix affecting the canvas and all its content. More... | |
| ColorMatrix | getColorTransform () |
| Color transformation matrix affecting the canvas and all its content. More... | |
| void | setColorTransform (ColorMatrix transform) |
| Set color transformation matrix affecting the canvas and all its content. More... | |
| bool | getVisible () |
| Canvas is visible. More... | |
| void | setVisible (bool visible) |
| Set if canvas is visible. More... | |
| float | getOrder () |
| Render order. Larger renders ontop of smaller. More... | |
| void | setOrder (float order) |
| Set render order. Larger renders ontop of smaller. More... | |
| float | getTransparency () |
| Transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More... | |
| void | setTransparency (float transparency) |
| Set transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More... | |
| CanvasBlendMode | getBlendMode () |
| Blend mode used to blend canvas over previous content. More... | |
| void | setBlendMode (CanvasBlendMode blendMode) |
| Set blend mode used to blend canvas over previous content. More... | |
| Canvas | getMask () |
| Mask canvas or null. More... | |
| void | setMask (Canvas mask) |
| Set mask canvas or null. More... | |
| CanvasView | getParentView () |
| Parent canvas view or null. More... | |
| Canvas | getParentMask () |
| Parent canvas mask or null. More... | |
Additional Inherited Members | |
Constructors |
Detailed Description
Canvas view.
This is a native class.
Member Function Documentation
◆ addCanvas()
| void Dragengine.Gui.CanvasView.addCanvas | ( | Canvas | canvas | ) |
Add child canvas.
◆ equals()
| bool Dragengine.Gui.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.Gui.Canvas.
◆ getCanvasAt()
| Canvas Dragengine.Gui.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.Gui.CanvasView.getCanvasCount | ( | ) |
Number of child canvas.
◆ hasCanvas()
| bool Dragengine.Gui.CanvasView.hasCanvas | ( | Canvas | canvas | ) |
Child canvas is present.
- Version
- 1.11
◆ hashCode()
| int Dragengine.Gui.CanvasView.hashCode | ( | ) |
Hash code for use as dictionary keys.
Implements Object.hashCode().
Reimplemented from Dragengine.Gui.Canvas.
◆ new()
| CanvasView Dragengine.Gui.CanvasView.new | ( | ) |
Create canvas view.
Reimplemented from Dragengine.Gui.Canvas.
◆ removeAllCanvas()
| void Dragengine.Gui.CanvasView.removeAllCanvas | ( | ) |
Remove all child canvas.
◆ removeCanvas()
| void Dragengine.Gui.CanvasView.removeCanvas | ( | Canvas | canvas | ) |
Remove child canvas.
The documentation for this class was generated from the following file:
