API Docs for: 2.7.3
Show:

MagnetismComponent2D Class

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

2D Magnetism.

Constructor

MagnetismComponent2D

(
  • core
)

Parameters:

  • core Core

    The main engine.

Methods

_globalWallMag

(
  • wall
  • mstate
)
private

Applies magnetism on the mouse to align walls

Parameters:

_magFromAngle

(
  • mstate
  • target
)
private

Applies mouse magnetism when moving a point to favor 90° and 180° angles.

Parameters:

_magFromPoints

(
  • mstate
  • [ignorePoint]
)
private

Applies magnetism on the mouse according to the existing points on the plan.

Parameters:

_magFromWallDir

(
  • mstate
  • target
)
private

Applies mouse magnetism along one of the parent walls' direction when dragging a point.

Parameters:

_magFromWalls

(
  • mstate
  • [wallList]
)
private

Applies magnetism on the mouse according to existing walls on the plan.

Parameters:

_shortCircuitMagnetism

(
  • mstate
)
Boolean private

Determines if the magnetism must be turned off (short circuited). It happens when the user presses CTRL.

Parameters:

Returns:

Boolean:

Returns true if magnetism should be short circuited, false otherwise.

destroy

()

Inherited from BaseComponent2D:

Method called when the component is destroyed

disable

()

Inherited from BaseComponent2D:

Disables the component

enable

()

Inherited from BaseComponent2D:

Enables the component

getTargeted

(
  • vector
)
Object

Inherited from BaseComponent2D:

Finds out if the given position is over an element handled by the component

Parameters:

  • vector Vector

    A position, usually the cursor's one.

Returns:

Object:

The targeted element, or null if nothing is found.

initialize

()

Inherited from BaseComponent2D:

Method called when Wanaplan is initialized. You don't need to call this method manually.

onContextChanged

(
  • context
)

Inherited from BaseComponent2D:

Method called when the context is switched (2D -> 3D or 3D -> 2D)

Parameters:

  • context String
    The new context

startListening

()

Inherited from BaseComponent2D:

Calls all the event listeners.

stopListening

()

Inherited from BaseComponent2D:

Removes all the event listeners.

update

()

Inherited from BaseComponent2D:

Generic update method, called on every frame

Properties

name

String

Inherited from BaseComponent2D:

Component name

priority

Number

Inherited from BaseComponent2D:

Priority of the component in the "update" and "draw" routines

structure

wnp.Structure

Inherited from BaseComponent2D:

Structure file instance (shortcut to wanaplan.structure). This is the base object where the whole plan is saved