WallStructure
Summary
Base abstract class for walls. More info can be found in the Wanaplan Wiki.
Constructor
WallStructure
Syntax
WallStructure
()
Summary
Item Index
Methods
- add
- addToStructure
- checkCoherence
- computeDefault
- computeStrong
- computeWeak
- deserialize
- distanceFrom
- distanceFromRect
- draw
- getAllPoints
- getBoundingBox
- getElementByName
- getFloor
- getIntersections
- getLength
- getNearestPoint
- getNearestPointOnAxe
- getNearestPointOnPolygon
- getNearestPointOnRect
- getNearestWall static
- getNormalVector
- getPoints
- getPolygon
- getWallVector
- initialize
- isExternal
- isPointInPolygon
- isPointOn
- isTargeted
- parallelTo
- remove
- reorganizeOnSplit
- serialize
- setPoints
- sortAttached
- splitAtIntersections
- translate
- tryMerge
- update
- updateAttachedPoints
- updateOvertures
- updateReferences
- vectorTo
- weakToStrong
Properties
Methods
add
Syntax
add
-
propertyName -
value
Summary
Adds an element to the collection in parameter.Returns:
addToStructure
Syntax
addToStructure
-
structure
Summary
Adds a wall and its points to a structure.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
checkCoherence
Syntax
checkCoherence
-
structure
Summary
Checks if the object structure contains errors, if so, removes it from the plan.
Parameters:
-
structureFloorStructureThe floor where the object belongs.
computeDefault
Syntax
computeDefault
-
pointIndex
Summary
Computes a flat polygon ending, typically for unconnected walls. See Wanaplan API wiki for more info on wall connection.
Parameters:
-
pointIndexNumberThe index of the ending point, 0 or 1.
computeStrong
Syntax
computeStrong
-
pointIndex
Summary
Computes a polygon ending for two-way connected walls. See Wanaplan API wiki for more info on wall connection.
Parameters:
-
pointIndexNumberThe index of the ending point, 0 or 1.
computeWeak
Syntax
computeWeak
-
pointIndex
Summary
Computes a polygon ending for one-way connected walls. See Wanaplan API wiki for more info on wall connection.
Parameters:
-
pointIndexNumberThe index of the ending point, 0 or 1.
deserialize
Syntax
Summary
Deserializes the object (from JSON).Parameters:
-
hybridObjectJSON describing the object, built with the method serialize.
Returns:
The Structure object built from the deserialization
distanceFrom
Syntax
Summary
Returns the distance from a wall to a point.
Parameters:
-
vectorBABYLON.Vector2Involved point.
Returns:
Distance to this wall.
distanceFromRect
Syntax
Summary
Returns the distance from the given vector to the wall bounding rectangle.
Parameters:
-
vectorBABYLON.Vector2Involved point.
-
[margin=0]Number optionalThe margin we take outside the endings of the wall.
-
structureFloorStructureThe floor structure containing the wall.
Returns:
The distance.
draw
Syntax
draw
-
ctx
Summary
Draws the wall on a canvas.
Parameters:
-
ctxCanvasRenderingContext2D2D canvas context.
getAllPoints
Syntax
Summary
Returns all the points of the wall (endings and attached points) in a specific order.
Parameters:
-
inOrderBooleanOrder (-1 = from ending 0 to 1, 1 = from ending 1 to 0).
Returns:
Array of all the points.
getBoundingBox
Syntax
Summary
Computes the bounding box.
Returns:
Nested object, min : BABYLON.Vector2, max : BABYLON.Vector2
getElementByName
Syntax
Summary
Gets an element of the collection by its name.Parameters:
Returns:
getFloor
Syntax
Summary
Gets the floor referencing this object.
Returns:
The floor containing this structure, -1 if the object has not been added to any floor collection yet.
getIntersections
Syntax
Summary
Returns a list of intersections with the other walls in the same floor. The extremities of the walls are not considered as intersections. The array is returned after sorting the elements by distance from the point 0 of the wall.
Parameters:
-
structureFloorStructureThe floor structure.
Returns:
The intersections as an array of PointStructure.
getNearestPoint
Syntax
getNearestPoint
-
vector -
[margin=0]
Summary
Returns the projection of the given vector on the wall segment.
Parameters:
-
vectorBABYLON.Vector2Involved point.
-
[margin=0]Number optionalThe margin we take outside the endings of the wall.
Returns:
Projected point.
getNearestPointOnAxe
Syntax
getNearestPointOnAxe
-
vector
Summary
Returns the projection of the given vector on the wall axe.
Parameters:
-
vectorBABYLON.Vector2Involved point.
Returns:
Projected point.
getNearestPointOnPolygon
Syntax
getNearestPointOnPolygon
-
vector
Summary
Returns the projection of the given vector on the wall polygon.
Parameters:
-
vectorBABYLON.Vector2Involved point.
Returns:
Projected point.
getNearestPointOnRect
Syntax
getNearestPointOnRect
-
vector -
[margin=0] -
structure
Summary
Returns the projection of the given vector on the wall bounding rectangle.
Parameters:
-
vectorBABYLON.Vector2Involved point.
-
[margin=0]Number optionalThe margin we take outside the endings of the wall.
-
structureFloorStructureThe floor structure containing the wall.
Returns:
Projected point.
getNearestWall
Syntax
Summary
Returns the nearest wall from a given point.
Parameters:
-
vectorBABYLON.Vector2Involved point.
-
structureFloorStructureThe floor structure to check.
Returns:
The nearest wall.
getNormalVector
Syntax
getNormalVector
-
[norm=1]
Summary
Returns an orthogonal vector.
Parameters:
-
[norm=1]Number optionalThe requested norm.
Returns:
Orthogonal vector.
getPoints
Syntax
getPoints
-
[index]
Summary
Gets the endings of the wall.
Parameters:
-
[index]Number optionalIndex of the point.
Returns:
If an index is provided, returns the point of that index. Else returns an array containing the 2 points.
getPolygon
Syntax
getPolygon
()
BABYLON.Vector2
Summary
Returns the polygon of the wall.
Returns:
The wall as a polygon (array of vertices).
getWallVector
Syntax
getWallVector
()
BABYLON.Vector2
Summary
Computes the vector representing the wall. Starts from its point 0, and ends on its point 1.
Returns:
Vector carrying the wall.
initialize
Syntax
initialize
()
private
Summary
Method called after the loading of the componentisExternal
Syntax
Summary
Checks if the wall is part of an external room.
Parameters:
-
[structure]FloorStructure optionalThe floor structure containing the wall
Returns:
True if the wall is external.
isPointInPolygon
Syntax
Summary
Returns true if the point is inside the polygon of the wall.
Parameters:
-
vectorBABYLON.Vector2Involved point.
Returns:
True if the point is inside the polygon.
isPointOn
Syntax
Summary
Checks if a point is on a wall, within a delta incertitude.
Parameters:
-
vectorBABYLON.Vector2Involved point.
-
[delta=1e-5]Number optionalIncertitude.
Returns:
True if the point is on the wall.
isTargeted
Syntax
Summary
Checks if the wall is targeted by the cursor.
Parameters:
-
vectorBABYLON.Vector2The cursor position.
Returns:
True if targeted.
parallelTo
Syntax
Summary
Checks if the wall is parallel to another wall.
Parameters:
-
wallWallStructureOther wall.
Returns:
True if the walls are parallel.
remove
Syntax
remove
-
structure
Summary
Deletes a wall.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
reorganizeOnSplit
Syntax
reorganizeOnSplit
-
structure -
wallList
Summary
Reorganizes the attached walls and the overtures when the wall is splitted into several pieces.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
-
wallListWallStructure[]The resulting pieces of the split.
serialize
Syntax
Summary
Serializes the object (to JSON)Returns:
setPoints
Syntax
setPoints
-
points -
[index]
Summary
Changes the points composing the wall.
Parameters:
-
pointsPointStructure[]Array composed of instances of
PointStructure. OR aPointStructureif the parameterindexis provided. -
[index]Number optionalIndex of the point (0 or 1).
sortAttached
Syntax
sortAttached
()
Summary
Sorts the list of the attached points (point 0 to point 1).
splitAtIntersections
Syntax
splitAtIntersections
-
structure
Summary
Splits the wall, taking other walls as splitters.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
translate
Syntax
translate
-
vector -
[structure]
Summary
Translates the wall.
Parameters:
-
vectorBABYLON.Vector2Translation vector.
-
[structure]FloorStructure optionalFloor structure containing the wall.
tryMerge
Syntax
Summary
Tries to merge the wall with other walls in the same floor.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
Returns:
The resulting wall. Returns the unchanged wall if the method does not manage to merge with something.
update
Syntax
update
()
Summary
Generic update method, must be overridden.updateAttachedPoints
Syntax
updateAttachedPoints
-
structure
Summary
Updates the position of the attached points.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
updateOvertures
Syntax
updateOvertures
-
structure
Summary
Updates the position of the overtures on the wall.
Parameters:
-
structureFloorStructureThe floor structure containing the wall.
updateReferences
Syntax
updateReferences
-
structure
Summary
Updates the wall after deserialization.
Parameters:
-
structureFloorStructureThe floorStructure where the object belong.
vectorTo
Syntax
vectorTo
-
vector
Summary
Returns the vector from the projected point on the wall, to the given point. Direction : wall -> point.
Parameters:
-
vectorBABYLON.Vector2Involved point.
Returns:
The vector.
weakToStrong
Syntax
weakToStrong
-
point -
structure
Summary
Upgrades the connection from weak (attached) to strong (connected).
Parameters:
-
pointPointStructureThe weak point that becomes strong.
-
structurewnp.FloorStructureThe floor structure containing the wall.
Properties
_edgePolygons
Syntax
_edgePolygons
BABYLON.Vector2[2]
Summary
The two polygons surrounding the ends.
attachedPoints
Syntax
attachedPoints
PointStructure[]
Summary
Attached points. See Wanaplan Wiki for more info about the connections between walls.
considerForElevation
Syntax
considerForElevation
Boolean
Summary
Consider or not when computing this floor's height (and therefore top floor elevation). Allows to have overlapping floors (useful for roofs)
Default: true
forceSubslopes
Syntax
forceSubslopes
Boolean
Summary
Flag to enable/disable subslopes on interior walls.
Default: false
instance
Syntax
instance
String
Summary
Class type of the wall. e.g. : 'polygon' for polygonal walls, which are most used in wanaplan.
measureDisplayed
Syntax
measureDisplayed
Boolean
Summary
Flag to enable/disable measure display.
Default: true
measureDist
Syntax
measureDist
Number
Summary
2D distance to display the measures related to this wall.
Default: 15
needsUpdate
Syntax
needsUpdate
Boolean
Summary
Flag that signals if the geometry of the wall must be re-computed.
type
Syntax
type
Number
Summary
Type of the wall. Can be TYPE_NORMAL or TYPE_SEPARATOR. TODO : Must be deleted in future version, this has to be replaced by a class "SeparatorWall" that has its own behaviour.
Default: TYPE_NORMAL