API Reference

Class List

pc.LayoutChildComponent

Extends: pc.Component

A LayoutChildComponent enables the Entity to control the sizing applied to it by its parent pc.LayoutGroupComponent.

Summary

Properties

excludeFromLayoutIf set to true, the child will be excluded from all layout calculations.
fitHeightProportionThe amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.
fitWidthProportionThe amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.
maxHeightThe maximum height the element should be rendered at.
maxWidthThe maximum width the element should be rendered at.
minHeightThe minimum height the element should be rendered at.
minWidthThe minimum width the element should be rendered at.

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

LayoutChildComponent(system, entity)

Create a new LayoutChildComponent

Parameters

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

Properties

NumberexcludeFromLayout

If set to true, the child will be excluded from all layout calculations.

NumberfitHeightProportion

The amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

NumberfitWidthProportion

The amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

NumbermaxHeight

The maximum height the element should be rendered at.

NumbermaxWidth

The maximum width the element should be rendered at.

NumberminHeight

The minimum height the element should be rendered at.

NumberminWidth

The minimum width the element should be rendered at.

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.