Class: Container

Tiny. Container

A Container represents a collection of display objects.
It is the base class of all display objects that act as a container for other objects.

let container = new Tiny.Container();
container.addChild(sprite);

new Tiny.Container()

tiny/core/display/Container.js, line 20

Extends

Tiny.DisplayObject

Members

actionsarray.<Tiny.Action>

该对象上绑定的所有 Action

alphanumber

The opacity of the object.

buttonModeboolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive
Setting this changes the 'cursor' property to 'pointer'.

Example

const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

readonlychildrenarray.<Tiny.DisplayObject>

The array of children of this container.

cursorstring

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See:

https://developer.mozilla.org/en/docs/Web/CSS/cursor

Example

const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

filterAreaTiny.Rectangle

The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filtersarray.<Tiny.Filter>

Sets the filters for the displayObject.

IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'

heightnumber

The height of the Container, setting this will actually modify the scale to achieve the value set

hitAreaTiny.Rectangle Tiny.Circle Tiny.Ellipse Tiny.Polygon Tiny.RoundedRectangle

Interaction shape. Children will be hit first, then this shape will be checked.
Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example

const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new Tiny.Rectangle(0, 0, 100, 100);

interactiveboolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example

const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

interactiveChildrenboolean

Determines if the children to the displayObject can be clicked/touched
Setting this to false allows Tiny to bypass a recursive hitTest function

readonlylocalTransformTiny.Matrix

Current transform of the object based on local factors: position, scale, other stuff

maskTiny.Graphics Tiny.Sprite

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In Tiny a regular mask must be a Tiny.Graphics or a Tiny.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

namestring

The instance name of the object.

readonlyparentTiny.Container

The display object container that contains this display object.

pivotTiny.Point Tiny.ObservablePoint

The pivot point of the displayObject that it rotates around

positionTiny.Point Tiny.ObservablePoint

The coordinate of the object relative to the local coordinates of the parent.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotationnumber

The rotation of the object in radians.

scaleTiny.Point Tiny.ObservablePoint

The scale factor of the object.

skewTiny.ObservablePoint

The skew factor for the object in radians.

transformTiny.TransformBase

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

visibleboolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

widthnumber

The width of the Container, setting this will actually modify the scale to achieve the value set

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformTiny.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the object is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Methods

addChild(child) ❯ {Tiny.DisplayObject} tiny/core/display/Container.js, line 109

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Name	Type	Description
`child`	Tiny.DisplayObject	repeatable The DisplayObject(s) to add to the container

Returns:

Type	Description
Tiny.DisplayObject	The first child that was added.

addChildAt(child, index) ❯ {Tiny.DisplayObject} tiny/core/display/Container.js, line 150

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name	Type	Description
`child`	Tiny.DisplayObject	The child to add
`index`	number	The index to place the child in

Returns:

Type	Description
Tiny.DisplayObject	The child that was added.

calculateBounds() tiny/core/display/Container.js, line 366

Recalculates the bounds of the container.

destroy(options) tiny/core/display/Container.js, line 559

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.

Name Type Description

options

object | boolean

optional

Options parameter. A boolean will act as if all options have been set to that value

Name	Type	Default	Description
`children`	boolean	false	optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
`texture`	boolean	false	optional Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
`baseTexture`	boolean	false	optional Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

inherited getBounds(skipUpdate, rect) ❯ {Tiny.Rectangle} tiny/core/display/DisplayObject.js, line 197

Retrieves the bounds of the displayObject as a rectangle object.

Name	Type	Description
`skipUpdate`	boolean	setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you nice performance boost
`rect`	Tiny.Rectangle	Optional rectangle to store the result of the bounds calculation

Returns:

Type	Description
Tiny.Rectangle	the rectangular bounding area

getChildAt(index) ❯ {Tiny.DisplayObject} tiny/core/display/Container.js, line 234

Returns the child at the specified index

Name	Type	Description
`index`	number	The index to get the child at

Returns:

Type	Description
Tiny.DisplayObject	The child at the given index, if any.

inherited getChildByName(name) ❯ {Tiny.DisplayObject} tiny/core/display/DisplayObject.js, line 350

Returns the display object in the container

Name	Type	Description
`name`	string	instance name

Returns:

Type	Description
Tiny.DisplayObject	The child with the specified name.

getChildIndex(child) ❯ {number} tiny/core/display/Container.js, line 200

Returns the index position of a child DisplayObject instance

Name	Type	Description
`child`	Tiny.DisplayObject	The DisplayObject instance to identify

Returns:

Type	Description
number	The index position of the child display object to identify

inherited getGlobalPosition(point, skipUpdate) ❯ {Tiny.Point} tiny/core/display/DisplayObject.js, line 334

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name	Type	Default	Description
`point`	Tiny.Point		the point to write the global value to. If null a new point will be returned
`skipUpdate`	boolean	false	setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost

Returns:

Type	Description
Tiny.Point	The updated point

getLocalBounds(rect, skipChildrenUpdate) ❯ {Tiny.Rectangle} tiny/core/display/Container.js, line 401

Retrieves the local bounds of the displayObject as a rectangle object.

Name	Type	Default	Description
`rect`	Tiny.Rectangle		optional Optional rectangle to store the result of the bounds calculation.
`skipChildrenUpdate`	boolean	false	optional Setting to `true` will stop re-calculation of children transforms.

Returns:

Type	Description
Tiny.Rectangle	The rectangular bounding area.

inherited getNature() ❯ {object} tiny/core/display/DisplayObject.js, line 586

获取对象的属性：x, y, angle, rotation, visible, alpha, scaleX, scaleY, skewX, skewY, colorR, colorG, colorB

Returns:

Type	Description
object

inherited getOpacity() ❯ {number} tiny/core/display/DisplayObject.js, line 525

Returns:

Type	Description
number

inherited getPivot() ❯ {number} tiny/core/display/DisplayObject.js, line 493

Returns:

Type	Description
number

inherited getPosition() ❯ {object} tiny/core/display/DisplayObject.js, line 444

Returns:

Type	Description
object

inherited getPositionX() ❯ {number} tiny/core/display/DisplayObject.js, line 460

Returns:

Type	Description
number

inherited getPositionY() ❯ {number} tiny/core/display/DisplayObject.js, line 476

Returns:

Type	Description
number

inherited getRotation() ❯ {number} tiny/core/display/DisplayObject.js, line 509

Returns:

Type	Description
number

inherited getScale() ❯ {object} tiny/core/display/DisplayObject.js, line 558

Returns:

Type	Description
object

inherited getSkew() ❯ {object} tiny/core/display/DisplayObject.js, line 577

Version:

1.1.0

Returns:

Type	Description
object

inherited getVisible() ❯ {boolean} tiny/core/display/DisplayObject.js, line 541

Returns:

Type	Description
boolean

removeAction(actions) tiny/core/display/Container.js, line 56

移除该对象上绑定的某个（些） Action

Name	Type	Description
`actions`	Tiny.Action	repeatable 要移除的某个（些）动作

Version:

1.6.0

Example

sprite.removeAction(action1, action2);

removeActions() tiny/core/display/Container.js, line 71

移除该对象上绑定的所有 Action

removeActionsTrace() tiny/core/display/Container.js, line 83

移除该对象及其子集上绑定的所有 Action

removeChild(child) ❯ {Tiny.DisplayObject} tiny/core/display/Container.js, line 248

Removes one or more children from the container.

Name	Type	Description
`child`	Tiny.DisplayObject	repeatable The DisplayObject(s) to remove

Returns:

Type	Description
Tiny.DisplayObject	The first child that was removed.

removeChildAt(index) ❯ {Tiny.DisplayObject} tiny/core/display/Container.js, line 285

Removes a child from the specified index position.

Name	Type	Description
`index`	number	The index to get the child from

Returns:

Type	Description
Tiny.DisplayObject	The child that was removed.

removeChildren(beginIndex, endIndex) ❯ {Array.<DisplayObject>} tiny/core/display/Container.js, line 310

Removes all children from this container that are within the begin and end indexes.

Name	Type	Default	Description
`beginIndex`	number	0	optional The beginning position.
`endIndex`	number	this.children.length	optional The ending position. Default value is size of the container.

Returns:

Type	Description
Array.<DisplayObject>	List of removed children

renderCanvas(renderer) tiny/core/display/Container.js, line 530

Renders the object using the Canvas renderer

Name	Type	Description
`renderer`	Tiny.CanvasRenderer	The renderer

renderWebGL(renderer) tiny/core/display/Container.js, line 432

Renders the object using the WebGL renderer

Name	Type	Description
`renderer`	Tiny.WebGLRenderer	The renderer

runAction(actions) tiny/actions/Action.js, line 535

让 action 们动起来吧

Tips: 多组action同时：runAction([action1, action2], action3)

Name	Type	Description
`actions`	array.<Tiny.Action> \| Tiny.Action	action 数组或参数序列

Example

var action = Tiny.MoveBy(1000, Tiny.point(100, 100));
container.runAction(Tiny.RepeatForever(action));
// container 会在舞台的(0, 0)位置和(100, 100)位置来回不停的移动

runSequenceAction(actions) tiny/actions/Action.js, line 558

有顺序的让 action 们动起来吧

Tips: runSequenceAction(action1, action2)

Name	Type	Description
`actions`	array.<Tiny.Action> \| Tiny.Action	action 数组或参数序列

Example

var action1 = Tiny.MoveTo(1000, Tiny.point(100, 100));
var action2 = Tiny.ScaleBy(1200, Tiny.scale(0.25, 2));
var action3 = Tiny.RotateTo(2000, {rotation: Tiny.PI_2});
container.runSequenceAction(action1, action2, action3);
//container 先在1000ms内从坐标(0, 0)移动到(100, 100)，然后在1200ms内横向缩小0.25倍，纵向拉伸2倍，最后在2000ms内顺时针旋转360度

setChildIndex(child, index) tiny/core/display/Container.js, line 216

Changes the position of an existing child in the display object container

Name	Type	Description
`child`	Tiny.DisplayObject	The child DisplayObject instance for which you want to change the index number
`index`	number	The resulting index number for the child display object

inherited setEventEnabled(b) tiny/core/display/DisplayObject.js, line 427

设置是否可交互

Name	Type	Description
`b`	boolean

inherited setOpacity(alpha) tiny/core/display/DisplayObject.js, line 517

Name	Type	Description
`alpha`	number

inherited setParent(container) ❯ {Tiny.Container} tiny/core/display/DisplayObject.js, line 384

Set the parent Container of this DisplayObject

Name	Type	Description
`container`	Tiny.Container	The Container to add this DisplayObject to

Returns:

Type	Description
Tiny.Container	The Container that this DisplayObject was added to

inherited setPivot(x, y) tiny/core/display/DisplayObject.js, line 485

Name	Type	Description
`x`	number
`y`	number

inherited setPosition(x, y) tiny/core/display/DisplayObject.js, line 436

Name	Type	Description
`x`	number
`y`	number

inherited setPositionX(x) tiny/core/display/DisplayObject.js, line 452

Name	Type	Description
`x`	number

inherited setPositionY(y) tiny/core/display/DisplayObject.js, line 468

Name	Type	Description
`y`	number

inherited setRotation(rotation) tiny/core/display/DisplayObject.js, line 501

Name	Type	Description
`rotation`	number

inherited setScale(x, y) tiny/core/display/DisplayObject.js, line 550

Name	Type	Description
`x`	number
`y`	number

inherited setSkew(x, y) tiny/core/display/DisplayObject.js, line 568

Name	Type	Description
`x`	number
`y`	number

Version:

1.1.0

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY) ❯ {Tiny.DisplayObject} tiny/core/display/DisplayObject.js, line 408

Convenience function to set the position, scale, skew and pivot at once.

Name	Type	Default	Description
`x`	number	0	optional The X position
`y`	number	0	optional The Y position
`scaleX`	number	1	optional The X scale value
`scaleY`	number	1	optional The Y scale value
`rotation`	number	0	optional The rotation
`skewX`	number	0	optional The X skew value
`skewY`	number	0	optional The Y skew value
`pivotX`	number	0	optional The X pivot value
`pivotY`	number	0	optional The Y pivot value

Returns:

Type	Description
Tiny.DisplayObject	The DisplayObject instance

inherited setVisible(visible) tiny/core/display/DisplayObject.js, line 533

Name	Type	Description
`visible`	boolean

swapChildren(child, child2) tiny/core/display/Container.js, line 181

Swaps the position of 2 Display Objects within this container.

Name	Type	Description
`child`	Tiny.DisplayObject	First display object to swap
`child2`	Tiny.DisplayObject	Second display object to swap

inherited toGlobal(position, point, skipUpdate) ❯ {Tiny.Point} tiny/core/display/DisplayObject.js, line 274

Calculates the global position of the display object

Name	Type	Default	Description
`position`	Tiny.Point		The world origin to calculate from
`point`	Tiny.Point		optional A Point object in which to store the value, optional (otherwise will create a new Point)
`skipUpdate`	boolean	false	optional Should we skip the update transform.

Returns:

Type	Description
Tiny.Point	A point object representing the position of this object

inherited toLocal(position, from, point, skipUpdate) ❯ {Tiny.Point} tiny/core/display/DisplayObject.js, line 303

Calculates the local position of the display object relative to another point

Name	Type	Default	Description
`position`	Tiny.Point		The world origin to calculate from
`from`	Tiny.DisplayObject		optional The DisplayObject to calculate the global position from
`point`	Tiny.Point		optional A Point object in which to store the value, optional (otherwise will create a new Point)
`skipUpdate`	boolean	false	optional Should we skip the update transform

Returns:

Type	Description
Tiny.Point	A point object representing the position of this object

updateTransform() tiny/core/display/Container.js, line 345

Updates the transform on all children of this container for rendering

Events

inherited added tiny/core/display/DisplayObject.js, line 136

Fired when this DisplayObject is added to a Container.

Name	Type	Description
`container`	Tiny.Container	The container added to.

inherited click tiny/interaction/InteractionManager.js, line 455

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mousedown tiny/interaction/InteractionManager.js, line 427

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mousemove tiny/interaction/InteractionManager.js, line 485

Fired when a pointer device (usually a mouse) is moved while over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mouseout tiny/interaction/InteractionManager.js, line 501

Fired when a pointer device (usually a mouse) is moved off the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mouseover tiny/interaction/InteractionManager.js, line 493

Fired when a pointer device (usually a mouse) is moved onto the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mouseup tiny/interaction/InteractionManager.js, line 441

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited mouseupoutside tiny/interaction/InteractionManager.js, line 469

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointercancel tiny/interaction/InteractionManager.js, line 525

Fired when the operating system cancels a pointer event.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointerdown tiny/interaction/InteractionManager.js, line 509

Fired when a pointer device button is pressed on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointermove tiny/interaction/InteractionManager.js, line 549

Fired when a pointer device is moved while over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointerout tiny/interaction/InteractionManager.js, line 565

Fired when a pointer device is moved off the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointerover tiny/interaction/InteractionManager.js, line 557

Fired when a pointer device is moved onto the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointertap tiny/interaction/InteractionManager.js, line 533

Fired when a pointer device button is pressed and released on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointerup tiny/interaction/InteractionManager.js, line 517

Fired when a pointer device button is released over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited pointerupoutside tiny/interaction/InteractionManager.js, line 541

Fired when a pointer device button is released outside the display object that initially registered a pointerdown.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited removed tiny/core/display/DisplayObject.js, line 143

Fired when this DisplayObject is removed from a Container.

Name	Type	Description
`container`	Tiny.Container	The container removed from.

inherited rightclick tiny/interaction/InteractionManager.js, line 462

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited rightdown tiny/interaction/InteractionManager.js, line 434

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited rightup tiny/interaction/InteractionManager.js, line 448

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited rightupoutside tiny/interaction/InteractionManager.js, line 477

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited tap tiny/interaction/InteractionManager.js, line 597

Fired when a touch point is placed and removed from the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited touchcancel tiny/interaction/InteractionManager.js, line 589

Fired when the operating system cancels a touch.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited touchend tiny/interaction/InteractionManager.js, line 581

Fired when a touch point is removed from the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited touchendoutside tiny/interaction/InteractionManager.js, line 605

Fired when a touch point is removed outside of the display object that initially registered a touchstart.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited touchmove tiny/interaction/InteractionManager.js, line 613

Fired when a touch point is moved along the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event

inherited touchstart tiny/interaction/InteractionManager.js, line 573

Fired when a touch point is placed on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
`event`	Tiny.interaction.InteractionEvent	Interaction event