WanaPlan

API Docs for: 2.7.0
Show:

LockComponent

Extends BaseComponent3D
Module: Component
Parent Module: Wanaplan

Summary

This component is responsible for adding a lock icon to lock/unlock the drag action on all objects in the scene.

Constructor

LockComponent

Syntax

LockComponent

(
  • core
)

Summary

Parameters:

  • core Core

    The main engine.

Methods

compute

Inherited from BaseComponent3D:

Syntax

compute

() private

Summary

Recompute of the component.

destroy

Inherited from BaseComponent3D

Syntax

destroy

()

Summary

Removes the icon from the menu and stops listening to the lock event.

disable

Inherited from BaseComponent3D:

Syntax

disable

()

Summary

Disables the component

enable

Inherited from BaseComponent3D:

Syntax

enable

()

Summary

Enables the component

getFloor

Inherited from BaseComponent3D:

Syntax

getFloor

(
  • [structure]
)
BABYLON.Mesh

Summary

Gets the 3D mesh of the floor structure in parameter (by default current floor).

Parameters:

Returns:

BABYLON.Mesh:

The floor mesh in 3D.

initialize

Inherited from BaseComponent3D

Syntax

initialize

()

Summary

Initializes objects and adds a custom stylesheet.

onContextChanged

Inherited from BaseComponent3D:

Syntax

onContextChanged

(
  • context
)

Summary

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

Parameters:

  • context String

    The new context

startListening

Inherited from BaseComponent3D:

Syntax

startListening

()

Summary

Calls all the event listeners.

stopListening

Inherited from BaseComponent3D:

Syntax

stopListening

()

Summary

Removes all the event listeners.

toggleLock

Syntax

toggleLock

(
  • event
)

Summary

Toggles lock or unlock. Triggered on event wnp.component.lock

Parameters:

  • event Object

    The event object.

update

Inherited from BaseComponent3D:

Syntax

update

(
  • deltaTime
)

Summary

Updates the dynamic part of the component.

Parameters:

  • deltaTime Number
    The time interval.

Properties

keyboardManager

Inherited from BaseComponent3D:

Syntax

keyboardManager

wnp.KeyboardManager

Summary

Instance of the Keyboard Manager (shortcut to wanaplan.keyboardManager).

name

Inherited from BaseComponent3D:

Syntax

name

String

Summary

Name of the component.

structure

Inherited from BaseComponent3D:

Syntax

structure

wnp.Structure

Summary

Instance of the structure (shortcut to wanaplan.structure).

Events

wnp.component.lock

Syntax

wnp.component.lock

Summary

Fired to lock/unlock the drag action on scene.

wnp.menu.top.sub.add

Syntax

wnp.menu.top.sub.add

Summary

Fired to add a menu item into the sub menu.

wnp.menu.top.sub.delete

Syntax

wnp.menu.top.sub.delete

Summary

Fired to delete a menu item from the sub menu.

wnp.menu.top.sub.replace

Syntax

wnp.menu.top.sub.replace

Summary

Fired to replace a sub menu item.