API Docs for: 2.7.3
Show:

SubSlopeOvertureStructure Class

Extends BaseStructure
Module: Component
Parent Module: Wanaplan

The structure for a subslope overture (dormer, velux... ).

Constructor

SubSlopeOvertureStructure

()

Methods

add

(
  • propertyName
  • value
)
private

Inherited from BaseStructure:

Adds an element to the collection in parameter.

Parameters:

  • propertyName String
    Name of the dictionnary.
  • value Object
    Value to distribute.

Returns:

Returns true if the value is added else returns false.

deserialize

(
  • hybrid
)
Object

Inherited from BaseStructure:

Deserializes the object (from JSON).

Parameters:

  • hybrid Object

    JSON describing the object, built with the method serialize.

Returns:

Object:

The Structure object built from the deserialization

getAbsolutePosition

() Object

Returns the absolute position of this subslope overture.

Returns:

Object:

A nested object whose fields are :

  • position Absolute position (BABYLON.Vector2)
  • vector Always null.

getAvailableProperties

() Array

Obtient les propriétés de l'objet.

Returns:

Array:

Un tableau contenant les différentes propriétés de l'objet.

getElementByName

(
  • name
  • collection
)
Object private

Inherited from BaseStructure:

Gets an element of the collection by its name.

Parameters:

  • name String
    The name of the element to search.
  • collection String
    The name of the collection in which we want to search. If this parameter is not defined, the search is done in all the collection of type array.

Returns:

Object: Returns the needed element if it exists, else returns null.

getFloor

(
  • collection
)
FloorStructure

Inherited from BaseStructure:

Gets the floor referencing this object

Parameters:

  • collection String

    Collection to search within.

Returns:

FloorStructure:

The floor containing this structure, -1 if the object has not been added to any floor collection.

getMaterial

(
  • [name]
)
BABYLON.Material

Gets the current materials.

Parameters:

  • [name] String optional

    If this parameter is provided, only the material of the mesh of this name will be returned.

Returns:

BABYLON.Material:

The material(s). A nested object is returned if no name parameter has been specified.

getParent

()

Returns the parent of this subslopeOverture.

initialize

() private

Inherited from BaseStructure:

Method called after the loading of the component

isTargeted

() Boolean

Tests if the given vector is inside the polygon of the subslope overture.

Returns:

Boolean:

True if the vector lies inside the polygon.

remove

()

Removes the subslope overture from the subslope.

serialize

() Object

Inherited from BaseStructure:

Serializes the object (to JSON)

Returns:

Object: The serialization result, null if nothing is serialized

setMaterial

(
  • material
  • name
)

Sets the material on a specific mesh of the subslope overture.

Parameters:

  • material BABYLON.Material

    The new Material.

  • name String

    The name of the mesh you want to change the material of.

setParent

(
  • subslope
)

Sets the parent of the subslope overture.

Parameters:

to3D

() private

????

update

()

Inherited from BaseStructure:

Generic update method, must be overridden.

updateReferences

(
  • structure
)

Inherited from BaseStructure:

Generic method for rebuilding references after the deserialization. For example : restoring the link between a PointStructure and its parent WallStructure

Parameters:

  • structure wnp.Structure

    Floor Structure to work with

Properties

dormerRoof

Object

Params of the roof of the dormer.

height

Number

Height of the subslopeOverture.

Default: 150

id

Number

Inherited from BaseStructure:

Unique ID for the structure set up automatically

name

String

Inherited from BaseStructure:

Structure name

nbCasement

Number

The number of casements. Availables values are 0 , 1 , 2 , 3

Default: 1

parent

SubSlopeStructure

The subslope where the SubslopeOverture belongs.

polygon

BABYLON.Vector2

The 2D polygon vertices of the subslopeOverture. The length of this array is always 4 at all times.

position

BABYLON.Vector2

Position of the subslopeOverture.

sliding

Boolean

If the subslopeOverture is sliding or not.

Default: false

thickness

Number

Thickness of the subslopeOverture.

Default: 5

type

String

Type of the subslopeOverture. Availables values are "Velux" , "Dormer"

wallThickness

Number

Thickness of the wall of the dormer.

Default: 10

width

Number

Width of the subslopeOverture.

Default: 100