module:Container

Constructor

new module:Container(positionDefinitionopt, optionsopt)

Container constructor

Parameters:

Name	Type	Attributes	Description
`positionDefinition`	PositionDefinition	<optional>	Position in its container
`options`	ContainerOptions	<optional>	Specific options

Source: modules/container/container.js, line 12

Extends

module:EventEmitter

Members

(static) defaultOptions :ContainerOptions

Type:

ContainerOptions

Source: modules/container/container.js, line 449

(static) events :ContainerEvent

Type:

ContainerEvent

Source: modules/container/container.js, line 473

children :Array.<Container>

Type:

Array.<Container>

Source: modules/container/container.js, line 35

frameCount :Number

Type:

Number

Source: modules/container/container.js, line 43

options :ContainerOptions

Type:

ContainerOptions

Source: modules/container/container.js, line 449

parent :Container

Type:

Container

Source: modules/container/container.js, line 39

position :Position

Type:

Position

Source: modules/container/container.js, line 26

Methods

(static) from(definition) → {Container}

Return an instance from a generic object

Parameters:

Name	Type	Description
`definition`	Object	Container definition

Source: modules/container/container.js, line 430

Returns:

Type:: Container

(static) setOpacity(ctx, opacity)

Define context opacity

Parameters:

Name	Type	Description
`ctx`	CanvasRenderingContext2D	Drawing context
`opacity`	Number	Opacity value

Source: modules/container/container.js, line 419

add(…child) → {Container}

Add another container as a child

Parameters:

Name	Type	Attributes	Description
`child`	Container	<repeatable>	Another container

Source: modules/container/container.js, line 92

Returns:

Itself

Type:: Container

climbAncestry(callback, untilopt)

Execute an action on every ancestor of this

Parameters:

Name	Type	Attributes	Default	Description
`callback`	ancestryCallback			Function to execute on each ancestor
`until`	Container	<optional>	null	Define a ancestor where to stop the climbing

Source: modules/container/container.js, line 370

clone() → {Container}

Create a copy of any descendant of Container

Source: modules/container/container.js, line 411

Returns:

Type:: Container

delete() → {Container}

Remove itself from its parent

Source: modules/container/container.js, line 143

Returns:

Itself

Type:: Container

empty() → {Container}

Remove all its children

Source: modules/container/container.js, line 135

Returns:

Itself

Type:: Container

fire(event) → {Container}

Bubble the event to its parent

Parameters:

Name	Type	Description
`event`	BaseEvent	Event to fire

Overrides: module:EventEmitter#fire
Source: modules/container/container.js, line 190

Returns:

Itself

Type:: Container

getAbsolutePosition() → {Position}

Get this container's absolute position (up to it's utmost parent)

Source: modules/container/container.js, line 175

Returns:

Type:: Position

getRoot() → {Container}

Return its highest parent

Source: modules/container/container.js, line 163

Returns:

Itself

Type:: Container

getScene() → {Promise.<Scene>}

Return a promise for the associated scene

Source: modules/container/container.js, line 155

Returns:

Type:: Promise.<Scene>

getTarget(position, ctx) → {Container}

Find the target at a position

Parameters:

Name	Type	Description
`position`	Position	Any position
`ctx`	CanvasRenderingContext2D	Drawing context to apply paths

Source: modules/container/container.js, line 203

Returns:

Itself

Type:: Container

hide() → {Container}

Hide it

Source: modules/container/container.js, line 339

Returns:

Itself

Type:: Container

isAncestorOf(container) → {Boolean}

Define if this is an ancestor of another container

Parameters:

Name	Type	Description
`container`	Container	Any container

Source: modules/container/container.js, line 349

Returns:

Type:: Boolean

isHover() → {Boolean}

Container can't be hovered

Source: modules/container/container.js, line 84

Returns:

Type:: Boolean

makePath() → {Container}

Do nothing on Container, override it to add behavior

Source: modules/container/container.js, line 321

Returns:

Itself

Type:: Container

remove(…child) → {Container}

Remove a child from the list

Parameters:

Name	Type	Attributes	Description
`child`	Container	<repeatable>	Child to remove

Source: modules/container/container.js, line 118

Returns:

Itself

Type:: Container

render(ctx) → {Container}

Call the render method of all children

Parameters:

Name	Type	Description
`ctx`	CanvasRenderingContext2D	Drawing context

Source: modules/container/container.js, line 279

Returns:

Itself

Type:: Container

setContext(ctx) → {Container}

Set variables of the context according to specified options

Parameters:

Name	Type	Description
`ctx`	CanvasRenderingContext2D	Drawing context

Source: modules/container/container.js, line 239

Returns:

Itself

Type:: Container

setOptions(optionsopt) → {Container}

Define options for this container

Parameters:

Name	Type	Attributes	Default	Description
`options`	ContainerOptions	<optional>	{}	Options to override

Source: modules/container/container.js, line 65

Returns:

Itself

Type:: Container

show() → {Container}

Display it

Source: modules/container/container.js, line 329

Returns:

Itself

Type:: Container

toJSON() → {Object}

Return a json ready object

Source: modules/container/container.js, line 383

Returns:

Type:: Object

Type Definitions

ancestryCallback(ancestor)

Parameters:

Name	Type	Description
`ancestor`	Container

Source: modules/container/container.js, line 366

ContainerEvent

Type:

Object

Properties

Name	Type	Description
`attach`	String	Container is append to a new parent
`detach`	String	Container remove from it's parent
`draw`	String	Container is drawn
`hide`	String
`show`	String

Source: modules/container/container.js, line 464

ContainerOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`shown`	Boolean	<optional>	true	Is shown
`opacity`	Number	<optional>	null	Opacity level from 0 to 1 (null mean inherited from parent)
`rotation`	Number	<optional>	0	Rotation ratio from 0 to 1 (clockwise)
`rotationCenter`	PositionDefinition	<optional>	new Position()	Center of rotation relative to this position
`scale`	Number \| PositionDefinition	<optional>	1	Scaling ratio or a pair of value for horizontal and vertical scaling
`zIndex`	Number	<optional>	1	Depth ordering
`clip`	Component	<optional>	null	Other component used to clip the rendering

Source: modules/container/container.js, line 439