SpiralStairwayStructure Class
Stairway structure for the spiral stairway.
Constructor
SpiralStairwayStructure
()
Item Index
Methods
Methods
add
(
private
-
propertyName -
value
Adds an element to the collection in parameter.
Returns:
Returns true if the value is added else returns false.
addMaterial
(
private
-
parent -
mesh -
materialItem
Adds a material.
Parameters:
-
parentBABYLON.MeshThe parent of the mesh. -
meshBABYLON.MeshThe stairway mesh. -
materialItemwnp.StandardMaterialThe item material.
computeSpiralPoints
()
private
Computes the points of the spiral stairway.
deserialize
(
Object
-
hybrid
Deserializes the object (from JSON).
Parameters:
-
hybridObjectJSON describing the object, built with the method serialize.
Returns:
Object:
The Structure object built from the deserialization
draw
(
private
-
ctx -
_temp
Draws the spiral stairway.
Parameters:
-
ctxCanvasRenderingContext2DContext 2D of the canvas.
-
_tempBABYLON.Vector2The temporary position of the stairway.
getAvailableProperties
()
Object[]
Gets the available properties of the object (user-customizable).
Returns:
Object[]:
An array containing several properties of the object.
getElementByName
(
Object
private
-
name -
collection
Gets an element of the collection by its name.
Parameters:
Returns:
Object:
Returns the needed element if it exists, else returns null.
getFloor
(
FloorStructure
-
collection
Gets the floor referencing this object
Parameters:
-
collectionStringCollection to search within.
Returns:
FloorStructure:
The floor containing this structure, -1 if the object has not been added to any floor collection.
getHopperPoints
()
BABYLON.Vector2
Gets the point of the hopper in the upper floor, induced by the stairway.
Returns:
BABYLON.Vector2:
The points of the hopper.
getNormalAtPoint
(
BABYLON.Vector3
deprecated
-
index
Gets the normal at the given index point.
Parameters:
-
indexNumberThe index of the point.
Returns:
BABYLON.Vector3:
The normal at the point.
getStepBoundPoints
(
BABYLON.Vector3
private
-
bottomIndex
Returns the 4 points of the step.
Parameters:
-
bottomIndexNumberThe index of the bottom point of the step.
Returns:
BABYLON.Vector3:
The four points of a step.
initialize
()
private
Method called after the loading of the component
remove
(
-
structure
Deletes the stairway.
Parameters:
-
structureFloorStructureThe structure of the floor.
serialize
()
Object
Serializes the object (to JSON)
Returns:
Object:
The serialization result, null if nothing is serialized
update
()
Generic update method, must be overridden.
updateReferences
(
-
structure
Generic method for rebuilding references after the deserialization.
For example : restoring the link between a PointStructure and its parent WallStructure
Parameters:
-
structurewnp.StructureFloor Structure to work with
Properties
points
BABYLON.Vector3
The points defining the path of the stairway.