Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.CanvasCreators.CombinedCanvasCreator Class Reference

Canvas creator creating a combined canvas. More...

Inheritance diagram for Dragengine.Gui.CanvasCreators.CombinedCanvasCreator:
Dragengine.Gui.CanvasCreators.DefaultCanvasCreator Dragengine.Gui.CanvasCreators.CanvasCreator

Public Member Functions

CanvasCreator copyCanvasCreator ()
 Create copy of canvas creator. More...
 
Canvas createCanvas (Point size)
 Create canvas for a specific widget size. More...
 
CanvasCreator getInnerCanvas ()
 Inner canvas creator or null. More...
 
CanvasCreator getOuterCanvas ()
 Outer canvas creator or null. More...
 
BorderSize getPadding ()
 Padding of inner canvas creator. More...
 
CombinedCanvasCreator new ()
 Create canvas creator. More...
 
CombinedCanvasCreator new (CombinedCanvasCreator creator)
 Create copy of canvas creator. More...
 
void setInnerCanvas (CanvasCreator creator)
 Set inner canvas creator or null. More...
 
void setOuterCanvas (CanvasCreator creator)
 Set outer canvas creator or null. More...
 
void setPadding (BorderSize padding)
 Set padding of inner canvas creator. More...
 
void setParameter (String name, Object value)
 Set parameter. More...
 
- Public Member Functions inherited from Dragengine.Gui.CanvasCreators.DefaultCanvasCreator
DefaultCanvasCreator new (DefaultCanvasCreator creator)
 Create copy of canvas creator. More...
 

Detailed Description

Canvas creator creating a combined canvas.

Version
1.13

Combining canvas creators allows to create complex nested canvas out of existing canvas creators. The combined canvas creator creates a CanvasView canvas with up to two child canvas. An outer and inner canvas creator can be defined. The outer canvas creator can be null. The inner canvas creator size is shrinked by a padding value. Using a null outer canvas creator allows to create padding around an inner canvas creator. If not null the padding allows to nest the inner canvas creator.

Member Function Documentation

◆ copyCanvasCreator()

CanvasCreator Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.copyCanvasCreator ( )

Create copy of canvas creator.

Reimplemented from Dragengine.Gui.CanvasCreators.DefaultCanvasCreator.

◆ createCanvas()

Canvas Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.createCanvas ( Point  size)

Create canvas for a specific widget size.

Reimplemented from Dragengine.Gui.CanvasCreators.DefaultCanvasCreator.

◆ getInnerCanvas()

CanvasCreator Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.getInnerCanvas ( )

Inner canvas creator or null.

◆ getOuterCanvas()

CanvasCreator Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.getOuterCanvas ( )

Outer canvas creator or null.

◆ getPadding()

BorderSize Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.getPadding ( )

Padding of inner canvas creator.

◆ new() [1/2]

CombinedCanvasCreator Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.new ( )

Create canvas creator.

Reimplemented from Dragengine.Gui.CanvasCreators.DefaultCanvasCreator.

◆ new() [2/2]

CombinedCanvasCreator Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.new ( CombinedCanvasCreator  creator)

Create copy of canvas creator.

◆ setInnerCanvas()

void Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.setInnerCanvas ( CanvasCreator  creator)

Set inner canvas creator or null.

◆ setOuterCanvas()

void Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.setOuterCanvas ( CanvasCreator  creator)

Set outer canvas creator or null.

◆ setPadding()

void Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.setPadding ( BorderSize  padding)

Set padding of inner canvas creator.

◆ setParameter()

void Dragengine.Gui.CanvasCreators.CombinedCanvasCreator.setParameter ( String  name,
Object  value 
)

Set parameter.

Supported parameters: | name | value | Setter | | outerCanvas | CanvasCreator | setOuterCanvas | | innerCanvas | CanvasCreator | setInnerCanvas | | padding | BorderSize | setPadding |

Reimplemented from Dragengine.Gui.CanvasCreators.DefaultCanvasCreator.


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