StairwayStructure
Summary
The structure of a stairway.
Constructor
StairwayStructure
Syntax
StairwayStructure
()
Summary
Item Index
Methods
Methods
add
Syntax
add
-
propertyName
-
value
Summary
Adds an element to the collection in parameter.Returns:
addMaterial
Syntax
addMaterial
-
parent
-
mesh
-
materialItem
Summary
Adds a material.
Parameters:
-
parent
BABYLON.MeshThe parent of the mesh.
-
mesh
BABYLON.MeshThe stairway mesh.
-
materialItem
wnp.StandardMaterialThe item material.
deserialize
Syntax
Summary
Deserializes the object (from JSON).Parameters:
-
hybrid
ObjectJSON describing the object, built with the method serialize.
Returns:
The Structure object built from the deserialization
getAvailableProperties
Syntax
Summary
Gets the available properties of the object (user-customizable).
Returns:
An array containing several properties of the object.
getElementByName
Syntax
Summary
Gets an element of the collection by its name.Parameters:
Returns:
getFloor
Syntax
Summary
Gets the floor referencing this objectParameters:
-
collection
StringCollection to search within.
Returns:
The floor containing this structure, -1 if the object has not been added to any floor collection.
getHopperPoints
Syntax
getHopperPoints
()
BABYLON.Vector2
Summary
Gets the hopper points created by the stairway.
Returns:
The four points of the hopper carved in the upper floor.
getNormalAtPoint
Syntax
getNormalAtPoint
-
index
Summary
Gets the normal at the given index point.
Parameters:
-
index
NumberThe index of the point.
Returns:
The normal at the point.
getStepBoundPoints
Syntax
getStepBoundPoints
-
bottomIndex
Summary
Returns the 4 points of the step.
Parameters:
-
bottomIndex
NumberThe index of the bottom point of the step.
Returns:
The four points of a step.
initialize
Syntax
initialize
()
private
Summary
Method called after the loading of the componentremove
Syntax
remove
-
structure
Summary
Deletes the stairway.
Parameters:
-
structure
FloorStructureThe structure of the floor.
serialize
Syntax
Summary
Serializes the object (to JSON)Returns:
update
Syntax
update
()
Summary
Generic update method, must be overridden.updateReferences
Syntax
updateReferences
-
structure
Summary
Generic method for rebuilding references after the deserialization. For example : restoring the link between a PointStructure and its parent WallStructureParameters:
-
structure
wnp.StructureFloor Structure to work with
Properties
points
Syntax
points
BABYLON.Vector3
Summary
The points defining the path of the stairway.