OvertureStructure
Summary
Overture structure.
Constructor
OvertureStructure
Syntax
OvertureStructure
()
Summary
Item Index
Methods
Methods
add
Syntax
add
-
propertyName
-
value
Summary
Adds an element to the collection in parameter.Returns:
checkCoherence
Syntax
checkCoherence
-
structure
Summary
Checks the coherence of all the parameters.
Parameters:
-
structure
OvertureStructureThe overture structure.
clampSize
Syntax
clampSize
-
allowDelete
-
structure
Summary
Resizes the overture in function of the parent wall.
Parameters:
-
allowDelete
BooleanSpecifies if we allow the deletion if the size of the wall is to small.
-
structure
FloorStructureThe current floor structure. Must be specified if allowDelete == true.
computePositionOnWallChange
Syntax
computePositionOnWallChange
-
newWall
Summary
Computes the new position of the overture when its parent wall is merged with another one.
Parameters:
-
newWall
WallStructureThe new wall of the overture.
Returns:
The new position.
deserialize
Syntax
Summary
Deserializes the object (from JSON).Parameters:
-
hybrid
ObjectJSON describing the object, built with the method serialize.
Returns:
getAbsolutePos
Syntax
Summary
Returns a pair of elements: the position of the center of the overture and the unit vector of the parent wall.
Returns:
position: BABYLON.Vector3, vector: BABYLON.Vector3 The position and the unit vector.
getAngle
Syntax
Summary
Returns the angle of the overture with the x-axis.
Returns:
The angle.
getAvailableProperties
Syntax
Summary
Returns the user-customizable properties of this overture.
Returns:
Properties.
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:
getMaterial
Syntax
getMaterial
-
name
Summary
Gets a material from the list.
Parameters:
-
name
StringThe name of the material to fetch.
Returns:
The material.
getParentWall
Syntax
Summary
Gets the parent wall of the overture.
Returns:
The parent of the overture.
getPolygon
Syntax
getPolygon
()
BABYLON.Vector2
Summary
Returns the polygon describing the overture.
Returns:
The array of the points of the polygon.
guessSide
Syntax
guessSide
()
Summary
Tries to guess the overture direction given the adjacent rooms situations.
initialize
Syntax
initialize
()
private
Summary
Method called after the loading of the componentprojectOnWall
Syntax
projectOnWall
()
Summary
Projects the position of the overture on its parent wall.
remove
Syntax
remove
-
structure
Summary
Deletes the overture.
Parameters:
-
structure
FloorStructureThe floor from which the engine has to remove the overture.
serialize
Syntax
Summary
Serializes the object (to JSON)Returns:
setMaterial
Syntax
setMaterial
-
material
-
name
Summary
Adds/replaces the material with the given name to the list of materials.
Parameters:
-
material
MaterialThe new material.
-
name
StringThe name of the new material.
setParentWall
Syntax
setParentWall
-
wall
Summary
Sets the parent wall of the overture.
Parameters:
-
wall
WallStructureThe new parent of the overture.
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
hinge
Syntax
hinge
Number
Summary
Defines the side of the overture where the hinges should be displayed (0 = right, 1 = left).
nbCasement
Syntax
nbCasement
Number
Summary
The number of casements. Availables values are 0 , 1 , 2 , 3
plinte
Syntax
plinte
Boolean
Summary
Describes if a base board should be displayed or not. Only for the windows.
position
Syntax
position
BABYLON.Vector2
Summary
Position of the overture.
programmableInstance
Syntax
programmableInstance
BABYLON.Mesh
Summary
The instance of the programmable.
side
Syntax
side
Number
Summary
Defines the side of the room where the hinges should be displayed ( inside / outside of the room ). Availables values are -1 or 1
type
Syntax
type
String
Summary
Type of the overture. Availables values are "Door" , "Window" , "Garage" , "Velux" , "Dormer"