Frame

Instance Constructors

new Frame(index: Int, x: Double, y: Double, width: Double, height: Double, name: String)

index
The index of this Frame within the FrameData set it is being added to.
x
X position of the frame within the texture image.
y
Y position of the frame within the texture image.
width
Width of the frame within the texture image.
height
Height of the frame within the texture image.
name
The name of the frame. In Texture Atlas data this is usually set to the filename.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
var bottom: Double

The bottom of the frame (y + height).
var centerX: Double

Center X position within the image to cut from.
var centerY: Double

Center Y position within the image to cut from.
def clone(): Frame.this.type

Clones this Frame into a new Phaser.Frame object and returns it.
Clones this Frame into a new Phaser.Frame object and returns it. Note that all properties are cloned, including the name, index and UUID.
returns
An exact copy of this Frame object.

Definition Classes
Frame → AnyRef
var distance: Double

The distance from the top left to the bottom-right of this Frame.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getRect(out: Phaser.Rectangle = js.native): Phaser.Rectangle

Returns a Rectangle set to the dimensions of this Frame.
Returns a Rectangle set to the dimensions of this Frame.
out
A rectangle to copy the frame dimensions to.
returns
A rectangle.
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var height: Double

Height of the frame within the texture image.
var index: Int

The index of this Frame within the FrameData set it is being added to.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var name: String

The name of the frame.
The name of the frame. In Texture Atlas data this is usually set to the filename.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def resize(width: Double, height: Double): Unit

Adjusts of all the Frame properties based on the given width and height values.
Adjusts of all the Frame properties based on the given width and height values.
width
The new width of the Frame.
height
The new height of the Frame.
var right: Double

The right of the Frame (x + width).
var rotated: Boolean

Rotated? (not yet implemented)
var rotationDirection: String

Either 'cw' or 'ccw', rotation is always 90 degrees.
def setTrim(trimmed: Boolean, actualWidth: Double, actualHeight: Double, destX: Double, destY: Double, destWidth: Double, destHeight: Double): Unit

If the frame was trimmed when added to the Texture Atlas this records the trim and source data.
If the frame was trimmed when added to the Texture Atlas this records the trim and source data.
trimmed
If this frame was trimmed or not.
actualWidth
The width of the frame before being trimmed.
actualHeight
The height of the frame before being trimmed.
destX
The destination X position of the trimmed frame for display.
destY
The destination Y position of the trimmed frame for display.
destWidth
The destination width of the trimmed frame for display.
destHeight
The destination height of the trimmed frame for display.
var sourceSizeH: Double

Height of the original sprite before it was trimmed.
var sourceSizeW: Double

Width of the original sprite before it was trimmed.
var spriteSourceSizeH: Double

Height of the trimmed sprite.
var spriteSourceSizeW: Double

Width of the trimmed sprite.
var spriteSourceSizeX: Double

X position of the trimmed sprite inside original sprite.
var spriteSourceSizeY: Double

Y position of the trimmed sprite inside original sprite.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
var trimmed: Boolean

Was it trimmed when packed?
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
var width: Double

Width of the frame within the texture image.
var x: Double

X position of the frame within the texture image.
var y: Double

Y position of the frame within the texture image.

Related Doc: package phaser

class Frame extends Object

Instance Constructors

new Frame(index: Int, x: Double, y: Double, width: Double, height: Double, name: String)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

var bottom: Double

var centerX: Double

var centerY: Double

def clone(): Frame.this.type

var distance: Double

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getRect(out: Phaser.Rectangle = js.native): Phaser.Rectangle

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var height: Double

var index: Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

var name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

def resize(width: Double, height: Double): Unit

var right: Double

var rotated: Boolean

var rotationDirection: String

def setTrim(trimmed: Boolean, actualWidth: Double, actualHeight: Double, destX: Double, destY: Double, destWidth: Double, destHeight: Double): Unit

var sourceSizeH: Double

var sourceSizeW: Double

var spriteSourceSizeH: Double

var spriteSourceSizeW: Double

var spriteSourceSizeX: Double

var spriteSourceSizeY: Double

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

var trimmed: Boolean

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

var width: Double

var x: Double

var y: Double

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped