Cocos2D JavaScript (v0.1) API Documentation

Class: TextureAtlas

Module
cocos
Defined In
libs/cocos2d/TextureAtlas.js
Extends
BObject
A single texture that can represent lots of smaller images

Public Properties

Property Defined By
Expand id id : Integer <read-only>
Unique ID for this object
BObject

Public Methods

Method Defined By
Expand TextureAtlas new TextureAtlas ({file:String,[data:Texture2D/HTMLImageElement],[canvas:CanvasElement]}) : cocos.TextureAtlas <constructor>
A single texture that can represent lots of smaller images

Named Arguments

  • file : String
    The file path of the image to use as a texture
  • data : Texture2D/HTMLImageElement (Optional)
    Image data to read from
  • canvas : CanvasElement (Optional)
    A canvas to use as a texture

Returns

TextureAtlas
Expand bindTo bindTo (key:String,target:BOject,[targetKey:String],[noNotify:Boolean]) : void
Bind the value of a property on this object to that of another object so they always have the same value. Setting the value on either object will update the other too.

Arguments

  1. key : String
    Name of the property on this object that should be bound
  2. target : BOject
    Object to bind to
  3. targetKey : String (Optional)
    Key on the target object to bind to
  4. noNotify : Boolean (Optional)
    Set to true to prevent this object's property triggering a 'changed' event when adding the binding

Returns

  • void
BObject
Expand changed changed (key:*) : void

Arguments

  1. key :

Returns

  • void
BObject
Expand drawQuad drawQuad (ctx:*,quad:*) : void

Arguments

  1. ctx :
  2. quad :

Returns

  • void
TextureAtlas
Expand drawQuads drawQuads (ctx:*) : void

Arguments

  1. ctx :

Returns

  • void
TextureAtlas
Expand get get (key:String) : *
Get a property from the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get

Returns

  • *
    Value of the property
BObject
Expand insertQuad insertQuad (opts:*) : void

Arguments

  1. opts :

Returns

  • void
TextureAtlas
Expand removeQuad removeQuad (opts:*) : void

Arguments

  1. opts :

Returns

  • void
TextureAtlas
Expand set set (key:String,value:*) : void
Set a property on the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get
  2. value : *
    New value for the property

Returns

  • void
BObject
Expand setValues setValues (kvp:Object) : void
Set multiple propertys in one go

Arguments

  1. kvp : Object
    An Object where the key is a property name and the value is the value to assign to the property

Returns

  • void
BObject
Expand unbind unbind (key:String) : void
Remove binding from a property which set setup using BObject#bindTo.

Arguments

  1. key : String
    Name of the property on this object to unbind

Returns

  • void
BObject
Expand unbindAll unbindAll () : void
Remove all bindings on this object

Returns

  • void
BObject

Private Members

This class has no private members.