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

Pan camera director. More...

Inheritance diagram for Dragengine.Gui.PanCameraMouseListener:
Dragengine.Gui.Events.DefaultMouseListener Dragengine.Gui.Events.MouseListener

Public Member Functions

int getButton ()
 Mouse button to track. More...
 
ElementCameraDirector getDirector ()
 Camera director to update. More...
 
int getModifiers ()
 Modifiers to track. More...
 
float getSpeed ()
 Movement speed in meters per pixel. More...
 
PanCameraMouseListener new (ElementCameraDirector director)
 Create mouse listener tracking right mouse button with no modifiers. More...
 
PanCameraMouseListener new (ElementCameraDirector director, int trackButton, int modifiers)
 Create mouse listener. More...
 
void onButtonPress (MouseEvent event)
 Mouse button pressed. More...
 
void onButtonRelease (MouseEvent event)
 Mouse button release. More...
 
void onMouseMove (MouseEvent event)
 Mouse moved. More...
 
void setSpeed (float speed)
 Set movement speed in meters per pixel. More...
 
- Public Member Functions inherited from Dragengine.Gui.Events.DefaultMouseListener
DefaultMouseListener new ()
 Create default mouse listener. More...
 
void onMouseEnter (MouseEvent event)
 Mouse has entered widget. More...
 
void onMouseLeave (MouseEvent event)
 Mouse has left widget. More...
 
void onMouseWheel (MouseEvent event)
 Mouse wheel moved. More...
 

Protected Member Functions

void onPan ()
 Camera director has been rotated. More...
 
void onStartPan ()
 Start rotating camera director. More...
 
void onStopPan ()
 Stop rotating camera director. More...
 

Detailed Description

Pan camera director.

Version
1.7

Set mouse button and modifiers required to trigger the listener. Once triggered moving is translated to displacement of camera position relative to current camera matrix.

This listener actually moves the pivot of the camera director.

The camera director is not required to have an element assigned.

Member Function Documentation

◆ getButton()

int Dragengine.Gui.PanCameraMouseListener.getButton ( )

Mouse button to track.

◆ getDirector()

ElementCameraDirector Dragengine.Gui.PanCameraMouseListener.getDirector ( )

Camera director to update.

◆ getModifiers()

int Dragengine.Gui.PanCameraMouseListener.getModifiers ( )

Modifiers to track.

◆ getSpeed()

float Dragengine.Gui.PanCameraMouseListener.getSpeed ( )

Movement speed in meters per pixel.

Negative speed moves in the opposite direction.

◆ new() [1/2]

PanCameraMouseListener Dragengine.Gui.PanCameraMouseListener.new ( ElementCameraDirector  director)

Create mouse listener tracking right mouse button with no modifiers.

Parameters
directorCamera director to update.

◆ new() [2/2]

PanCameraMouseListener Dragengine.Gui.PanCameraMouseListener.new ( ElementCameraDirector  director,
int  trackButton,
int  modifiers 
)

Create mouse listener.

Parameters
directorCamera director to update.
trackButtonValue from InputEventMouseButton or custom.
modifiersModifiers from InputEventModifier or custom.

◆ onButtonPress()

void Dragengine.Gui.PanCameraMouseListener.onButtonPress ( MouseEvent  event)

Mouse button pressed.

Captures mouse and starts tracking if button and modifiers match.

Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.

◆ onButtonRelease()

void Dragengine.Gui.PanCameraMouseListener.onButtonRelease ( MouseEvent  event)

Mouse button release.

If tracking stop tracking and release mouse capture.

Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.

◆ onMouseMove()

void Dragengine.Gui.PanCameraMouseListener.onMouseMove ( MouseEvent  event)

Mouse moved.

Rotate camera if tracking.

Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.

◆ onPan()

void Dragengine.Gui.PanCameraMouseListener.onPan ( )
protected

Camera director has been rotated.

◆ onStartPan()

void Dragengine.Gui.PanCameraMouseListener.onStartPan ( )
protected

Start rotating camera director.

◆ onStopPan()

void Dragengine.Gui.PanCameraMouseListener.onStopPan ( )
protected

Stop rotating camera director.

◆ setSpeed()

void Dragengine.Gui.PanCameraMouseListener.setSpeed ( float  speed)

Set movement speed in meters per pixel.

Negative speed moves in the opposite direction.


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