JCameraFPSStyleMouseRegionType

All Known Implementing Classes:: JCameraFPSStyleMouseRegion

@Immutable public interface JCameraFPSStyleMouseRegionType

An immutable rectangular region that maps mouse positions to movements.

Method Summary

Modifier and Type

Method

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 Details
- origin
  
  @Parameter(order=0) JCameraScreenOrigin origin()
  
  Returns:
  
  The current screen origin
- width
  
  @Parameter(order=1) double width()
  
  Returns:
  
  The width of the region
- height
  
  @Parameter(order=2) double height()
  
  Returns:
  
  The height of the region
- centerX
  
  @Derived default double centerX()
  
  Returns:
  
  The X coordinate of the center of the region
- centerY
  
  @Derived 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
  
  @Check default void checkPreconditions()
  
  Check preconditions for the type.