API Docs for: 2.7.3
Show:

EVENTS Class

Module: EVENTS

Events description (not a real class)

Item Index

Events

Events

wnp.component.lock

Fired to lock/unlock the drag action on scene.

wnp.editionComponent.removeObject

wnp.engine2d.onAddOverture

Fired when the action to add an overture is started.

wnp.engine2d.onAddOvertureEnd

Fired when the action to add an overture is done.

wnp.engine2d.onAddStairway

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

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

wnp.engine2d.onEditSubSlope

Fired when the user enters the subslope edit mode.

wnp.engine2d.onModeSubSlopeEnd

Fired when the user quits the subslope edit mode.

wnp.engine3D.allFloorsReady

Fired when all floors are ready.

wnp.engine3D.brushReady

Fired when the decoration brush is ready.

wnp.engine3D.camera.move

Fired when the 3D camera has moved.

wnp.engine3D.camera.zoom

Fired to zoom the camera.

wnp.engine3D.cameraChanged

Fired when the user changes the camera.

wnp.engine3D.changeGround

Fired to change the material of the ground

wnp.engine3D.changeSky

Fired to change the material of the sky

wnp.engine3D.configurator.animationIn.begin

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

wnp.engine3D.configurator.animationIn.end

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

wnp.engine3D.configurator.animationOut.begin

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

wnp.engine3D.configurator.animationOut.end

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

wnp.engine3D.configurator.start

Fired to start the configurator.

wnp.engine3D.configurator.stop

Fired to stop the configurator.

wnp.engine3D.decorate

Fired to decorate an object with a material.

wnp.engine3D.floorReady

Fired when a floor is ready.

wnp.engine3D.object.clone

Fired to clone an object

wnp.engine3D.object.create

Fired when an object is created.

Event Payload:

  • object BABYLON.Mesh

    The created mesh.

  • objectStructure ObjectStructure

    The involved object structure.

wnp.engine3D.object.dispose

Fired when a mesh is disposed of.

Event Payload:

  • object BABYLON.Mesh

    The concerned mesh.

wnp.engine3D.object.end-transform

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

Fired when an object is rebuilt.

Event Payload:

  • object BABYLON.Mesh

    The refreshed mesh.

wnp.engine3D.object.rotated

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

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

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

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

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

wnp.engine3D.roofsReady

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

Fired when rooms are ready.

wnp.engine3D.subslopeOverturesReady

private

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

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

Fired when the transform of an object is modified.

wnp.engine3D.wallsReady

Fired when all 3D wall meshes are ready.

wnp.engine3d.wallTransparency.off

Fired when disabling wall transparency.

wnp.engine3d.wallTransparency.on

Fired when enabling wall transparency.

wnp.input.pointerchanged

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

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

wnp.keyboardManager.keyUp

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

wnp.menu.main.add

Fired to add a menu item into the main menu.

wnp.menu.main.deselect

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

wnp.menu.main.remove

Fired to remove a menu item from the main menu.

wnp.menu.main.replace

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

wnp.menu.top.add

Fired to add a menu item into the top menu.

wnp.menu.top.delete

Fired to delete a menu item from the top menu.

wnp.menu.top.sub.add

Fired to add a menu item into the sub menu.

wnp.menu.top.sub.delete

Fired to delete a menu item from the sub menu.

wnp.menu.top.sub.replace

Fired to replace a sub menu item.

wnp.mobile.toggleMenu

Fired to show/hide the left menu on mobile devices

wnp.request.changeLang

Fired to change the language on wanaplan

wnp.request.closePopup

Fired to close a popup.

wnp.request.configurator.animation.cancel

Fired by the configurator component when an animation is canceled.

wnp.request.configurator.animationIn.start

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

wnp.request.configurator.animationOut.start

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

wnp.request.configurator.cancel

Fired when the configurator needs to be hidden.

wnp.request.configurator.start

Fired when the configurator is needed for an object.

wnp.request.disable-orbit-camera

Fired to disable the orbit camera.

wnp.request.enable-orbit-camera

Fired to enable the orbit camera.

wnp.request.exit

Fired to quit Wanaplan.

wnp.request.exited

Fired when quitting Wanaplan.

wnp.request.floorAdded

Fired when a floor needs to be added.

wnp.request.floorDeleted

Fired when a floor needs to be deleted.

wnp.request.floorSelected

Fired when a floor needs to be selected.

wnp.request.groupConfigurator.start

Fired when the configurator is needed for a group.

wnp.request.historyAction

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

Fired when a new plan needs to be created.

wnp.request.newPlanReady

Fired when a new plan is ready.

wnp.request.object.remove

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

Fired to request a save of the history.

wnp.request.saveStructure

Fired to request the save of a structure.

wnp.request.switch-transparency

Fired when the user requests a change in wall transparency

wnp.request.takeScreenshot

Fired when the user requests a screenshot.

wnp.request.toggleFullscreen

Fired when the user clicks on the fullscreen toggle button.

wnp.subslope.drag-end

Fired when the user stops dragging the subslope.

wnp.ui.showAboutWindow

Fired to show the 'About' window