Dragengine.Gui.ZoomCameraMouseListener Class Reference

Zoom camera director. More...

Inheritance diagram for Dragengine.Gui.ZoomCameraMouseListener:

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...

Detailed Description

Zoom camera director.

Version

1.7

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.

Member Function Documentation

getButton()

int Dragengine.Gui.ZoomCameraMouseListener.getButton

(

)

Mouse button to track.

getClampMaximumDistance()

bool Dragengine.Gui.ZoomCameraMouseListener.getClampMaximumDistance

(

)

Clamp maximum distance.

getDirector()

ElementCameraDirector Dragengine.Gui.ZoomCameraMouseListener.getDirector

(

)

Camera director to update.

getMaximumDistance()

float Dragengine.Gui.ZoomCameraMouseListener.getMaximumDistance

(

)

Maximum distance in meters if clamping is enabled.

getMinimumDistance()

float Dragengine.Gui.ZoomCameraMouseListener.getMinimumDistance

(

)

Maximum distance in meters.

getModifiers()

int Dragengine.Gui.ZoomCameraMouseListener.getModifiers

(

)

Modifiers to track.

getSpeed()

float Dragengine.Gui.ZoomCameraMouseListener.getSpeed

(

)

Speed in meters per pixel.

Negative speed zooms in the opposite direction.

new() [1/2]

ZoomCameraMouseListener Dragengine.Gui.ZoomCameraMouseListener.new

(

ElementCameraDirector

director

)

Create mouse listener tracking right mouse button with no modifiers.

Parameters

director

Camera director to update.

new() [2/2]

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

Create mouse listener.

Parameters

director	Camera director to update.
trackButton	Value from InputEventMouseButton or custom.
modifiers	Modifiers from InputEventModifier or custom.

onButtonPress()

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.

onButtonRelease()

void Dragengine.Gui.ZoomCameraMouseListener.onButtonRelease

(

MouseEvent

event

)

Mouse button release.

If tracking stop tracking and release mouse capture.

Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.

onMouseMove()

void Dragengine.Gui.ZoomCameraMouseListener.onMouseMove

(

MouseEvent

event

)

Mouse moved.

Zoom camera if tracking.

Reimplemented from Dragengine.Gui.Events.DefaultMouseListener.

onStartZoom()

void Dragengine.Gui.ZoomCameraMouseListener.onStartZoom ( )

protected

Start zooming camera director.

onStopZoom()

void Dragengine.Gui.ZoomCameraMouseListener.onStopZoom ( )

protected

Stop zooming camera director.

onZoom()

void Dragengine.Gui.ZoomCameraMouseListener.onZoom ( )

protected

Camera director has been zoomd.

setClampMaximumDistance()

void Dragengine.Gui.ZoomCameraMouseListener.setClampMaximumDistance

(

bool

clamp

)

Set to clamp maximum distance.

setMaximumDistance()

void Dragengine.Gui.ZoomCameraMouseListener.setMaximumDistance

(

float

distance

)

Set maximum distance in meters if clamping is enabled.

setMinimumDistance()

void Dragengine.Gui.ZoomCameraMouseListener.setMinimumDistance

(

float

distance

)

Set maximum distance in meters.

setSpeed()

void Dragengine.Gui.ZoomCameraMouseListener.setSpeed

(

float

speed

)

Set speed in meters per pixel.

Negative speed zooms in the opposite direction.

---

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

• ZoomCameraMouseListener.ds