Interface StairStep
-
public interface StairStep
The StairStep interface provides 2D geometric information about the top stair step shape. This can be retrieved through theStairFlight
interface.- Since:
- 9.10.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description double
getAngle()
Returns the angle (in radians) between the front and back edge of the non-covered footprint of the step element.double
getElevation()
Returns the elevation of the step element.MPolygon2d
getFootprint()
Returns the footprint of the stair step element.double
getLength()
Returns the length of the step element.double
getLength(double treadDistance)
Returns the length of the step element.MPolygon2d
getNotCoveredFootprintPolygon()
Returns the not covered footprint of the stair step element.boolean
isWinder()
Returns true if the step is a winder.
-
-
-
Method Detail
-
getFootprint
MPolygon2d getFootprint()
Returns the footprint of the stair step element.- Returns:
- the footprint
- Since:
- 9.10.2
-
getNotCoveredFootprintPolygon
MPolygon2d getNotCoveredFootprintPolygon()
Returns the not covered footprint of the stair step element.- Returns:
- the not covered footprint
- Since:
- 9.10.2
-
getElevation
double getElevation()
Returns the elevation of the step element.- Returns:
- the elevation
- Since:
- 9.10.2
-
getLength
double getLength()
Returns the length of the step element. The length is calculated from the middle of the step element, between the front and back edges of the not covered footprint of the step element.- Returns:
- the length
- Since:
- 9.10.2
-
getLength
double getLength(double treadDistance)
Returns the length of the step element. The length is calculated attreadDistance
from the narrower side of the step.- Parameters:
treadDistance
- the tread distance- Returns:
- the length
- Since:
- 9.10.2
-
getAngle
double getAngle()
Returns the angle (in radians) between the front and back edge of the non-covered footprint of the step element.- Returns:
- angle
- Since:
- 9.10.2
-
isWinder
boolean isWinder()
Returns true if the step is a winder. The step element is considered to be a winder, if the step is narrower on one side than the other.- Returns:
- true, if the step is winder, false otherwise
- Since:
- 9.10.2
-
-