API Reference

Class List

pc.ScreenComponent

Extends: pc.Component

A ScreenComponent enables the Entity to render child pc.ElementComponents using anchors and positions in the ScreenComponent's space.

Summary

Properties

cullIf true then elements inside this screen will be not be rendered when outside of the screen (only valid when screenSpace is true)
referenceResolutionThe resolution that the ScreenComponent is designed for.
resolutionThe width and height of the ScreenComponent.
scaleBlendA value between 0 and 1 that is used when scaleMode is equal to pc.SCALEMODE_BLEND.
scaleModeCan either be pc.SCALEMODE_NONE or pc.SCALEMODE_BLEND.
screenSpaceIf true then the ScreenComponent will render its child pc.ElementComponents in screen space instead of world space.

Methods

syncDrawOrderSet the drawOrder of each child pc.ElementComponent so that ElementComponents which are last in the hierarchy are rendered on top.

Inherited

Properties

enabledEnables or disables the component.
entityThe Entity that this Component is attached to
systemThe ComponentSystem used to create this Component

Methods

fireFire an event, all additional arguments are passed on to the event listener
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.

Details

Constructor

ScreenComponent(system, entity)

Create a new ScreenComponent

Parameters

systempc.ScreenComponentSystemThe ComponentSystem that created this Component
entitypc.EntityThe Entity that this Component is attached to.

Properties

Booleancull

If true then elements inside this screen will be not be rendered when outside of the screen (only valid when screenSpace is true)

pc.Vec2referenceResolution

The resolution that the ScreenComponent is designed for. This is only taken into account when screenSpace is true and scaleMode is pc.SCALEMODE_BLEND. If the actual resolution is different then the ScreenComponent will be scaled according to the scaleBlend value.

pc.Vec2resolution

The width and height of the ScreenComponent. When screenSpace is true the resolution will always be equal to pc.GraphicsDevice#width x pc.GraphicsDevice#height.

NumberscaleBlend

A value between 0 and 1 that is used when scaleMode is equal to pc.SCALEMODE_BLEND. Scales the ScreenComponent with width as a reference (when value is 0), the height as a reference (when value is 1) or anything in between.

StringscaleMode

Can either be pc.SCALEMODE_NONE or pc.SCALEMODE_BLEND. See the description of referenceResolution for more information.

BooleanscreenSpace

If true then the ScreenComponent will render its child pc.ElementComponents in screen space instead of world space. Enable this to create 2D user interfaces.

Methods

syncDrawOrder()

Set the drawOrder of each child pc.ElementComponent so that ElementComponents which are last in the hierarchy are rendered on top. Draw Order sync is queued and will be updated by the next update loop.

Inherited

Properties

Booleanenabled

Enables or disables the component.

pc.Entityentity

The Entity that this Component is attached to

pc.ComponentSystemsystem

The ComponentSystem used to create this Component

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

nameObjectName 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

pc.EventHandler Self 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

nameStringThe name of the event to test

Returns

Boolean true 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.

var 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 hander functions, called 'test' with scope this

Parameters

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope that was used as the this when the event is fired

Returns

pc.EventHandler Self 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.