playn.core

Class Scale

java.lang.Object

playn.core.Scale

public class Scale
extends java.lang.Object

Encapsulates a scale factor, provides useful utility methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scale.ScaledResource Used by getScaledResources(java.lang.String).

Field Summary

Fields

Modifier and Type	Field and Description
float	factor The scale factor for HiDPI mode, or 1 if HDPI mode is not enabled.
static Scale	ONE An unscaled scale factor singleton.

Constructor Summary

Constructors

Constructor and Description
Scale(float factor)

Method Summary

Modifier and Type	Method and Description
java.util.List<Scale.ScaledResource>	getScaledResources(java.lang.String path) Returns an ordered series of scaled resources to try when loading an asset.
float	invScaled(float length) Returns the supplied length inverse scaled by our scale factor.
int	invScaledCeil(float length) Returns the supplied length inverse scaled by our scale factor and rounded up.
int	invScaledFloor(float length) Returns the supplied length inverse scaled by our scale factor and rounded down.
float	scaled(float length) Returns the supplied length scaled by our scale factor.
int	scaledCeil(float length) Returns the supplied length scaled by our scale factor and rounded up.
int	scaledFloor(float length) Returns the supplied length scaled by our scale factor and rounded down.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ONE

public static final Scale ONE

An unscaled scale factor singleton.

factor

public final float factor

The scale factor for HiDPI mode, or 1 if HDPI mode is not enabled.

Constructor Detail

Scale

public Scale(float factor)

Method Detail

scaled

public float scaled(float length)

Returns the supplied length scaled by our scale factor.

scaledCeil

public int scaledCeil(float length)

Returns the supplied length scaled by our scale factor and rounded up.

scaledFloor

public int scaledFloor(float length)

Returns the supplied length scaled by our scale factor and rounded down.

invScaled

public float invScaled(float length)

Returns the supplied length inverse scaled by our scale factor.

invScaledFloor

public int invScaledFloor(float length)

Returns the supplied length inverse scaled by our scale factor and rounded down.

invScaledCeil

public int invScaledCeil(float length)

Returns the supplied length inverse scaled by our scale factor and rounded up.

getScaledResources

public java.util.List<Scale.ScaledResource> getScaledResources(java.lang.String path)

Returns an ordered series of scaled resources to try when loading an asset. The highest (presumably native) resolution will be tried first, then that will be stepped down to all whole integers less than the native resolution. Often this is simply 2, 1, but on a Retina iPad, it could be 4, 3, 2, 1, and on Android devices it may often be something like 3, 2, 1 or 2.5, 2, 1.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object