WanaPlan

API Docs for: 2.7.0
Show:

EVENTS

Module: EVENTS

Summary

Events description (not a real class)

Item Index

Events

Events

wnp.component.lock

Syntax

wnp.component.lock

Summary

Fired to lock/unlock the drag action on scene.

wnp.editionComponent.removeObject

Syntax

wnp.editionComponent.removeObject

Summary

wnp.engine2d.onAddOverture

Syntax

wnp.engine2d.onAddOverture

Summary

Fired when the action to add an overture is started.

wnp.engine2d.onAddOvertureEnd

Syntax

wnp.engine2d.onAddOvertureEnd

Summary

Fired when the action to add an overture is done.

wnp.engine2d.onAddStairway

Syntax

wnp.engine2d.onAddStairway

Summary

Fired when the user requests the add of a stairway in the menu.

Event Payload:

  • stairwayType String

    Type of the stairway. Can be 'straight' or 'spiral'.

  • bearing Boolean

    Activates the bearing on the geometry.

wnp.engine2d.onAddSubSlopeOverture

Syntax

wnp.engine2d.onAddSubSlopeOverture

Summary

Fired when the user requests the addition of a subslopeOverture (click on the button)

wnp.engine2d.onEditSubSlope

Syntax

wnp.engine2d.onEditSubSlope

Summary

Fired when the user enters the subslope edit mode.

wnp.engine2d.onModeSubSlopeEnd

Syntax

wnp.engine2d.onModeSubSlopeEnd

Summary

Fired when the user quits the subslope edit mode.

wnp.engine3D.allFloorsReady

Syntax

wnp.engine3D.allFloorsReady

Summary

Fired when all floors are ready.

wnp.engine3D.brushReady

Syntax

wnp.engine3D.brushReady

Summary

Fired when the decoration brush is ready.

wnp.engine3D.camera.move

Syntax

wnp.engine3D.camera.move

Summary

Fired when the 3D camera has moved.

wnp.engine3D.camera.zoom

Syntax

wnp.engine3D.camera.zoom

Summary

Fired to zoom the camera.

wnp.engine3D.cameraChanged

Syntax

wnp.engine3D.cameraChanged

Summary

Fired when the user changes the camera.

wnp.engine3D.changeGround

Syntax

wnp.engine3D.changeGround

Summary

Fired to change the material of the ground

wnp.engine3D.changeSky

Syntax

wnp.engine3D.changeSky

Summary

Fired to change the material of the sky

wnp.engine3D.configurator.animationIn.begin

Syntax

wnp.engine3D.configurator.animationIn.begin

Summary

Fired by the configurator component when an 'Animation-In' begins.

wnp.engine3D.configurator.animationIn.end

Syntax

wnp.engine3D.configurator.animationIn.end

Summary

Fired by the configurator component when an 'Animation-In' is done.

wnp.engine3D.configurator.animationOut.begin

Syntax

wnp.engine3D.configurator.animationOut.begin

Summary

Fired by the configurator component when an 'Animation-Out' begins.

wnp.engine3D.configurator.animationOut.end

Syntax

wnp.engine3D.configurator.animationOut.end

Summary

Fired by the configurator component when an 'Animation-Out' is done.

wnp.engine3D.configurator.start

Syntax

wnp.engine3D.configurator.start

Summary

Fired to start the configurator.

wnp.engine3D.configurator.stop

Syntax

wnp.engine3D.configurator.stop

Summary

Fired to stop the configurator.

wnp.engine3D.decorate

Syntax

wnp.engine3D.decorate

Summary

Fired to decorate an object with a material.

wnp.engine3D.floorReady

Syntax

wnp.engine3D.floorReady

Summary

Fired when a floor is ready.

wnp.engine3D.object.clone

Syntax

wnp.engine3D.object.clone

Summary

Fired to clone an object

wnp.engine3D.object.create

Syntax

wnp.engine3D.object.create

Summary

Fired when an object is created.

Event Payload:

  • object BABYLON.Mesh

    The created mesh.

  • objectStructure ObjectStructure

    The involved object structure.

wnp.engine3D.object.dispose

Syntax

wnp.engine3D.object.dispose

Summary

Fired when a mesh is disposed of.

Event Payload:

  • object BABYLON.Mesh

    The concerned mesh.

wnp.engine3D.object.end-transform

Syntax

wnp.engine3D.object.end-transform

Summary

Fired when the TransformComponent ends to transform the position/rotation of an object.

Event Payload:

  • object BABYLON.Mesh

    The involved object.

wnp.engine3D.object.refresh

Syntax

wnp.engine3D.object.refresh

Summary

Fired when an object is rebuilt.

Event Payload:

  • object BABYLON.Mesh

    The refreshed mesh.

wnp.engine3D.object.rotated

Syntax

wnp.engine3D.object.rotated

Summary

Fired when the TransformComponent just rotated an object on the scene.

Event Payload:

  • object BABYLON.Mesh

    The involved object.

  • pending Boolean

    True if the TransformComponent is currently waiting for the end of the transformation to notify and set up the history.

  • newValue BABLYON.Vector3

    The new rotation of the object.

wnp.engine3D.object.start-transform

Syntax

wnp.engine3D.object.start-transform

Summary

Fired when the TransformComponent begins to transform the position/rotation of an object.
This will be followed by a wnp.engine3D.object.end-transform event.

Event Payload:

  • object BABYLON.Mesh

    The involved object.

wnp.engine3D.object.translate

Syntax

wnp.engine3D.object.translate

Summary

Fired when the TransformComponent just translated an object on the scene.

Event Payload:

  • object BABYLON.Mesh

    The involved object.

  • pending Boolean

    True if the TransformComponent is currently waiting for the end of the transformation to notify and set up the history.

  • newValue BABLYON.Vector3

    The new position of the object.

wnp.engine3D.overturesReady

Syntax

wnp.engine3D.overturesReady

Summary

Fired once the wall overtures are created.

Event Payload:

  • floor BABYLON.Mesh

    The mesh of the floor.

  • structure FloorStructure

    The current floor structure.

  • walls BABYLON.Mesh

    The mesh of the walls.

wnp.engine3D.paint

Syntax

wnp.engine3D.paint

Summary

Fired when a paint texture is chosen in the decoration menu.

wnp.engine3D.roofsReady

Syntax

wnp.engine3D.roofsReady

Summary

Fired when the roofs have been added to the scene.

Event Payload:

  • floor BABYLON.Mesh

    3D Floor mesh.

  • structure FloorStructure

    Related floor structure.

  • walls BABYLON.Mesh

    The resultant wall mesh for this floor (The roofs carve the wall mesh when built).

wnp.engine3D.roomsReady

Syntax

wnp.engine3D.roomsReady

Summary

Fired when rooms are ready.

wnp.engine3D.subslopeOverturesReady

Syntax

wnp.engine3D.subslopeOverturesReady

private

Summary

Fired once the subslope overtures are created.

Event Payload:

  • floor BABYLON.Mesh

    The mesh of the floor.

  • structure wnp.floorStructure

    The current structure.

  • walls BABYLON.Mesh

    The mesh of the wall.

wnp.engine3D.subslopesReady

Syntax

wnp.engine3D.subslopesReady

Summary

Fired when the subslopes are ready and added to the scene.

Event Payload:

  • floor BABYLON.Mesh

    3D Floor mesh.

  • structure FloorStructure

    Related floor structure.

  • walls BABYLON.Mesh

    The resultant wall mesh for this floor (The subslopes carve the wall mesh when built).

wnp.engine3D.UIobject.transform

Syntax

wnp.engine3D.UIobject.transform

Summary

Fired when the transform of an object is modified.

wnp.engine3D.wallsReady

Syntax

wnp.engine3D.wallsReady

Summary

Fired when all 3D wall meshes are ready.

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.input.pointerchanged

Syntax

wnp.input.pointerchanged

Summary

Fired when an input has been detected (click, touch, etc.).

Event Payload:

  • inputStatus Object

    an object containing all states of the pointer manager

wnp.keyboardManager.keyDown

Syntax

wnp.keyboardManager.keyDown

Summary

Fired on key down. Same parameters as the keydown standard javascript event.

wnp.keyboardManager.keyUp

Syntax

wnp.keyboardManager.keyUp

Summary

Fired on key up. Same parameters as the keyup standard javascript event.

wnp.menu.main.add

Syntax

wnp.menu.main.add

Summary

Fired to add a menu item into the main menu.

wnp.menu.main.deselect

Syntax

wnp.menu.main.deselect

Summary

Fired when an item from main menu needs to be deselected.

wnp.menu.main.remove

Syntax

wnp.menu.main.remove

Summary

Fired to remove a menu item from the main menu.

wnp.menu.main.replace

Syntax

wnp.menu.main.replace

Summary

Fired to replace a menu item from the main menu with another.

wnp.menu.top.add

Syntax

wnp.menu.top.add

Summary

Fired to add a menu item into the top menu.

wnp.menu.top.delete

Syntax

wnp.menu.top.delete

Summary

Fired to delete a menu item from the top menu.

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.

wnp.mobile.toggleMenu

Syntax

wnp.mobile.toggleMenu

Summary

Fired to show/hide the left menu on mobile devices

wnp.request.changeLang

Syntax

wnp.request.changeLang

Summary

Fired to change the language on wanaplan

wnp.request.closePopup

Syntax

wnp.request.closePopup

Summary

Fired to close a popup.

wnp.request.configurator.animation.cancel

Syntax

wnp.request.configurator.animation.cancel

Summary

Fired by the configurator component when an animation is canceled.

wnp.request.configurator.animationIn.start

Syntax

wnp.request.configurator.animationIn.start

Summary

Fired to ask the configurator to start an 'Animation-In'.

wnp.request.configurator.animationOut.start

Syntax

wnp.request.configurator.animationOut.start

Summary

Fired to ask the configurator to start an 'Animation-Out'.

wnp.request.configurator.cancel

Syntax

wnp.request.configurator.cancel

Summary

Fired when the configurator needs to be hidden.

wnp.request.configurator.start

Syntax

wnp.request.configurator.start

Summary

Fired when the configurator is needed for an object.

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.

wnp.request.exit

Syntax

wnp.request.exit

Summary

Fired to quit Wanaplan.

wnp.request.exited

Syntax

wnp.request.exited

Summary

Fired when quitting Wanaplan.

wnp.request.floorAdded

Syntax

wnp.request.floorAdded

Summary

Fired when a floor needs to be added.

wnp.request.floorDeleted

Syntax

wnp.request.floorDeleted

Summary

Fired when a floor needs to be deleted.

wnp.request.floorSelected

Syntax

wnp.request.floorSelected

Summary

Fired when a floor needs to be selected.

wnp.request.groupConfigurator.start

Syntax

wnp.request.groupConfigurator.start

Summary

Fired when the configurator is needed for a group.

wnp.request.historyAction

Syntax

wnp.request.historyAction

Summary

Fired when an object is refreshed and if the history is needed.

Event Payload:

  • component BaseComponent3D

    The component of the action

  • object BABYLON.Mesh

    The target.

  • params Object

    Params of the history.

  • action String

    The type of action done.

wnp.request.newPlan

Syntax

wnp.request.newPlan

Summary

Fired when a new plan needs to be created.

wnp.request.newPlanReady

Syntax

wnp.request.newPlanReady

Summary

Fired when a new plan is ready.

wnp.request.object.remove

Syntax

wnp.request.object.remove

Summary

Fired when the delete button is pushed while a mesh is selected.

Event Payload:

  • object BABYLON.Mesh

    The currently selected object.

  • structure FloorStructure

    The current structure.

wnp.request.saveHistory

Syntax

wnp.request.saveHistory

Summary

Fired to request a save of the history.

wnp.request.saveStructure

Syntax

wnp.request.saveStructure

Summary

Fired to request the save of a structure.

wnp.request.switch-transparency

Syntax

wnp.request.switch-transparency

Summary

Fired when the user requests a change in wall transparency

wnp.request.takeScreenshot

Syntax

wnp.request.takeScreenshot

Summary

Fired when the user requests a screenshot.

wnp.request.toggleFullscreen

Syntax

wnp.request.toggleFullscreen

Summary

Fired when the user clicks on the fullscreen toggle button.

wnp.subslope.drag-end

Syntax

wnp.subslope.drag-end

Summary

Fired when the user stops dragging the subslope.

wnp.ui.showAboutWindow

Syntax

wnp.ui.showAboutWindow

Summary

Fired to show the 'About' window