org.achtern.AchternEngine.core.scenegraph.entity.controller

Class MouseLook

java.lang.Object

org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

org.achtern.AchternEngine.core.scenegraph.entity.controller.MouseLook

All Implemented Interfaces:

EngineHolder<CoreEngine>, KeyListener, MouseListener, Entity, Updatable

public class MouseLook
extends QuickEntity
implements KeyListener, MouseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mouselock
protected float	sensitivity
protected Key	unlockKey

Fields inherited from class org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

destroy, engine, name, NAME_UNTITLED_ENTITY, parent

Constructor Summary

Constructors

Constructor and Description
MouseLook(float sensitivity)
MouseLook(float sensitivity, Key unlockKey)

Method Summary

Modifier and Type	Method and Description
void	attached() Called when an Entity gets attached to an scenegraph
protected boolean	canEqual(Object other)
protected void	centerMouse(InputAdapter input)
boolean	equals(Object o)
protected Vector2f	getDeltaMoveFactor(float sensitivity, Vector2f delta) This returns the sensitivity aka delta move factor.
float	getSensitivity()
Key	getUnlockKey()
int	hashCode()
boolean	isMouselock()
void	onAction(KeyEvent event) When the trigger as triggered.
void	onAction(MouseEvent event)
protected void	registerListener()
void	setMouselock(boolean mouselock)
void	setSensitivity(float sensitivity)
void	setUnlockKey(Key unlockKey)
String	toString()

Methods inherited from class org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

boxed, destroy, destroy, getEngine, getName, getParent, getTransform, isDestroy, removed, render, setDestroy, setEngine, setName, setParent, shouldBeDestroyed, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sensitivity

protected float sensitivity

mouselock

protected boolean mouselock

unlockKey

protected Key unlockKey

Constructor Detail

MouseLook

public MouseLook(float sensitivity)

MouseLook

public MouseLook(float sensitivity,
                 Key unlockKey)

Method Detail

attached

public void attached()

Description copied from interface: Entity

Called when an Entity gets attached to an scenegraph

Specified by:

attached in interface Entity

Overrides:

attached in class QuickEntity

See Also:

Entity.attached()

registerListener

protected void registerListener()

onAction

public void onAction(KeyEvent event)

Description copied from interface: KeyListener

When the trigger as triggered.

Specified by:

onAction in interface KeyListener

Parameters:

event - The KeyEvent

onAction

public void onAction(MouseEvent event)

Specified by:

onAction in interface MouseListener

getDeltaMoveFactor

protected Vector2f getDeltaMoveFactor(float sensitivity,
                                      Vector2f delta)

This returns the sensitivity aka delta move factor. This returns the sensitivity based on the delta. This is a logistic function, meaning that it tends to 0 for small values and to 1 for big. I this case it tends to getSensitivity() for high values and if the delta is 0, this function returns 0.25. This allows to move the mouse accurately up to a 1/4 of a pixel! Only the value will be taken, on the returned vector will Vector2f.abs() be called.

Parameters:

sensitivity - sensitivity, supplied by the user

delta - mouse move event delta MouseEvent

Returns:

move factor for X and Y axis

centerMouse

protected void centerMouse(InputAdapter input)

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class QuickEntity

canEqual

@Generated(value="lombok")
protected boolean canEqual(Object other)

Overrides:

canEqual in class QuickEntity

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class QuickEntity

getSensitivity

@Generated(value="lombok")
public float getSensitivity()

isMouselock

@Generated(value="lombok")
public boolean isMouselock()

getUnlockKey

@Generated(value="lombok")
public Key getUnlockKey()

setSensitivity

@Generated(value="lombok")
public void setSensitivity(float sensitivity)

setMouselock

@Generated(value="lombok")
public void setMouselock(boolean mouselock)

setUnlockKey

@Generated(value="lombok")
public void setUnlockKey(Key unlockKey)

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class QuickEntity