WanaPlan

API Docs for: 2.7.0
Show:

TransparencyComponent

Extends BaseComponent3D
Module: Component
Parent Module: Wanaplan

Summary

This component enables the user to better see what he is doing by making walls and roofs transparent.

Constructor

TransparencyComponent

Syntax

TransparencyComponent

(
  • core
)

Summary

Parameters:

  • core Core

    Wanaplan.

Methods

compute

Inherited from BaseComponent3D:

Syntax

compute

() private

Summary

Recompute of the component.

destroy

Inherited from BaseComponent3D:

Syntax

destroy

()

Summary

Destructor.

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

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

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.

switchTransparencyMode

Syntax

switchTransparencyMode

()

Summary

Toggles between opaque/transparent.

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.engine3d.wallTransparency.off

Syntax

wnp.engine3d.wallTransparency.off

Summary

Fired when disabling wall transparency.

wnp.engine3d.wallTransparency.on

Syntax

wnp.engine3d.wallTransparency.on

Summary

Fired when enabling wall transparency.

wnp.request.switch-transparency

Syntax

wnp.request.switch-transparency

Summary

Fired when the user requests a change in wall transparency