formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Stair From Path

# fz_objt_pathstair_parm_enum

Description

Parameter identifiers for a parametric stair from path object. Used for the "which" argument of fz_objt_cnstr_pathstair_opts_get,, ,

enum fz_objt_pathstair_parm_enum {

FZ_OBJT_PATHSTAIR_PARM_TILES_ON,

FZ_OBJT_PATHSTAIR_PARM_SIDES_ON,

FZ_OBJT_PATHSTAIR_PARM_RAILS_ON,

FZ_OBJT_PATHSTAIR_PARM_LAND_FRONT_ON,

FZ_OBJT_PATHSTAIR_PARM_LAND_BACK_ON,

FZ_OBJT_PATHSTAIR_PARM_HEIGHT_PER_FLT,

FZ_OBJT_PATHSTAIR_PARM_TRIANG,

FZ_OBJT_PATHSTAIR_PARM_LAYOUT_TYPE,

FZ_OBJT_PATHSTAIR_PARM_JUST,

FZ_OBJT_PATHSTAIR_PARM_STEP_CALC,

FZ_OBJT_PATHSTAIR_PARM_NUM_FLT,

FZ_OBJT_PATHSTAIR_PARM_NUM_STEPS,

FZ_OBJT_PATHSTAIR_PARM_RISER_HEIGHT,

FZ_OBJT_PATHSTAIR_PARM_TREAD_LEN,

FZ_OBJT_PATHSTAIR_PARM_LAND_FRONT_EXT,

FZ_OBJT_PATHSTAIR_PARM_LAND_BACK_EXT,

FZ_OBJT_PATHSTAIR_PARM_BEAM_HEIGHT,

FZ_OBJT_PATHSTAIR_PARM_RAMP_HEIGHT,

FZ_OBJT_PATHSTAIR_PARM_SR_THICK,

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_FLAT,

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_WIDTH,

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_ABOVE,

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_UNDER,

FZ_OBJT_PATHSTAIR_PARM_TILE_HEIGHT,

FZ_OBJT_PATHSTAIR_PARM_TILE_FRONT_EXT,

FZ_OBJT_PATHSTAIR_PARM_TILE_SIDE_EXT,

FZ_OBJT_PATHSTAIR_PARM_RAIL_FLAT,

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_TYPE,

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_TYPE,

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_HEIGHT,

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_DIST,

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_SIZEX,

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_SIZEZ,

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_SIZEX,

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_SIZEY,

FZ_OBJT_PATHSTAIR_PARM_PATH_OBJ,

FZ_OBJT_PATHSTAIR_PARM_TYPE,

FZ_OBJT_PATHSTAIR_PARM_WIDTH,

FZ_OBJT_PATHSTAIR_PARM_HEIGHT };

Members

FZ_OBJT_PATHSTAIR_PARM_TILES_ON

Construction and Editing - Stair tiles on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_SIDES_ON

Construction and Editing - Stair sides on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_RAILS_ON

Construction and Editing - Stair rails on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_LAND_FRONT_ON

Construction and Editing - Stair landing front extension on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_LAND_BACK_ON

Construction and Editing - Stair landing back extension on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_HEIGHT_PER_FLT

Construction and Editing - Stair height per flight.

Type: double

Range: value > 0.0

Default Value: English 144.0 in, Metric 300.0 cm

FZ_OBJT_PATHSTAIR_PARM_TRIANG

Construction and Editing - Stair triangulation on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_LAYOUT_TYPE

Construction and Editing - Stair layout type.

Type: fz_objt_pathstair_layout_enum

Default Value: FZ_OBJT_PATHSTAIR_LAYOUT_CONTINUOUS

FZ_OBJT_PATHSTAIR_PARM_JUST

Construction and Editing - Stair left/right justification.

Type: fz_align_lcr_enum

Default Value: FZ_ALIGN_CENTER

FZ_OBJT_PATHSTAIR_PARM_STEP_CALC

Construction and Editing - Stair step calculation method.

Type: fz_objt_pathstair_calc_enum

Default Value: FZ_OBJT_PATHSTAIR_STEP_CALC_BY_RISER

FZ_OBJT_PATHSTAIR_PARM_NUM_FLT

Construction and Editing - Stair number of flights.

Type: fzrt_int

Range: value >= 1

Default Value: 1

FZ_OBJT_PATHSTAIR_PARM_NUM_STEPS

Construction and Editing - Stair number of steps.

Type: fzrt_int

Range: value >= 1

Default Value: 16

FZ_OBJT_PATHSTAIR_PARM_RISER_HEIGHT

Construction and Editing - Stair riser height.

Type: double

Range: value > 0.0

Default Value: English 8.0 in, Metric 20.0 cm

FZ_OBJT_PATHSTAIR_PARM_TREAD_LEN

Construction and Editing - Stair tread length.

Type: double

Range: value > 0.0

Default Value: English 11.0 in, Metric 25.0 cm

FZ_OBJT_PATHSTAIR_PARM_LAND_FRONT_EXT

Construction and Editing - Stair landing front extension.

Type: double

Range: value > 0.0

Default Value: English 12.0 in, Metric 25.0 cm

FZ_OBJT_PATHSTAIR_PARM_LAND_BACK_EXT

Construction and Editing - Stair landing back extension.

Type: double

Range: value > 0.0

Default Value: English 12.0 in, Metric 25.0 cm

FZ_OBJT_PATHSTAIR_PARM_BEAM_HEIGHT

Construction and Editing - Stair beam height.

Type: double

Range: value > 0.0

Default Value: English 8.0 in, Metric 20.0 cm

FZ_OBJT_PATHSTAIR_PARM_RAMP_HEIGHT

Construction and Editing - Stair beam ramp height.

Type: double

Range: value > 0.0

Default Value: English 10.0 in, Metric 25.0 cm

FZ_OBJT_PATHSTAIR_PARM_SR_THICK

Construction and Editing - Stair steps and riser thickness.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_FLAT

Construction and Editing - Stair sides flat at landing on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_WIDTH

Construction and Editing - Stair side beam width.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_ABOVE

Construction and Editing - Stair side beam extension above.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_SIDE_BEAM_UNDER

Construction and Editing - Stair side beam extension underneath.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_TILE_HEIGHT

Construction and Editing - Stair tile height (thickness).

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_TILE_FRONT_EXT

Construction and Editing - Stair tile front extension.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_TILE_SIDE_EXT

Construction and Editing - Stair tile side extension.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_FLAT

Construction and Editing - Stair railing flat at landing on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_TYPE

Construction and Editing - Stair railing type.

Type: fz_objt_rail_type_enum

Default Value: FZ_OBJT_STAIR_RAIL_TYPE_LINE

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_TYPE

Construction and Editing - Stair railing type.

Type: fz_objt_rail_colm_type_enum

Default Value: FZ_OBJT_STAIR_RCOL_TYPE_LINE

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_HEIGHT

Construction and Editing - Stair railing height.

Type: double

Range: value > 0.0

Default Value: English 36.0 in, Metric 75.0 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_DIST

Construction and Editing - Stair railing distance from edge.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_SIZEX

Construction and Editing - Stair railing cross section width.

Type: double

Range: value > 0.0

Default Value: English 1.0 in, Metric 2.5 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_RAIL_SIZEZ

Construction and Editing - Stair railing cross section height.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_SIZEX

Construction and Editing - Stair railing column cross section width.

Type: double

Range: value > 0.0

Default Value: English 1.0 in, Metric 2.5 cm

FZ_OBJT_PATHSTAIR_PARM_RAIL_COLM_SIZEY

Construction and Editing - Stair railing column cross section height.

Type: double

Range: value > 0.0

Default Value: English 1.0 in, Metric 2.5 cm

FZ_OBJT_PATHSTAIR_PARM_PATH_OBJ

Editing - Stair path object. After creating a stair from path object, the path object itself can be replaced by passing in a new object using the api function. Note, that the same restrictions apply for this object as for the one used to construct the stair initially. When getting this parameter from an existing stair object, a copy of the path is made and passed back. It is the responsibility of the calling function to delete this new object afterwards, using fz_objt_edit_delete_objt.

Type: fz_objt_ptr

FZ_OBJT_PATHSTAIR_PARM_TYPE

Editing - Stair type.

Type: fz_objt_pathstair_type_enum

FZ_OBJT_PATHSTAIR_PARM_WIDTH

Editing - Stair width.

Type: double

Range: value > 0.0

FZ_OBJT_PATHSTAIR_PARM_HEIGHT

Editing - Stair height.

Type: double

Range: value > 0.0

Availability

5.0.0.0

Example Files

util_objt_cnstr_sstr.fsl

See Also

fz_objt_cnstr_pathstair_opts_get, , ,

Defined in

fz_objt_stair_api.h