formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Spiral Stair
Description
Parameter identifiers for a parametric spiral stair object. Used for the "which" argument of ,, fz_objt_edit_spirstair_parm_get, fz_objt_edit_spirstair_parm_set
enum fz_objt_spirstair_parm_enum {
FZ_OBJT_SPIRSTAIR_PARM_STEP_CALC,
FZ_OBJT_SPIRSTAIR_PARM_ANGLE_CALC,
FZ_OBJT_SPIRSTAIR_PARM_TRIANG,
FZ_OBJT_SPIRSTAIR_PARM_TILES_ON,
FZ_OBJT_SPIRSTAIR_PARM_SIDES_ON,
FZ_OBJT_SPIRSTAIR_PARM_RAILS_ON,
FZ_OBJT_SPIRSTAIR_PARM_PNTS_PER_STEP,
FZ_OBJT_SPIRSTAIR_PARM_NUM_STEPS,
FZ_OBJT_SPIRSTAIR_PARM_RISER_HEIGHT,
FZ_OBJT_SPIRSTAIR_PARM_TOTAL_ANGLE,
FZ_OBJT_SPIRSTAIR_PARM_STEP_ANGLE,
FZ_OBJT_SPIRSTAIR_PARM_STEP_WIDTH,
FZ_OBJT_SPIRSTAIR_PARM_SIDE_BEAM_WIDTH,
FZ_OBJT_SPIRSTAIR_PARM_SIDE_BEAM_ABOVE,
FZ_OBJT_SPIRSTAIR_PARM_SIDE_BEAM_UNDER,
FZ_OBJT_SPIRSTAIR_PARM_TILE_HEIGHT,
FZ_OBJT_SPIRSTAIR_PARM_TILE_FRONT_EXT,
FZ_OBJT_SPIRSTAIR_PARM_TILE_SIDE_EXT,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_OUT_PER_SEG,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_IN_PER_SEG,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_RAIL_TYPE,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_TYPE,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_RAIL_HEIGHT,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_RAIL_DIST,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_RAIL_SIZEX,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_RAIL_SIZEZ,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_SIZEX,
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_SIZEY,
FZ_OBJT_SPIRSTAIR_PARM_AXP1,
FZ_OBJT_SPIRSTAIR_PARM_AXP2,
FZ_OBJT_SPIRSTAIR_PARM_AXP3,
FZ_OBJT_SPIRSTAIR_PARM_INSIDE_RADIUS,
FZ_OBJT_SPIRSTAIR_PARM_OUTSIDE_RADIUS,
FZ_OBJT_SPIRSTAIR_PARM_HEIGHT,
FZ_OBJT_SPIRSTAIR_PARM_CLOCKWISE };
Members
FZ_OBJT_SPIRSTAIR_PARM_STEP_CALC
Construction and Editing - Spiral Stair step calculation method.
Type: fz_objt_spirstair_calc_enum
Default Value: FZ_OBJT_SPIRSTAIR_STEP_CALC_BY_RISER
FZ_OBJT_SPIRSTAIR_PARM_ANGLE_CALC
Construction and Editing - Spiral Stair angle calculation method.
Type: fz_objt_spirstair_angcalc_enum
Default Value: FZ_OBJT_SPIRSTAIR_ANGL_CALC_BY_TOTAL
FZ_OBJT_SPIRSTAIR_PARM_TRIANG
Construction and Editing - Spiral Stair triangulation on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_PARM_TILES_ON
Construction and Editing - Spiral Stair tiles on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_PARM_SIDES_ON
Construction and Editing - Spiral Stair sides on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_PARM_RAILS_ON
Construction and Editing - Spiral Stair railing on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_PARM_PNTS_PER_STEP
Construction and Editing - Spiral Stair # of points per step.
Type: fzrt_int
Range: value >= 1
Default Value: 3
FZ_OBJT_SPIRSTAIR_PARM_NUM_STEPS
Construction and Editing - Spiral Stair # of steps. Used in the riser height calculation.
Type: fzrt_int
Range: value >= 1
Default Value: 20
FZ_OBJT_SPIRSTAIR_PARM_RISER_HEIGHT
Construction and Editing - Spiral Stair riser height. Used in the riser height calculation.
Type: double
Range: value > 0.0
Default Value: English 5.0 in, Metric 15.0 cm
FZ_OBJT_SPIRSTAIR_PARM_TOTAL_ANGLE
Construction and Editing - Spiral Stair total angle.
Type: double
Range: value > 0.0
Default Value: 2PI (360 degrees)
FZ_OBJT_SPIRSTAIR_PARM_STEP_ANGLE
Construction and Editing - Spiral Stair angle per step. Used in the length calculation.
Type: double
Range: value > 0.0
Default Value: PI / 10.0 (18 degrees)
FZ_OBJT_SPIRSTAIR_PARM_STEP_WIDTH
Construction and Editing - Spiral Stair step width.
Type: double
Range: value > 0.0
Default Value: English 18.0 in, Metric 45.0 cm
FZ_OBJT_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_PARM_RAIL_COLM_OUT_PER_SEG
Construction and Editing - Stair railing position outside. If set to TRUE, the option means : per segment. If set to FALSE, the option means : per step.
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_PARM_RAIL_COLM_IN_PER_SEG
Construction and Editing - Stair railing position inside. If set to TRUE, the option means : per segment. If set to FALSE, the option means : per step.
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_PARM_RAIL_RAIL_DIST
Construction and Editing - Stair railing Stair railing distance from edge.
Type: double
Range: value > 0.0
Default Value: English 4.0 in, Metric 10.0 cm
FZ_OBJT_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_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_SPIRSTAIR_PARM_AXP1
Editing - Spiral Stair axis point #1. This is the first (lower) point of the spiral stair axis.
Type: fz_xyz_td
FZ_OBJT_SPIRSTAIR_PARM_AXP2
Editing - Spiral Stair axis point #2. This is the second (higher) point of the spiral stair axis.
Type: fz_xyz_td
FZ_OBJT_SPIRSTAIR_PARM_AXP3
Editing - Spiral Stair axis point #3. This is the third point of the spiral stair axis. It must be off the axis and determines where the first step is located.
Type: fz_xyz_td
FZ_OBJT_SPIRSTAIR_PARM_INSIDE_RADIUS
Editing - Spiral Stair inside radius. The inside radius must be less than the outside radius.
Type: double
Range: value > 0.0
FZ_OBJT_SPIRSTAIR_PARM_OUTSIDE_RADIUS
Editing - Spiral Stair outside radius. The outside radius must be greater than the inside radius.
Type: double
Range: value > 0.0
FZ_OBJT_SPIRSTAIR_PARM_HEIGHT
Editing - Spiral Stair height.
Type: double
Range: value > 0.0
FZ_OBJT_SPIRSTAIR_PARM_CLOCKWISE
Editing - Spiral Stair direction is clockwise (TRUE) or counterclockwise (FALSE).
Type: fzrt_boolean
Default Value: FALSE
Availability
5.0.0.0
Example Files
See Also
, , fz_objt_edit_spirstair_parm_get, fz_objt_edit_spirstair_parm_set
Defined in