Package com.solibri.smc.api.model.components

Interface Door

All Superinterfaces:

Component

public interface Door
extends Component

Door entity represents doors in IFC models.

Since:

9.10.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Door.OperationType	Describes the opening operation and direction of a door.

Method Summary

Modifier and Type	Method	Description
Footprint	getFootprint()	Calculates the footprint for this door based on the assumption that the expected footprint the caller wants is calculated based on positioning of the door inside a wall and an opening.
Footprint	getFootPrintForOpenedDoor()	Calculates the footprint this door covers as open and as closed.
Footprint	getGeometricalFootprint()	Calculates the footprint for the door based on the actual geometry of the door.
Door.OperationType	getOperationType()	Returns the operation type of the door (see Door.OperationType).
double	getOverallHeight()	Returns the overall height of the door.
double	getOverallWidth()	Returns the overall width of the door.
Vector3d	getReferenceDirection()	Returns a direction vector of unit length that defines the hinge side and opening direction of the door.

Methods inherited from interface com.solibri.smc.api.model.Component

distance, distance, equals, getBATID, getBottomElevationFromFloor, getBoundingBox, getBoundingBoxHeight, getBoundingBoxLength, getBoundingBoxWidth, getBuilding, getComponentName, getComponentType, getConstructionType, getDescriptionText, getDisciplineName, getDistanceToNextFloor, getElementType, getFederatedFloor, getFloor, getFunctionalSystems, getGeometryType, getGlobalBottomElevation, getGlobalCoordinate, getGlobalTopElevation, getGroups, getGUID, getHyperlinks, getIfcEntityType, getIfcType, getInformation, getInformationAsString, getIntersections, getMaterials, getModel, getName, getObjectType, getParametricInformationAsString, getPredefinedType, getProfile, getPropertySets, getPropertySets, getPropertyValue, getRelated, getResolvedPredefinedType, getSite, getTopElevationFromFloor, getTriangleMesh, getTypeName, horizontalDistance, horizontalDistance, isOnBuildingEnvelope, projectionOnXYPlaneDistance, projectionOnXYPlaneDistance, verticalDistance, verticalDistance

Method Details

getFootprint

Footprint getFootprint()

Calculates the footprint for this door based on the assumption that the expected footprint the caller wants is calculated based on positioning of the door inside a wall and an opening. Footprint is calculated by extending the door to the intersection of the wall and an opening inside it. If there is no opening or wall found around the door, the calculation falls back to the default footprint calculation and is equal to getGeometricalFootprint.

Specified by:

getFootprint in interface Component

Returns:

the footprint

getFootPrintForOpenedDoor

Footprint getFootPrintForOpenedDoor()

Calculates the footprint this door covers as open and as closed. The returned results might be cached and reused. For example, for a normal swinging door with one hinge, the resulting area would usually resemble a quarter of a circle.

Returns:

the footprint

getGeometricalFootprint

Footprint getGeometricalFootprint()

Calculates the footprint for the door based on the actual geometry of the door. This matches the way footprints are calculated by default for entities.

Returns:

the footprint

getReferenceDirection

Vector3d getReferenceDirection()

Returns a direction vector of unit length that defines the hinge side and opening direction of the door.

For example, if a door is defined to open to the left, then the hinge is on the left side when looking in the reference direction. The reference direction of a door corresponds to the y-axis used in IFCDoor.

Returns:

a direction vector of unit length that defines the hinge side and opening direction of the door

Since:

9.10.2

getOverallWidth

double getOverallWidth()

Returns the overall width of the door. The overall width is the width required to contain the whole door.

Returns:

the width of the door

Since:

9.10.2

getOverallHeight

double getOverallHeight()

Returns the overall height of the door. The overall height is the height required to contain the whole door.

Returns:

the height of the door

Since:

9.10.2

getOperationType

Door.OperationType getOperationType()

Returns the operation type of the door (see Door.OperationType).

Returns:

the operation type of the door

Since:

9.10.2