SpriteFrame Class

Extends Asset, EventTarget(mixin)

Module: cc

A cc.SpriteFrame has:

  • texture: A cc.Texture2D that will be used by render components
  • rectangle: A rectangle of the texture
Examples
// load a cc.SpriteFrame with image path (Recommend)
var self = this;
var url = "test assets/PurpleMonster";
cc.resources.load(url, cc.SpriteFrame, null, function (err, spriteFrame) {
 var node = new cc.Node("New Sprite");
 var sprite = node.addComponent(cc.Sprite);
 sprite.spriteFrame = spriteFrame;
 node.parent = self.node
});

Index

Properties
  • insetTop Number Top border of the sprite
  • insetBottom Number Bottom border of the sprite
  • insetLeft Number Left border of the sprite
  • insetRight Number Right border of the sprite
  • url String cc.Asset.url is deprecated, please use nativeUrl instead
  • _uuid String
  • loaded Boolean Whether the asset is loaded or not.
  • nativeUrl String Returns the url of this asset's native object, if none it will returns an empty string.
  • refCount Number The number of reference
  • _native String Serializable url for native asset.
  • _nativeAsset Object The underlying native asset of this asset if one is available.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods
  • constructor Constructor of SpriteFrame class.
  • textureLoaded Returns whether the texture have been loaded
  • isRotated Returns whether the sprite frame is rotated in the texture.
  • setRotated Set whether the sprite frame is rotated in the texture.
  • isFlipX Returns whether the sprite frame is flip x axis in the texture.
  • isFlipY Returns whether the sprite frame is flip y axis in the texture.
  • setFlipX Set whether the sprite frame is flip x axis in the texture.
  • setFlipY Set whether the sprite frame is flip y axis in the texture.
  • getRect Returns the rect of the sprite frame in the texture.
  • setRect Sets the rect of the sprite frame in the texture.
  • getOriginalSize Returns the original size of the trimmed image.
  • setOriginalSize Sets the original size of the trimmed image.
  • getTexture Returns the texture of the frame.
  • getOffset Returns the offset of the frame in the texture.
  • setOffset Sets the offset of the frame in the texture.
  • clone Clone the sprite frame.
  • setTexture Set SpriteFrame with Texture, rect, rotated, offset and originalSize.
  • ensureLoadTexture associated by user's custom Components in the scene, will not preload automatically.
  • clearTexture If you do not need to use the SpriteFrame temporarily, you can call this method so that its texture could be garbage collected.
  • toString Returns the asset's url.
  • serialize Provide this method at the request of AssetDB.
  • createNode Create a new node using this asset in the scene....
  • _setRawAsset Set native file name for this asset.
  • addRef Add references of asset
  • decRef Reduce references of asset and it will be auto released when refCount equals 0.
  • hasEventListener Checks whether the EventTarget object has any callback registered for a specific type of event.
  • on Register an callback of a specific event type on the EventTarget.
  • off Removes the listeners previously registered with the same type, callback, target and or useCapture,...
  • targetOff Removes all callbacks previously registered with the same target (passed as parameter).
  • once Register an callback of a specific event type on the EventTarget,...
  • dispatchEvent Send an event with the event object.
  • clear Destroy all callbackInfos.
  • destroy Actual object destruction will delayed until before rendering.
  • _destruct Clear all references in the instance.
  • _onPreDestroy Called before the object being destroyed.
  • _serialize The customized serialization for this object.
  • _deserialize Init this object from the custom serialized data.

Details

Properties

insetTop

Top border of the sprite

meta description
Type Number
Defined in cocos2d/core/assets/CCSpriteFrame.js:87
insetBottom

Bottom border of the sprite

meta description
Type Number
Defined in cocos2d/core/assets/CCSpriteFrame.js:106
insetLeft

Left border of the sprite

meta description
Type Number
Defined in cocos2d/core/assets/CCSpriteFrame.js:125
insetRight

Right border of the sprite

meta description
Type Number
Defined in cocos2d/core/assets/CCSpriteFrame.js:144
url

cc.Asset.url is deprecated, please use nativeUrl instead

meta description
Type String
Defined in cocos2d/core/asset-manager/deprecated.js:714
Deprecated cc.Asset.url is deprecated, please use cc.Asset.nativeUrl instead
_uuid
meta description
Type String
Defined in cocos2d/core/assets/CCAsset.js:57
loaded

Whether the asset is loaded or not.

meta description
Type Boolean
Defined in cocos2d/core/assets/CCAsset.js:66
nativeUrl

Returns the url of this asset's native object, if none it will returns an empty string.

meta description
Type String
Defined in cocos2d/core/assets/CCAsset.js:81
refCount

The number of reference

meta description
Type Number
Defined in cocos2d/core/assets/CCAsset.js:115
_native

Serializable url for native asset.

meta description
Type String
Defined in cocos2d/core/assets/CCAsset.js:131
_nativeAsset

The underlying native asset of this asset if one is available. This property can be used to access additional details or functionality releated to the asset. This property will be initialized by the loader if _native is available.

meta description
Type Object
Defined in cocos2d/core/assets/CCAsset.js:142
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:240
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:258
Examples
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

Methods

constructor

Constructor of SpriteFrame class.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:164
Parameters
  • filename String | Texture2D
  • rect Rect
  • rotated Boolean Whether the frame is rotated in the texture
  • offset Vec2 The offset of the frame in the texture
  • originalSize Size The size of the frame in the texture
textureLoaded

Returns whether the texture have been loaded

meta description
Returns boolean
Defined in cocos2d/core/assets/CCSpriteFrame.js:224
isRotated

Returns whether the sprite frame is rotated in the texture.

meta description
Returns Boolean
Defined in cocos2d/core/assets/CCSpriteFrame.js:247
setRotated

Set whether the sprite frame is rotated in the texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:257
Parameters
isFlipX

Returns whether the sprite frame is flip x axis in the texture.

meta description
Returns Boolean
Defined in cocos2d/core/assets/CCSpriteFrame.js:269
isFlipY

Returns whether the sprite frame is flip y axis in the texture.

meta description
Returns Boolean
Defined in cocos2d/core/assets/CCSpriteFrame.js:279
setFlipX

Set whether the sprite frame is flip x axis in the texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:289
Parameters
setFlipY

Set whether the sprite frame is flip y axis in the texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:302
Parameters
getRect

Returns the rect of the sprite frame in the texture.

meta description
Returns Rect
Defined in cocos2d/core/assets/CCSpriteFrame.js:315
setRect

Sets the rect of the sprite frame in the texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:325
Parameters
getOriginalSize

Returns the original size of the trimmed image.

meta description
Returns Size
Defined in cocos2d/core/assets/CCSpriteFrame.js:337
setOriginalSize

Sets the original size of the trimmed image.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:347
Parameters
getTexture

Returns the texture of the frame.

meta description
Returns Texture2D
Defined in cocos2d/core/assets/CCSpriteFrame.js:362
getOffset

Returns the offset of the frame in the texture.

meta description
Returns Vec2
Defined in cocos2d/core/assets/CCSpriteFrame.js:418
setOffset

Sets the offset of the frame in the texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:428
Parameters
clone

Clone the sprite frame.

meta description
Returns SpriteFrame
Defined in cocos2d/core/assets/CCSpriteFrame.js:438
setTexture

Set SpriteFrame with Texture, rect, rotated, offset and originalSize.

meta description
Returns Boolean
Defined in cocos2d/core/assets/CCSpriteFrame.js:448
Parameters
ensureLoadTexture

If a loading scene (or prefab) is marked as asyncLoadAssets, all the textures of the SpriteFrame which associated by user's custom Components in the scene, will not preload automatically. These textures will be load when Sprite component is going to render the SpriteFrames. You can call this method if you want to load the texture early.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:496
Examples
if (spriteFrame.textureLoaded()) {
    this._onSpriteFrameLoaded();
}
else {
    spriteFrame.once('load', this._onSpriteFrameLoaded, this);
    spriteFrame.ensureLoadTexture();
}
clearTexture

If you do not need to use the SpriteFrame temporarily, you can call this method so that its texture could be garbage collected. Then when you need to render the SpriteFrame, you should call ensureLoadTexture manually to reload texture.

meta description
Defined in cocos2d/core/assets/CCSpriteFrame.js:524
Deprecated since 2.1
toString

Returns the asset's url.

The Asset object overrides the toString() method of the Object object. For Asset objects, the toString() method returns a string representation of the object. JavaScript calls the toString() method automatically when an asset is to be represented as a text value or when a texture is referred to in a string concatenation.

meta description
Returns String
Defined in cocos2d/core/assets/CCAsset.js:212
serialize

Provide this method at the request of AssetDB.

meta description
Returns String
Defined in cocos2d/core/assets/CCAsset.js:232
createNode

Create a new node using this asset in the scene.
If this type of asset dont have its corresponding node type, this method should be null.

meta description
Defined in cocos2d/core/assets/CCAsset.js:246
Parameters
_setRawAsset

Set native file name for this asset.

meta description
Defined in cocos2d/core/assets/CCAsset.js:261
Parameters
addRef

Add references of asset

meta description
Returns Asset
Defined in cocos2d/core/assets/CCAsset.js:283
decRef

Reduce references of asset and it will be auto released when refCount equals 0.

meta description
Returns Asset
Defined in cocos2d/core/assets/CCAsset.js:301
hasEventListener

Checks whether the EventTarget object has any callback registered for a specific type of event.

meta description
Returns Boolean
Defined in cocos2d/core/event/event-target.js:69
Parameters
  • type String The type of event.
on

Register an callback of a specific event type on the EventTarget. This type of event should be triggered via emit.

meta description
Returns Function
Defined in cocos2d/core/event/event-target.js:77
Parameters
  • type String A string representing the event type to listen for.
  • callback Function The callback that will be invoked when the event is dispatched.
                           The callback is ignored if it is a duplicate (the callbacks are unique).
    
    • arg1 Any arg1
    • arg2 Any arg2
    • arg3 Any arg3
    • arg4 Any arg4
    • arg5 Any arg5
  • target Object The target (this object) to invoke the callback, can be null
Examples
eventTarget.on('fire', function () {
    cc.log("fire in the hole");
}, node);
off

Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.

meta description
Defined in cocos2d/core/event/event-target.js:119
Parameters
  • type String A string representing the event type being removed.
  • callback Function The callback to remove.
  • target Object The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
Examples
// register fire eventListener
var callback = eventTarget.on('fire', function () {
    cc.log("fire in the hole");
}, target);
// remove fire event listener
eventTarget.off('fire', callback, target);
// remove all fire event listeners
eventTarget.off('fire');
targetOff

Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

meta description
Defined in cocos2d/core/event/event-target.js:163
Parameters
  • target Object The target to be searched for all related listeners
once

Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.

meta description
Defined in cocos2d/core/event/event-target.js:182
Parameters
  • type String A string representing the event type to listen for.
  • callback Function The callback that will be invoked when the event is dispatched.
                           The callback is ignored if it is a duplicate (the callbacks are unique).
    
    • arg1 Any arg1
    • arg2 Any arg2
    • arg3 Any arg3
    • arg4 Any arg4
    • arg5 Any arg5
  • target Object The target (this object) to invoke the callback, can be null
Examples
eventTarget.once('fire', function () {
    cc.log("this is the callback and will be invoked only once");
}, node);
dispatchEvent

Send an event with the event object.

meta description
Defined in cocos2d/core/event/event-target.js:208
Parameters
clear

Destroy all callbackInfos.

meta description
Defined in cocos2d/core/event/event-target.js:221
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable anymore. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCObject.js:293
Examples
obj.destroy();
_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example:

_destruct: function () {
    for (var key in this) {
        if (this.hasOwnProperty(key)) {
            switch (typeof this[key]) {
                case 'string':
                    this[key] = '';
                    break;
                case 'object':
                case 'function':
                    this[key] = null;
                    break;
        }
    }
}
meta description
Defined in cocos2d/core/platform/CCObject.js:427
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:483
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:511
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:524
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""