com.io7m.jcamera

Class JCameraFPSStyleMouseRegion

java.lang.Object

com.io7m.jcamera.JCameraFPSStyleMouseRegion

@EqualityReference
public final class JCameraFPSStyleMouseRegion
extends Object

An immutable rectangular region that maps mouse positions to rotational coefficients.

Method Summary

Modifier and Type	Method and Description
float	getCenterX()
float	getCenterY()
void	getCoefficients(float x, float y, JCameraRotationCoefficients out) Return the region-space coefficients for the screen-space position (x, y).
float	getHeight()
JCameraScreenOrigin	getOrigin()
float	getWidth()
static JCameraFPSStyleMouseRegion	newRegion(JCameraScreenOrigin in_origin, float in_width, float in_height) Construct a new mouse region.

Methods inherited from class java.lang.Object

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

Method Detail

newRegion

public static JCameraFPSStyleMouseRegion newRegion(JCameraScreenOrigin in_origin,
                                                   float in_width,
                                                   float in_height)

Construct a new mouse region.

Parameters:

in_origin - The screen origin.

in_width - The region width.

in_height - The region height.

Returns:

A new mouse region.

getCenterX

public float getCenterX()

Returns:

The X coordinate of the center of the region

getCenterY

public float getCenterY()

Returns:

The Y coordinate of the center of the region

getCoefficients

public void getCoefficients(float x,
                            float y,
                            JCameraRotationCoefficients out)

Return the region-space coefficients for the screen-space position (x, y).

Parameters:

x - The x coordinate

y - The y coordinate

out - The output vector

getHeight

public float getHeight()

Returns:

The height of the region

getOrigin

public JCameraScreenOrigin getOrigin()

Returns:

The current screen origin

getWidth

public float getWidth()

Returns:

The width of the region