Package com.jme3.input.vr

Class AbstractVRMouseManager

java.lang.Object

com.jme3.input.vr.AbstractVRMouseManager

All Implemented Interfaces:

VRMouseManager

Direct Known Subclasses:

LWJGLOpenVRMouseManager, OculusMouseManager, OpenVRMouseManager, OSVRMouseManager

public abstract class AbstractVRMouseManager
extends Object
implements VRMouseManager

An abstract implementation of a VRMouseManager. This class should be overridden by specific hardware implementation of VR devices.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Vector2f	cursorPos

Constructor Summary

Constructors

Constructor	Description
AbstractVRMouseManager(VREnvironment environment)	Create a new AbstractVRMouseManager attached to the given VR environment.

Method Summary

Modifier and Type	Method	Description
void	centerMouse()	Center the mouse on the display.
Vector2f	getCursorPosition()	Get the actual cursor position.
float	getMouseMoveScale()	Get the move scale.
float	getSpeedAcceleration()	Get the acceleration of the mouse.
float	getSpeedSensitivity()	Get the sensitivity of the mouse.
VREnvironment	getVREnvironment()	Get the VR Environment to which this manager is attached.
void	initialize()	Initialize the VR mouse manager.
boolean	isThumbstickMode()	Get if the VR device controller is used within thumb stick mode.
void	setImage(String texture)	Set the image to use as mouse cursor.
void	setMouseMoveScale(float set)	Set the mouse move scale.
void	setSpeed(float sensitivity, float acceleration)	Set the speed of the mouse.
void	setThumbstickMode(boolean set)	Set if the VR device controller is used within thumb stick mode.
void	setVRMouseEnabled(boolean enabled)	Set if the mouse cursor should be used in the VR view.
void	update(float tpf)	Update the mouse manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jme3.input.vr.VRMouseManager

updateAnalogAsMouse

Field Details

cursorPos

protected final Vector2f cursorPos

Constructor Details

AbstractVRMouseManager

public AbstractVRMouseManager(VREnvironment environment)

Create a new AbstractVRMouseManager attached to the given VR environment.

Parameters:

environment - the VR environment that this manager is attached to.

Method Details

initialize

public void initialize()

Description copied from interface: VRMouseManager

Initialize the VR mouse manager.

Specified by:

initialize in interface VRMouseManager

getVREnvironment

public VREnvironment getVREnvironment()

Description copied from interface: VRMouseManager

Get the VR Environment to which this manager is attached.

Specified by:

getVREnvironment in interface VRMouseManager

Returns:

the VR Environment to which this manager is attached.

setVRMouseEnabled

public void setVRMouseEnabled(boolean enabled)

Description copied from interface: VRMouseManager

Set if the mouse cursor should be used in the VR view.

Specified by:

setVRMouseEnabled in interface VRMouseManager

Parameters:

enabled - true if the mouse cursor should be displayed in VR and false otherwise.

setThumbstickMode

public void setThumbstickMode(boolean set)

Description copied from interface: VRMouseManager

Set if the VR device controller is used within thumb stick mode.

Specified by:

setThumbstickMode in interface VRMouseManager

Parameters:

set - true if the VR device controller is used within thumb stick mode and false otherwise.

isThumbstickMode

public boolean isThumbstickMode()

Description copied from interface: VRMouseManager

Get if the VR device controller is used within thumb stick mode.

Specified by:

isThumbstickMode in interface VRMouseManager

Returns:

true if the VR device controller is used within thumb stick mode and false otherwise.

setSpeed

public void setSpeed(float sensitivity,
 float acceleration)

Description copied from interface: VRMouseManager

Set the speed of the mouse.

Specified by:

setSpeed in interface VRMouseManager

Parameters:

sensitivity - the sensitivity of the mouse.

acceleration - the acceleration of the mouse.

See Also:

• VRMouseManager.getSpeedAcceleration()
• VRMouseManager.getSpeedSensitivity()

getSpeedSensitivity

public float getSpeedSensitivity()

Description copied from interface: VRMouseManager

Get the sensitivity of the mouse.

Specified by:

getSpeedSensitivity in interface VRMouseManager

Returns:

the sensitivity of the mouse.

See Also:

• VRMouseManager.setSpeed(float, float)

getSpeedAcceleration

public float getSpeedAcceleration()

Description copied from interface: VRMouseManager

Get the acceleration of the mouse.

Specified by:

getSpeedAcceleration in interface VRMouseManager

Returns:

the acceleration of the mouse.

See Also:

• VRMouseManager.setSpeed(float, float)

getMouseMoveScale

public float getMouseMoveScale()

Description copied from interface: VRMouseManager

Get the move scale. return the move scale.

Specified by:

getMouseMoveScale in interface VRMouseManager

See Also:

• VRMouseManager.setMouseMoveScale(float)

setMouseMoveScale

public void setMouseMoveScale(float set)

Description copied from interface: VRMouseManager

Set the mouse move scale.

Specified by:

setMouseMoveScale in interface VRMouseManager

Parameters:

set - the mouse move scale.

See Also:

• VRMouseManager.getMouseMoveScale()

setImage

public void setImage(String texture)

Description copied from interface: VRMouseManager

Set the image to use as mouse cursor. The given string describe an asset that the underlying application asset manager has to load.

Specified by:

setImage in interface VRMouseManager

Parameters:

texture - the image to use as mouse cursor.

getCursorPosition

public Vector2f getCursorPosition()

Description copied from interface: VRMouseManager

Get the actual cursor position.

Specified by:

getCursorPosition in interface VRMouseManager

Returns:

the actual cursor position.

centerMouse

public void centerMouse()

Description copied from interface: VRMouseManager

Center the mouse on the display.

Specified by:

centerMouse in interface VRMouseManager

update

public void update(float tpf)

Description copied from interface: VRMouseManager

Update the mouse manager. This method should not be called manually. The standard behavior for this method is to be called from the update method of the attached VR view manager.

Specified by:

update in interface VRMouseManager

Parameters:

tpf - the time per frame.