TextureAtlas
Extends: EventHandler
A TextureAtlas contains a number of frames from a texture. Each frame defines a region in a texture. The TextureAtlas is referenced by Sprites.
const atlas = new pc.TextureAtlas();
atlas.frames = {
'0': {
// rect has u, v, width and height in pixels
rect: new pc.Vec4(0, 0, 256, 256),
// pivot has x, y values between 0-1 which define the point
// within the frame around which rotation and scale is calculated
pivot: new pc.Vec2(0.5, 0.5),
// border has left, bottom, right and top in pixels defining regions for 9-slicing
border: new pc.Vec4(5, 5, 5, 5)
},
'1': {
rect: new pc.Vec4(256, 0, 256, 256),
pivot: new pc.Vec2(0.5, 0.5),
border: new pc.Vec4(5, 5, 5, 5)
}
};
Summary
Properties
frames | Contains frames which define portions of the texture atlas. |
texture | The texture used by the atlas. |
Methods
destroy | Free up the underlying texture owned by the atlas. |
removeFrame | Removes a frame from the texture atlas. |
setFrame | Set a new frame in the texture atlas. |
Inherited
Methods
fire | Fire an event, all additional arguments are passed on to the event listener. |
hasEvent | Test if there are any handlers bound to an event name. |
off | Detach an event handler from an event. |
on | Attach an event handler to an event. |
once | Attach an event handler to an event. |
Details
Constructor
TextureAtlas()
Create a new TextureAtlas instance.
const atlas = new pc.TextureAtlas();
atlas.frames = {
'0': {
// rect has u, v, width and height in pixels
rect: new pc.Vec4(0, 0, 256, 256),
// pivot has x, y values between 0-1 which define the point
// within the frame around which rotation and scale is calculated
pivot: new pc.Vec2(0.5, 0.5),
// border has left, bottom, right and top in pixels defining regions for 9-slicing
border: new pc.Vec4(5, 5, 5, 5)
},
'1': {
rect: new pc.Vec4(256, 0, 256, 256),
pivot: new pc.Vec2(0.5, 0.5),
border: new pc.Vec4(5, 5, 5, 5)
}
};
Properties
Methods
destroy()
Free up the underlying texture owned by the atlas.
removeFrame(key)
Removes a frame from the texture atlas.
atlas.removeFrame('1');
Parameters
key | string | The key of the frame. |
setFrame(key, data)
Set a new frame in the texture atlas.
atlas.setFrame('1', {
rect: new pc.Vec4(0, 0, 128, 128),
pivot: new pc.Vec2(0.5, 0.5),
border: new pc.Vec4(5, 5, 5, 5)
});
Parameters
key | string | The key of the frame. |
data | object | The properties of the frame. |
data.rect | Vec4 | The u, v, width, height properties of the frame in pixels. |
data.pivot | Vec2 | The pivot of the frame - values are between 0-1. |
data.border | Vec4 | The border of the frame for 9-slicing. Values are ordered as follows: left, bottom, right, top border in pixels. |
Inherited
Methods
fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])
Fire an event, all additional arguments are passed on to the event listener.
obj.fire('test', 'This is the message');
Parameters
name | string | Name of event to fire. |
arg1 | * | First argument that is passed to the event handler. |
arg2 | * | Second argument that is passed to the event handler. |
arg3 | * | Third argument that is passed to the event handler. |
arg4 | * | Fourth argument that is passed to the event handler. |
arg5 | * | Fifth argument that is passed to the event handler. |
arg6 | * | Sixth argument that is passed to the event handler. |
arg7 | * | Seventh argument that is passed to the event handler. |
arg8 | * | Eighth argument that is passed to the event handler. |
Returns
EventHandlerSelf for chaining.
hasEvent(name)
Test if there are any handlers bound to an event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Parameters
name | string | The name of the event to test. |
Returns
booleanTrue if the object has handlers bound to the specified event name.
off([name], [callback], [scope])
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
const handler = function () {
};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Parameters
name | string | Name of the event to unbind. |
callback | HandleEventCallback | Function to be unbound. |
scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf for chaining.
on(name, callback, [scope])
Attach an event handler to an event.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf for chaining.
once(name, callback, [scope])
Attach an event handler to an event. This handler will be removed after being fired once.
obj.once('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf for chaining.