API Docs for: 2.7.3
Show:

EditMeasureComponent Class

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Component allowing to edit 2D Measures when clicking on them.

Constructor

EditMeasureComponent

(
  • core
)

Parameters:

  • core wnp.Core

    Wanaplan Core.

Methods

destroy

()

Inherited from BaseComponent2D:

Method called when the component is destroyed

destroyDialog

()

Destroys the measure edition dialog if it exists

disable

()

Inherited from BaseComponent2D:

Disables the component

displacePoint

(
  • target_measure
  • displacement
  • angleWall
  • moveLeftUp
)

Function that applies the chosen displacement to the chosen measure extremity

Parameters:

  • target_measure MeasureStructure

    measure to modify

  • displacement Number

    amount of displacement to apply (positive or negative)

  • angleWall Number

    the angle of the wall vector with the x horizontal vector

  • moveLeftUp Boolean

    true if we want to move the point that is on the left for a horizonal measure, or on top for a vertical one

enable

()

Inherited from BaseComponent2D:

Enables the component

getSideToMove

(
  • angleWall
  • moveLeftUp
)
Integer private

Function to find out which side of the wall we want

Parameters:

  • angleWall Number

    the angle of the wall vector p0p1 with the x vector

  • moveLeftUp Boolean

    true if we want the point on the left for a horizonal wall, or up for a vertical one

Returns:

Integer:

Returns 0 or 1 the index of the wanted extremity

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.

onClick

(
  • event
)

Destroys the measure edition dialog if click outside the dialog And opens the measure edition dialog if click on a measure Triggered on event click

Parameters:

  • event Event

    The JS event.

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