com.io7m.jcamera

## Interface JCameraFPSStyleMouseRegionType

- All Known Implementing Classes:
    JCameraFPSStyleMouseRegion

      public interface JCameraFPSStyleMouseRegionType

  An immutable rectangular region that maps mouse positions to movements.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default double` | `centerX()`
    `default double` | `centerY()`
    `default void` | `checkPreconditions()` Check preconditions for the type.
    `default JCameraRotationCoefficients` | `coefficients(double x, double y)` Return the region-space coefficients for the screen-space position `(x, y)`.
    `double` | `height()`
    `JCameraScreenOrigin` | `origin()`
    `double` | `width()`

- - ### Method Detail

    - #### origin

          JCameraScreenOrigin origin()

      Returns:
        The current screen origin

    - #### width

          double width()

      Returns:
        The width of the region

    - #### height

          double height()

      Returns:
        The height of the region

    - #### centerX

          default double centerX()

      Returns:
        The X coordinate of the center of the region

    - #### centerY

          default double centerY()

      Returns:
        The Y coordinate of the center of the region

    - #### coefficients

          default JCameraRotationCoefficients coefficients(double x,
                                                           double y)

      Return the region-space coefficients for the screen-space position `(x, y)`.
      Parameters:
        `x` - The x coordinate
        `y` - The y coordinate
      Returns:
        Rotation coefficients for the given screen-space position

    - #### checkPreconditions

          default void checkPreconditions()

      Check preconditions for the type.

Copyright © 2017 <code@io7m.com> http://io7m.com