StairCase

public sealed class StairCase

A staircase consisting of a sequence of StairSteps.

Constructors

StairCase

public StairCase(double width, double height, double depth, double rise, StairStep[] steps)

Constructor. Unless you know how to make a valid staircase, I suggest using one of the static CreateXXXX() methods instead.

Parameters:

width (double)
height (double)
depth (double)
rise (double)
steps (StairStep[])

Properties

Depth

public double Depth { get; }

Target depth of steps.

Footprint

public Polyline Footprint { get; }

Get a polyline describing the footprint of the entire staircase.

Height

public double Height { get; }

Height of staircase.

LeftFootprint

public Polyline LeftFootprint { get; }

Get a polyline describing the left side of the footprint.

LeftWalls

public IEnumerable<Polyline> LeftWalls { get; }

Enumerate over the wall outlines alog the left side of the staircase.

RightFootprint

public Polyline RightFootprint { get; }

Get a polyline describing the right side of the footprint.

RightWalls

public IEnumerable<Polyline> RightWalls { get; }

Enumerate over the wall outlines alog the right side of the staircase.

Rise

public double Rise { get; }

The rise between steps.

Steps

public StairStep[] Steps { get; }

All consecutive steps.

Width

public double Width { get; }

Width of steps.

Methods

BackWallAsBrep

public Brep BackWallAsBrep()

Create the trailing drop or back wall of the staircase.

CreateFromPolyline

public static StairCase CreateFromPolyline(Polyline polyline, double width, double height, double depth, FlightFill flightFill, LandingFill landingFill)

Create a new staircase based on a polyline edge.

Parameters:

polyline (Polyline)	Edge of staircase.
width (double)	Width of staircase. Positive values create a staircase on the left of the polyline.
height (double)	Height of staircase.
depth (double)	Ideal depth of steps. Final depth will depend on the exact shape.
flightFill (FlightFill)	Flight shaping method.
landingFill (LandingFill)	Landing shaping method.

FootprintAsBrep

public Brep FootprintAsBrep()

Create a brep of the footprint surface as projected onto Z=0.

FrontWallAsBrep

public Brep FrontWallAsBrep()

Create the leading rise or front wall of the staircase.

LeftWallsAsBrep

public Brep LeftWallsAsBrep()

Create a brep containing all the walls along the right side of the staircase.

RightWallsAsBrep

public Brep RightWallsAsBrep()

Create a brep containing all the walls along the right side of the staircase.

StepsAsBrep

public Brep StepsAsBrep()

Create a brep containing all the steps, rises and platforms making up the top surface of the staircase.

ToBrep

public Brep ToBrep(bool footprint, bool steps, bool walls)

Convert the entire staircase to a brep.

Parameters:

footprint (bool)
steps (bool)
walls (bool)

ToBrep

public Brep ToBrep(double thickness, bool cutBelowGround)

Parameters:

thickness (double)
cutBelowGround (bool)

ToBrep

public Brep ToBrep(double thickness)

Create a staircase with a particular slab thickness.

Parameters:

thickness (double)