Class: Piece

Piece(structureopt, configopt)

A jigsaw piece

Constructor

new Piece(structureopt, configopt)

Parameters:

Name	Type	Attributes	Description
`structure`	Structure	<optional>
`config`	PieceConfig	<optional>

Source:

piece.js, line 48

Members

_size :Size

Type:

Size

Source:

piece.js, line 58

centralAnchor :Anchor

Type:

Anchor

Source:

piece.js, line 56

connections :Array.<Piece>

Type:

Array.<Piece>

Source:

piece.js, line 143

connectListeners :Array.<ConnectionListener>

Type:

Array.<ConnectionListener>

Source:

piece.js, line 79

diameter :Vector

The double of the radius

Type:

Vector

Source:

piece.js, line 539

disconnectListeners :Array.<ConnectionListener>

Type:

Array.<ConnectionListener>

Source:

piece.js, line 81

downAnchor :Anchor

Type:

Anchor

Source:

piece.js, line 492

horizontalConnector

Source:

piece.js, line 566

id :string

This piece id. It is extracted from metadata

Type:

string

Source:

piece.js, line 559

inserts :Array.<Insert>

Type:

Array.<Insert>

Source:

piece.js, line 155

leftAnchor :Anchor

Type:

Anchor

Source:

piece.js, line 513

leftConnection :Piece

Type:

Piece

Source:

piece.js, line 290

metadata :any

Type:

any

Source:

piece.js, line 54

presentConnections :Array.<Piece>

Type:

Array.<Piece>

Source:

piece.js, line 136

proximity :number

Type:

number

Source:

piece.js, line 550

radius :Vector

Type:

Vector

Source:

piece.js, line 530

rightAnchor :Anchor

Type:

Anchor

Source:

piece.js, line 499

translateListeners :Array.<TranslationListener>

Type:

Array.<TranslationListener>

Source:

piece.js, line 77

upAnchor :Anchor

Type:

Anchor

Source:

piece.js, line 506

upConnection :Piece

Type:

Piece

Source:

piece.js, line 279

verticalConnector

Source:

piece.js, line 573

Methods

(static) import(dump) → {Piece}

Converts this piece back from a dump. Connections are not restored. Puzzle#autoconnect method should be used after importing all them

Parameters:

Name	Type	Description
`dump`	PieceDump

Source:

piece.js, line 623

Returns:

Type: Piece

annotate(metadata)

Adds unestructured user-defined metadata on this piece.

Parameters:

Name	Type	Description
`metadata`	object

Source:

piece.js, line 110

attractHorizontally(other)

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 236

attractVertically(other)

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 221

belongTo(puzzle)

Parameters:

Name	Type	Description
`puzzle`

Source:

piece.js, line 129

canConnectHorizontallyWith(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 435

Returns:

Type: boolean

canConnectVerticallyWith(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 444

Returns:

Type: boolean

centerAround(anchor)

Sets the centralAnchor for this piece.

Parameters:

Name	Type	Description
`anchor`	Anchor

Source:

piece.js, line 306

configure(config)

Runs positining, sizing and metadata configurations in a single step

Parameters:

Name	Type	Description
`config`	PieceConfig

Source:

piece.js, line 90

connectHorizontallyWith(other, backopt)

Parameters:

Name	Type	Attributes	Default	Description
`other`	Piece
`back`	boolean	<optional>	false

Source:

piece.js, line 229

connectVerticallyWith(other, backopt)

Parameters:

Name	Type	Attributes	Default	Description
`other`	Piece
`back`	boolean	<optional>	false

Source:

piece.js, line 214

drag(dx, dy)

Parameters:

Name	Type	Description
`dx`	number
`dy`	number

Source:

piece.js, line 396

dragShouldDisconnect(dx, dy)

Whether this piece should get disconnected while dragging on the given direction, according to its puzzle's drag mode.

Parameters:

Name	Type	Description
`dx`	number
`dy`	number

Source:

piece.js, line 417

See:

Puzzle#dragShouldDisconnect

export(options) → {PieceDump}

Converts this piece into a plain, stringify-ready object. Connections should have ids

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Description
`compact`	boolean	<optional>

Source:

piece.js, line 602

Returns:

Type: PieceDump

fireConnect(other)

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 196

fireDisconnect(others)

Parameters:

Name	Type	Description
`others`	Array.<Piece>

Source:

piece.js, line 203

fireTranslate(dx, dy)

Parameters:

Name	Type	Description
`dx`	number
`dy`	number

Source:

piece.js, line 189

getConnector(kind) → {Connector}

Retrieves the requested connector, initializing it if necessary.

Parameters:

Name	Type	Description
`kind`	"vertical" \| "horizontal"

Source:

piece.js, line 584

Returns:

Type: Connector

horizontallyCloseTo(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 462

Returns:

Type: boolean

horizontallyMatch(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 481

Returns:

Type: boolean

isAt(x, y) → {boolean}

Tells whether this piece central anchor is at given point

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source:

piece.js, line 332

Returns:

Type: boolean

locateAt(x, y)

Sets the initial position of this piece. This method is similar to Piece#centerAround, but takes a pair instead of an anchor.

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source:

piece.js, line 321

onConnect(f)

Parameters:

Name	Type	Description
`f`	ConnectionListener	the callback

Source:

piece.js, line 174

onDisconnect(f)

Parameters:

Name	Type	Description
`f`	ConnectionListener	the callback

Source:

piece.js, line 181

onTranslate(f)

Parameters:

Name	Type	Description
`f`	TranslationListener	the callback

Source:

piece.js, line 167

push(dx, dy, quietopt, pushedPiecesopt)

Parameters:

Name	Type	Attributes	Default	Description
`dx`	number
`dy`	number
`quiet`	boolean	<optional>	false
`pushedPieces`	Array.<Piece>	<optional>

Source:

piece.js, line 384

reannotate(metadata)

Sets unestructured user-defined metadata on this piece. This object has no strong requirement, but it is recommended to have an id property.

Parameters:

Name	Type	Description
`metadata`	object

Source:

piece.js, line 122

recenterAround(anchor, quietopt)

Moves this piece to the given position, firing translation events. Piece must be already centered.

Parameters:

Name	Type	Attributes	Default	Description
`anchor`	Anchor			the new central anchor
`quiet`	boolean	<optional>	false	indicates whether events should be suppressed

Source:

piece.js, line 343

relocateTo(x, y, quietopt)

Moves this piece to the given position, firing translation events. Piece must be already centered. This method is similar to Piece#recenterAround, but takes a pair instead of an anchor.

Parameters:

Name	Type	Attributes	Default	Description
`x`	number			the final x position
`y`	number			the final y position
`quiet`	boolean	<optional>	false	indicates whether events should be suppressed

Source:

piece.js, line 357

resize(size)

Defines this piece's own dimension, overriding puzzle's default dimension

Parameters:

Name	Type	Description
`size`	Size

Source:

piece.js, line 523

translate(dx, dy, quietopt)

Move this piece a given distance, firing translation events

Parameters:

Name	Type	Attributes	Default	Description
`dx`	number			the x distance
`dy`	number			the y distance
`quiet`	boolean	<optional>	false	indicates whether events should be suppressed

Source:

piece.js, line 368

tryConnectHorizontallyWith(other, backopt)

Parameters:

Name	Type	Attributes	Default	Description
`other`	Piece
`back`	boolean	<optional>	false

Source:

piece.js, line 254

tryConnectVerticallyWith(other, backopt)

Parameters:

Name	Type	Attributes	Default	Description
`other`	Piece
`back`	boolean	<optional>	false

Source:

piece.js, line 264

tryConnectWith(other, backopt)

Parameters:

Name	Type	Attributes	Default	Description
`other`	Piece
`back`	boolean	<optional>	false

Source:

piece.js, line 244

verticallyCloseTo(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 453

Returns:

Type: boolean

verticallyMatch(other) → {boolean}

Parameters:

Name	Type	Description
`other`	Piece

Source:

piece.js, line 472

Returns:

Type: boolean