com.io7m.jcamera

Class JCameraSphericalMouseRegion

java.lang.Object

com.io7m.jcamera.JCameraSphericalMouseRegion

All Implemented Interfaces:

JCameraSphericalMouseRegionType

@Generated(value={"Immutables.generator","JCameraSphericalMouseRegionType"})
public final class JCameraSphericalMouseRegion
extends Object
implements JCameraSphericalMouseRegionType

An immutable rectangular region that maps mouse positions to movements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JCameraSphericalMouseRegion.Builder Builds instances of type JCameraSphericalMouseRegion.

Method Summary

Modifier and Type	Method and Description
static JCameraSphericalMouseRegion.Builder	builder() Creates a builder for JCameraSphericalMouseRegion.
double	centerX()
double	centerY()
static JCameraSphericalMouseRegion	copyOf(JCameraSphericalMouseRegionType instance) Creates an immutable copy of a JCameraSphericalMouseRegionType value.
boolean	equals(Object another) This instance is equal to all instances of JCameraSphericalMouseRegion that have equal attribute values.
int	hashCode() Computes a hash code from attributes: origin, width, height, centerX, centerY.
double	height()
static JCameraSphericalMouseRegion	of(JCameraScreenOrigin origin, double width, double height) Construct a new immutable JCameraSphericalMouseRegion instance.
JCameraScreenOrigin	origin()
String	toString() Prints the immutable value JCameraSphericalMouseRegion with attribute values.
double	width()
JCameraSphericalMouseRegion	withHeight(double value) Copy the current immutable object by setting a value for the height attribute.
JCameraSphericalMouseRegion	withOrigin(JCameraScreenOrigin value) Copy the current immutable object by setting a value for the origin attribute.
JCameraSphericalMouseRegion	withWidth(double value) Copy the current immutable object by setting a value for the width attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jcamera.JCameraSphericalMouseRegionType

checkPreconditions, position

Method Detail

origin

public JCameraScreenOrigin origin()

Specified by:

origin in interface JCameraSphericalMouseRegionType

Returns:

The current screen origin

width

public double width()

Specified by:

width in interface JCameraSphericalMouseRegionType

Returns:

The width of the region

height

public double height()

Specified by:

height in interface JCameraSphericalMouseRegionType

Returns:

The height of the region

centerX

public double centerX()

Specified by:

centerX in interface JCameraSphericalMouseRegionType

Returns:

The X coordinate of the center of the region

centerY

public double centerY()

Specified by:

centerY in interface JCameraSphericalMouseRegionType

Returns:

The Y coordinate of the center of the region

withOrigin

public final JCameraSphericalMouseRegion withOrigin(JCameraScreenOrigin value)

Copy the current immutable object by setting a value for the origin attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for origin

Returns:

A modified copy of the this object

withWidth

public final JCameraSphericalMouseRegion withWidth(double value)

Copy the current immutable object by setting a value for the width attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for width

Returns:

A modified copy of the this object

withHeight

public final JCameraSphericalMouseRegion withHeight(double value)

Copy the current immutable object by setting a value for the height attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for height

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of JCameraSphericalMouseRegion that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: origin, width, height, centerX, centerY.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JCameraSphericalMouseRegion with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JCameraSphericalMouseRegion of(JCameraScreenOrigin origin,
                                             double width,
                                             double height)

Construct a new immutable JCameraSphericalMouseRegion instance.

Parameters:

origin - The value for the origin attribute

width - The value for the width attribute

height - The value for the height attribute

Returns:

An immutable JCameraSphericalMouseRegion instance

copyOf

public static JCameraSphericalMouseRegion copyOf(JCameraSphericalMouseRegionType instance)

Creates an immutable copy of a JCameraSphericalMouseRegionType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable JCameraSphericalMouseRegion instance

builder

public static JCameraSphericalMouseRegion.Builder builder()

Creates a builder for JCameraSphericalMouseRegion.

Returns:

A new JCameraSphericalMouseRegion builder