Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.MousePointerModifier Class Reference

Modifies active desktop mouse pointer. More...

Inheritance diagram for Dragengine.Gui.MousePointerModifier:
Dragengine.Gui.Events.DefaultMousePointerListener Dragengine.Gui.Events.MousePointerListener

Public Member Functions

void dispose ()
 Dispose of mouse pointer modifier. More...
 
ColorMatrix getColorTransform ()
 Color transformation. More...
 
Desktop getDesktop ()
 Desktop or null. More...
 
Canvas getMousePointerCanvas ()
 Mouse pointer instance canvas or null. More...
 
MousePointer getMousePointerInstance ()
 Mouse pointer instance or null. More...
 
TexMatrix2 getTransform ()
 Transformation. More...
 
float getTransparency ()
 Transparency. More...
 
MousePointerModifier new ()
 Create mouse pointer modifier. More...
 
void onMousePointerChanged (MousePointerEvent event)
 Mouse pointer changed. More...
 
void setColorTransform (ColorMatrix transform)
 Set color transformation. More...
 
void setDesktop (Desktop desktop)
 Set desktop or null. More...
 
void setTransform (TexMatrix2 transform)
 Set transformation. More...
 
void setTransparency (float transparency)
 Set transparency. More...
 
void updateMousePointer ()
 Update mouse pointer. More...
 
- Public Member Functions inherited from Dragengine.Gui.Events.DefaultMousePointerListener
void onMousePointerHidden (MousePointerEvent event)
 Mouse pointer has been hidden. More...
 
void onMousePointerMoved (MousePointerEvent event)
 Mouse pointer moved. More...
 
void onMousePointerShown (MousePointerEvent event)
 Mouse pointer has been shown. More...
 

Detailed Description

Modifies active desktop mouse pointer.

Version
1.17

Changes mouse pointer canvas properties like transparency, color transform and transform. Tracks mouse pointer changes to re-apply the changes. Subclass can extend the possible modifications if required.

Mouse pointer modifier can be enabled/disabled by setting/clearing desktop instance.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.MousePointerModifier.dispose ( )

Dispose of mouse pointer modifier.

◆ getColorTransform()

ColorMatrix Dragengine.Gui.MousePointerModifier.getColorTransform ( )

Color transformation.

◆ getDesktop()

Desktop Dragengine.Gui.MousePointerModifier.getDesktop ( )

Desktop or null.

◆ getMousePointerCanvas()

Canvas Dragengine.Gui.MousePointerModifier.getMousePointerCanvas ( )

Mouse pointer instance canvas or null.

◆ getMousePointerInstance()

MousePointer Dragengine.Gui.MousePointerModifier.getMousePointerInstance ( )

Mouse pointer instance or null.

◆ getTransform()

TexMatrix2 Dragengine.Gui.MousePointerModifier.getTransform ( )

Transformation.

◆ getTransparency()

float Dragengine.Gui.MousePointerModifier.getTransparency ( )

Transparency.

◆ new()

MousePointerModifier Dragengine.Gui.MousePointerModifier.new ( )

Create mouse pointer modifier.

Reimplemented from Dragengine.Gui.Events.DefaultMousePointerListener.

◆ onMousePointerChanged()

void Dragengine.Gui.MousePointerModifier.onMousePointerChanged ( MousePointerEvent  event)

Mouse pointer changed.

Updates the active mouse pointer instance with the current modifications.

Reimplemented from Dragengine.Gui.Events.DefaultMousePointerListener.

◆ setColorTransform()

void Dragengine.Gui.MousePointerModifier.setColorTransform ( ColorMatrix  transform)

Set color transformation.

◆ setDesktop()

void Dragengine.Gui.MousePointerModifier.setDesktop ( Desktop  desktop)

Set desktop or null.

◆ setTransform()

void Dragengine.Gui.MousePointerModifier.setTransform ( TexMatrix2  transform)

Set transformation.

◆ setTransparency()

void Dragengine.Gui.MousePointerModifier.setTransparency ( float  transparency)

Set transparency.

◆ updateMousePointer()

void Dragengine.Gui.MousePointerModifier.updateMousePointer ( )

Update mouse pointer.


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