WanaPlan

API Docs for: 2.7.0
Show:

AvatarComponent3D

Extends BaseComponent3D
Module: Component
Parent Module: Wanaplan

Summary

This component adds and handles a 3D avatar on the scene.

Constructor

AvatarComponent3D

Syntax

AvatarComponent3D

(
  • 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

Destructor.

disable

Inherited from BaseComponent3D

Syntax

disable

()

Summary

Disables event listening.

enable

Inherited from BaseComponent3D

Syntax

enable

()

Summary

Enables event listening.

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

onKeyDown

Syntax

onKeyDown

(
  • event
)

Summary

Triggered on event wnp.keyboardManager.keyDown. Used to rotate the avatar.

Parameters:

  • event Event

    The JS event.

onKeyUp

Syntax

onKeyUp

(
  • event
)

Summary

Triggered on event wnp.keyboardManager.keyUp.

Parameters:

  • event Event

    The JS event.

setVisibility

Syntax

setVisibility

(
  • isVisible
)

Summary

Changes the Avatar visibility state.

Parameters:

  • isVisible Boolean

    True to set visible and false to set invisible.

startListening

Inherited from BaseComponent3D:

Syntax

startListening

()

Summary

Calls all the event listeners.

stopListening

Inherited from BaseComponent3D:

Syntax

stopListening

()

Summary

Removes all the event listeners.

update

Inherited from BaseComponent3D:

Syntax

update

(
  • deltaTime
)

Summary

Updates the dynamic part of the component.

Parameters:

  • deltaTime Number
    The time interval.

Properties

avatar

Syntax

avatar

BABYLON.Mesh

Summary

The avatar mesh.

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.camera.move

Syntax

wnp.engine3D.camera.move

Summary

Fired when the 3D camera has been moved.

wnp.engine3D.UIobject.transform

Syntax

wnp.engine3D.UIobject.transform

Summary

Fired when the transform of an object is modified.

wnp.request.disable-orbit-camera

Syntax

wnp.request.disable-orbit-camera

Summary

Fired to disable the orbit camera.

wnp.request.enable-orbit-camera

Syntax

wnp.request.enable-orbit-camera

Summary

Fired to enable the orbit camera.