Drag[en]gine Script Module DragonScript
1.23
|
Zoom camera director. More...
Public Member Functions | |
int | getButton () |
Mouse button to track. More... | |
bool | getClampMaximumDistance () |
Clamp maximum distance. More... | |
ElementCameraDirector | getDirector () |
Camera director to update. More... | |
float | getMaximumDistance () |
Maximum distance in meters if clamping is enabled. More... | |
float | getMinimumDistance () |
Maximum distance in meters. More... | |
int | getModifiers () |
Modifiers to track. More... | |
float | getSpeed () |
Speed in meters per pixel. More... | |
ZoomCameraMouseListener | new (ElementCameraDirector director) |
Create mouse listener tracking right mouse button with no modifiers. More... | |
ZoomCameraMouseListener | 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 | setClampMaximumDistance (bool clamp) |
Set to clamp maximum distance. More... | |
void | setMaximumDistance (float distance) |
Set maximum distance in meters if clamping is enabled. More... | |
void | setMinimumDistance (float distance) |
Set maximum distance in meters. More... | |
void | setSpeed (float speed) |
Set 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 | onStartZoom () |
Start zooming camera director. More... | |
void | onStopZoom () |
Stop zooming camera director. More... | |
void | onZoom () |
Camera director has been zoomd. More... | |
Zoom camera director.
Set mouse button and modifiers required to trigger the listener. Once triggered moving up and down is translated to decreasing and increasing the camera distance.
The minimum distance is clamped to 0 while the maximum distance is free. Optionally the minimum distance can be adjusted and the maximum distance can be clamped.
The camera director is not required to have an element assigned.
int Dragengine.Gui.ZoomCameraMouseListener.getButton | ( | ) |
Mouse button to track.
bool Dragengine.Gui.ZoomCameraMouseListener.getClampMaximumDistance | ( | ) |
Clamp maximum distance.
ElementCameraDirector Dragengine.Gui.ZoomCameraMouseListener.getDirector | ( | ) |
Camera director to update.
float Dragengine.Gui.ZoomCameraMouseListener.getMaximumDistance | ( | ) |
Maximum distance in meters if clamping is enabled.
float Dragengine.Gui.ZoomCameraMouseListener.getMinimumDistance | ( | ) |
Maximum distance in meters.
int Dragengine.Gui.ZoomCameraMouseListener.getModifiers | ( | ) |
Modifiers to track.
float Dragengine.Gui.ZoomCameraMouseListener.getSpeed | ( | ) |
Speed in meters per pixel.
Negative speed zooms in the opposite direction.
ZoomCameraMouseListener Dragengine.Gui.ZoomCameraMouseListener.new | ( | ElementCameraDirector | director | ) |
Create mouse listener tracking right mouse button with no modifiers.
director | Camera director to update. |
ZoomCameraMouseListener Dragengine.Gui.ZoomCameraMouseListener.new | ( | ElementCameraDirector | director, |
int | trackButton, | ||
int | modifiers | ||
) |
Create mouse listener.
director | Camera director to update. |
trackButton | Value from InputEventMouseButton or custom. |
modifiers | Modifiers from InputEventModifier or custom. |
void Dragengine.Gui.ZoomCameraMouseListener.onButtonPress | ( | MouseEvent | event | ) |
Mouse button pressed.
Captures mouse and starts tracking if button and modifiers match.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
void Dragengine.Gui.ZoomCameraMouseListener.onButtonRelease | ( | MouseEvent | event | ) |
Mouse button release.
If tracking stop tracking and release mouse capture.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
void Dragengine.Gui.ZoomCameraMouseListener.onMouseMove | ( | MouseEvent | event | ) |
Mouse moved.
Zoom camera if tracking.
Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.
|
protected |
Start zooming camera director.
|
protected |
Stop zooming camera director.
|
protected |
Camera director has been zoomd.
void Dragengine.Gui.ZoomCameraMouseListener.setClampMaximumDistance | ( | bool | clamp | ) |
Set to clamp maximum distance.
void Dragengine.Gui.ZoomCameraMouseListener.setMaximumDistance | ( | float | distance | ) |
Set maximum distance in meters if clamping is enabled.
void Dragengine.Gui.ZoomCameraMouseListener.setMinimumDistance | ( | float | distance | ) |
Set maximum distance in meters.
void Dragengine.Gui.ZoomCameraMouseListener.setSpeed | ( | float | speed | ) |
Set speed in meters per pixel.
Negative speed zooms in the opposite direction.