API Reference

Class List

pc.ScrollViewComponent

Extends: pc.Component

A ScrollViewComponent enables a group of entities to behave like a masked scrolling area, with optional horizontal and vertical scroll bars.

Summary

Properties

bounceAmountControls how far the content should move before bouncing back.
contentEntityThe entity which contains the scrolling content itself.
frictionControls how freely the content should move if thrown, i.
horizontalWhether to enable horizontal scrolling.
horizontalScrollbarEntityThe entity to be used as the vertical scrollbar.
horizontalScrollbarVisibilityControls whether the horizontal scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.
scrollModeSpecifies how the scroll view should behave when the user scrolls past the end of the content.
verticalWhether to enable vertical scrolling.
verticalScrollbarEntityThe entity to be used as the vertical scrollbar.
verticalScrollbarVisibilityControls whether the vertical scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.
viewportEntityThe entity to be used as the masked viewport area, within which the content will scroll.

Events

set:scrollFired whenever the scroll position changes.

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

ScrollViewComponent(system, entity)

Create a new ScrollViewComponent.

Parameters

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

Properties

NumberbounceAmount

Controls how far the content should move before bouncing back.

pc.EntitycontentEntity

The entity which contains the scrolling content itself. This entity must have an Element component.

Numberfriction

Controls how freely the content should move if thrown, i.e. by flicking on a phone or by flinging the scroll wheel on a mouse. A value of 1 means that content will stop immediately; 0 means that content will continue moving forever (or until the bounds of the content are reached, depending on the scrollMode).

Booleanhorizontal

Whether to enable horizontal scrolling.

pc.EntityhorizontalScrollbarEntity

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

NumberhorizontalScrollbarVisibility

Controls whether the horizontal scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

NumberscrollMode

Specifies how the scroll view should behave when the user scrolls past the end of the content. Modes are defined as follows:

Booleanvertical

Whether to enable vertical scrolling.

pc.EntityverticalScrollbarEntity

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

NumberverticalScrollbarVisibility

Controls whether the vertical scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

pc.EntityviewportEntity

The entity to be used as the masked viewport area, within which the content will scroll. This entity must have an ElementGroup component.

Events

set:scroll

Fired whenever the scroll position changes.

Parameters

scrollPositionpc.Vec2Horizontal and vertical scroll values in the range 0...1.

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.