TextureAtlasSprite

public class
loom2d.ui.TextureAtlasSprite

Description

Simple Image subclass that uses texture atlases/spritesheets stored in the TextureAtlasManager class.

See also:
loom2d.ui.TextureAtlasManager

API overview

Constructor

TextureAtlasSprite ()

Attributes

Public attributes

atlasName: String

The atlas to use (ie, "Monsters")

textureName: String

The texture to use (ie, "walk_0001")

Protected attributes

Functions

Public functions

Protected functions

Constructor

TextureAtlasSprite ()

Attributes

alpha: Number
Inherited from DisplayObject

The opacity of the object, 0 = transparent, 1 = opaque.

atlasName: String

The atlas to use (ie, "Monsters"). If not set, textureName is treated as a path.

b: Number
Inherited from Quad

Set blue color (0-255); convenience method for tweening.

base: DisplayObject
Inherited from DisplayObject

read-only

The topmost object in the display tree the object is part of.

blendEnabled: Boolean
Inherited from DisplayObject

Enables or disables blending. If set to false, there will be no blending and there may be performance gains.

blendMode: BlendMode
Inherited from DisplayObject
The default value is BlendMode.AUTO

The blend mode determines how the object is blended with the objects underneath.

See also:
loom2d.display.BlendMode

bounds: Rectangle
Inherited from DisplayObject

read-only

The bounds of the object relative to the local coordinates of the parent.

cacheAsBitmap: Boolean
Inherited from DisplayObject

If true, the untransformed contents get cached into a texture at render time. The contents remain static until you turn off caching or use invalidateBitmapCache to update the cache manually.

color: Number
Inherited from Quad

Returns the color of the quad, or of vertex 0 if vertices have different colors.

depth: Number
Inherited from DisplayObject

If depthSort is enabled on parent, this will be used to establish draw order. Higher values are drawn closer. Matching values have undefined order.

g: Number
Inherited from Quad

Set green color (0-255); convenience method for tweening.

hasVisibleArea: Boolean
Inherited from DisplayObject

read-only

Indicates if an object occupies any visible area. (Which is the case when its 'alpha', 'scaleX' and 'scaleY' values are not zero, and its 'visible' property is enabled.)

height: Number
Inherited from DisplayObject

The height of the object in pixels.

ignoreHitTestAlpha: Boolean
Inherited from DisplayObject

This can be used if you wish to have a DisplayObject with zero alpha still respond to hit tests

name: String
Inherited from DisplayObject

The name of the display object (default: null). Used by 'getChildByName()' of display object containers.

parent: DisplayObjectContainer
Inherited from DisplayObject

pivotX: Number
Inherited from DisplayObject

The x coordinate of the object's origin in its own coordinate space (default: 0).

pivotY: Number
Inherited from DisplayObject

The y coordinate of the object's origin in its own coordinate space (default: 0).

premultipliedAlpha: Boolean
Inherited from Quad

read-only

Indicates if the rgb values are stored premultiplied with the alpha value; this can affect the rendering. (Most developers don't have to care, though.)

r: Number
Inherited from Quad

Set red color (0-255); convenience method for tweening.

root: DisplayObject
Inherited from DisplayObject

read-only

The root object the display object is connected to (ie: an instance of the class that was passed to the Starling constructor), or null if the object is not connected to the stage.

rotation: Number
Inherited from DisplayObject

The rotation of the object in radians, (In Loom2D, all angles are measured in radians.)

scale: Number
Inherited from DisplayObject

General scale factor. '1' means no scale, negative values flip the object. Use this when setting scaleX/scaleY explicitly is too verbose.

scaleX: Number
Inherited from DisplayObject

The horizontal scale factor. '1' means no scale, negative values flip the object.

scaleY: Number
Inherited from DisplayObject

The vertical scale factor. '1' means no scale, negative values flip the object.

shader: Shader
Inherited from Quad

native

skewX: Number
Inherited from DisplayObject

The horizontal skew angle in radians.

skewY: Number
Inherited from DisplayObject

The vertical skew angle in radians.

smoothing: Boolean
Inherited from Image

True means linear filtering is applied to textures; false means point filtering is used.

source: String
Inherited from Image

write-only

stage: Stage
Inherited from DisplayObject

read-only

The stage the display object is connected to, or null if it is not connected to the stage.

styleName: String
Inherited from DisplayObject

The style name used by the CSS system.

texture: Texture
Inherited from Image

The texture that is displayed on the quad.

textureName: String

The texture to use (ie, "walk_0001"). If atlasName is not set, textureName is treated as a path.

tinted: Boolean
Inherited from Quad

read-only

Returns true if the quad (or any of its vertices) is non-white or non-opaque.

touchable: Boolean
Inherited from DisplayObject

Indicates if this object (and its children) will receive touch events.

transformationMatrix: Matrix
Inherited from DisplayObject

The transformation matrix of the object relative to its parent.

If you assign a custom transformation matrix, Starling will try to figure out suitable values for x, y, scaleX, scaleY, and rotation. However, if the matrix was created in a different way, this might not be possible. In that case, Starling will apply the matrix, but not update the corresponding properties.

visible: Boolean
Inherited from DisplayObject

The visibility of the object, An invisible object will be untouchable.

width: Number
Inherited from DisplayObject

The width of the object in pixels.

x: Number
Inherited from DisplayObject

The x coordinate of the object relative to the local coordinates of the parent.

y: Number
Inherited from DisplayObject

The y coordinate of the object relative to the local coordinates of the parent.

Protected attributes

Functions

addEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Registers an event listener at a certain object.

Parameters

type: String
listener: Function


center (): Void
Inherited from DisplayObject

Center the DisplayObject's pivot point using the width and height. This centers this object about its own origin based on its width and height.



copyVertexDataTo ( targetData: VertexData , targetVertexID: Number = 0 ): Void
Inherited from Quad

Copies the raw vertex data to a VertexData instance.

Parameters

targetData: VertexData
targetVertexID: Number = 0


dispatchEvent ( event: Event ): Void
Inherited from EventDispatcher

Dispatches an event to all objects that have registered listeners for its type. If an event with enabled 'bubble' property is dispatched to a display object, it will travel up along the line of parents, until it either hits the root object or someone stops its propagation manually.

Parameters

event: Event


dispatchEventWith ( type: String , bubbles: Boolean = false , data: Object = null ): Void
Inherited from EventDispatcher

Dispatches an event with the given parameters to all objects that have registered listeners for the given type. The method uses an internal pool of event objects to avoid allocations.

Parameters

type: String
bubbles: Boolean = false
data: Object = null


dispose (): Void
Inherited from DisplayObject

Disposes all resources of the display object. GPU buffers are released, event listeners are removed, filters are disposed.



getBounds ( targetSpace: DisplayObject , resultRect: Rectangle = null ): Rectangle
Inherited from DisplayObject

Returns a rectangle that completely encloses the object as it appears in another coordinate system. If you pass a 'resultRectangle', the result will be stored in this rectangle instead of creating a new object.

Parameters

targetSpace: DisplayObject
resultRect: Rectangle = null


getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getTargetTransformationMatrix ( targetSpace: DisplayObject , resultMatrix: Matrix ): Void
Inherited from DisplayObject

native

Parameters

targetSpace: DisplayObject
resultMatrix: Matrix


getTexCoords ( vertexID: Number ): Point
Inherited from Image

Gets the texture coordinates of a vertex. Coordinates are in the range [0, 1].

Parameters

vertexID: Number


getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

getVertexAlpha ( vertexID: Number ): Number
Inherited from Quad

Returns the alpha value of a vertex at a certain index.

Parameters

vertexID: Number


getVertexColor ( vertexID: Number ): Number
Inherited from Quad

Returns the color of a vertex at a certain index.

Parameters

vertexID: Number


getVertexPosition ( vertexID: Number ): Point
Inherited from Quad

Gets the position of a vertex at a certain index.

Parameters

vertexID: Number


getVertexTexCoords ( vertexID: Number ): Point
Inherited from Quad

Gets the texture coordinates of a vertex at a certain index.

Parameters

vertexID: Number


globalToLocal ( globalPoint: Point ): Point
Inherited from DisplayObject

Transforms a point from global (stage) coordinates to the local coordinate system.

Parameters

globalPoint: Point


hasEventListener ( type: String ): Boolean
Inherited from EventDispatcher

Returns if there are listeners registered for a certain event type.

Parameters

type: String


hitTest ( localPoint: Point , forTouch: Boolean = false ): DisplayObject
Inherited from DisplayObject

Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. If "forTouch" is true, untouchable and invisible objects will cause the test to fail.

Parameters

localPoint: Point
forTouch: Boolean = false


initializeLMLNode ( id: String ): Void
Inherited from DisplayObject

Handle LML node initialization.

Parameters

id: String


invalidateBitmapCache (): Void
Inherited from DisplayObject

native

Update the cached texture before the next render. This function has no effect if cacheAsBitmap is turned off.



localToGlobal ( localPoint: Point ): Point
Inherited from DisplayObject

Transforms a point from the local coordinate system to global (stage) coordinates.

Parameters

localPoint: Point


preinitializeLMLNode ( id: String ): Void
Inherited from DisplayObject

Pre-initialize the LML node.

Parameters

id: String


readjustSize (): Void
Inherited from Image

Readjusts the dimensions of the image according to its current texture. Call this method to synchronize image and texture size after assigning a texture with a different size.



removeEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Removes an event listener from the object.

Parameters

type: String
listener: Function


removeEventListeners ( type: String = null ): Void
Inherited from EventDispatcher

Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.

Parameters

type: String = null


removeFromParent ( dispose: Boolean = false ): Void
Inherited from DisplayObject

Removes the object from its parent, if it has one.

Parameters

dispose: Boolean = false


setSize ( width: Number , height: Number ): Void
Inherited from Image

Manually set the size of the image to a specified width and height

Parameters

width: Number
height: Number


setTexCoords ( vertexID: Number , coords: Point ): Void
Inherited from Image

Sets the texture coordinates of a vertex. Coordinates are in the range [0, 1].

Parameters

vertexID: Number
coords: Point


setVertexAlpha ( vertexID: Number , alpha: Number ): Void
Inherited from Quad

Sets the alpha value of a vertex at a certain index.

Parameters

vertexID: Number
alpha: Number


setVertexColor ( vertexID: Number , color: Number ): Void
Inherited from Quad

Sets the color of a vertex at a certain index.

Parameters

vertexID: Number
color: Number


setVertexData ( pos: Vector.<Point> , uv: Vector.<Point> , color: Vector.<Number> , alpha: Vector.<Number> ): Void
Inherited from Quad

Fills in all of the vertex data for the quad with an arbitrary set of 4 position, UV, color (RGB), and alpha values. Make sure that data in the Vectors is ordered to correspond to the vertex index order of a Quad (see above).

Parameters

pos: Vector.<Point>
uv: Vector.<Point>
color: Vector.<Number>
alpha: Vector.<Number>


setVertexPosition ( vertexID: Number , posX: Number , posY: Number ): Void
Inherited from Quad

Sets the position of a vertex at a certain index.

Parameters

vertexID: Number
posX: Number
posY: Number


setVertexTexCoords ( vertexID: Number , u: Number , v: Number ): Void
Inherited from Quad

Sets the texture coordinates of a vertex at a certain index.

Parameters

vertexID: Number
u: Number
v: Number


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

Protected functions

: