org.mini2Dx.core.graphics.viewport

Class Viewport

java.lang.Object

org.mini2Dx.core.graphics.viewport.Viewport

Direct Known Subclasses:

ExtendViewport, ScalingViewport, ScreenViewport

public abstract class Viewport
extends java.lang.Object

Base class for implementing Viewport strategies.

Constructor Summary

Constructors

Constructor and Description
Viewport()

Method Summary

Modifier and Type	Method and Description
void	apply(Graphics g) Configures the Graphics context for the viewport.
int	getHeight()
float	getInvScaleX()
float	getInvScaleY()
float	getScaleX()
float	getScaleY()
int	getWidth()
int	getX()
int	getY()
protected abstract void	onResize(int windowWidth, int windowHeight)
protected void	setBounds(int x, int y, int width, int height, float scaleX, float scaleY)
void	toScreenCoordinates(org.mini2Dx.gdx.math.Vector2 worldCoordinates) Converts a game world coordinate to a pixel coordinate on screen
void	toScreenCoordinates(org.mini2Dx.gdx.math.Vector2 result, float worldX, float worldY) Converts the game world's coordinate to a pixel coordinate on screen
void	toWorldCoordinates(org.mini2Dx.gdx.math.Vector2 screenCoordinates) Converts a pixel coordinate to a game world coordinate
void	toWorldCoordinates(org.mini2Dx.gdx.math.Vector2 result, float screenX, float screenY) Converts a pixel coordinate to a game world coordinate
void	unapply(Graphics g) Restores the Graphics to its state before apply(Graphics) was invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

Viewport

public Viewport()

Method Detail

onResize

protected abstract void onResize(int windowWidth,
                                 int windowHeight)

apply

public void apply(Graphics g)

Configures the Graphics context for the viewport. Note: This will manipulate the scale, clip and translation of the Graphics context.

Parameters:

g - The Graphics instance to configure

unapply

public void unapply(Graphics g)

Restores the Graphics to its state before apply(Graphics) was invoked.

Parameters:

g - The Graphics instance

toScreenCoordinates

public void toScreenCoordinates(org.mini2Dx.gdx.math.Vector2 result,
                                float worldX,
                                float worldY)

Converts the game world's coordinate to a pixel coordinate on screen

Parameters:

result - The Vector2 to store the result in

worldX - The world x coordinate

worldY - The world y coordinate

toWorldCoordinates

public void toWorldCoordinates(org.mini2Dx.gdx.math.Vector2 result,
                               float screenX,
                               float screenY)

Converts a pixel coordinate to a game world coordinate

Parameters:

result - The Vector2 to store the result in

screenX - The pixel x coodinate

screenY - The pixel y coordinate

toScreenCoordinates

public void toScreenCoordinates(org.mini2Dx.gdx.math.Vector2 worldCoordinates)

Converts a game world coordinate to a pixel coordinate on screen

Parameters:

worldCoordinates - The Vector2 to convert. The result is stored in this Vector2.

toWorldCoordinates

public void toWorldCoordinates(org.mini2Dx.gdx.math.Vector2 screenCoordinates)

Converts a pixel coordinate to a game world coordinate

Parameters:

screenCoordinates - The Vector2 to convert. The result is stored in this Vector2.

setBounds

protected void setBounds(int x,
                         int y,
                         int width,
                         int height,
                         float scaleX,
                         float scaleY)

getX

public int getX()

getY

public int getY()

getWidth

public int getWidth()

getHeight

public int getHeight()

getScaleX

public float getScaleX()

getInvScaleX

public float getInvScaleX()

getScaleY

public float getScaleY()

getInvScaleY

public float getInvScaleY()