formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Screw/Bolt
Description
Parameter identifiers for a parametric screw object. Used for the "which" argument of , , and .
enum fz_objt_screw_parm_enum {
FZ_OBJT_SCREW_PARM_THRD_BY_DIST,
FZ_OBJT_SCREW_PARM_HAS_TIP,
FZ_OBJT_SCREW_PARM_HAS_NECK,
FZ_OBJT_SCREW_PARM_HAS_HEAD,
FZ_OBJT_SCREW_PARM_CLOCKWISE,
FZ_OBJT_SCREW_PARM_PNTS_PER_CYCLE,
FZ_OBJT_SCREW_PARM_HEAD_TYPE,
FZ_OBJT_SCREW_PARM_SLOT_TYPE,
FZ_OBJT_SCREW_PARM_GAP_FACTOR,
FZ_OBJT_SCREW_PARM_THREAD_DIST,
FZ_OBJT_SCREW_PARM_AXP1,
FZ_OBJT_SCREW_PARM_AXP2,
FZ_OBJT_SCREW_PARM_AXP3,
FZ_OBJT_SCREW_PARM_BODY_LENGTH,
FZ_OBJT_SCREW_PARM_BODY_RADIUS,
FZ_OBJT_SCREW_PARM_NECK_LENGTH,
FZ_OBJT_SCREW_PARM_NECK_RADIUS,
FZ_OBJT_SCREW_PARM_HEAD_LENGTH,
FZ_OBJT_SCREW_PARM_HEAD_RADIUS,
FZ_OBJT_SCREW_PARM_TIP_FACTOR,
FZ_OBJT_SCREW_PARM_THREAD_DEPTH_FACTOR,
FZ_OBJT_SCREW_PARM_THREAD_CYCLES };
Members
FZ_OBJT_SCREW_PARM_THRD_BY_DIST
Construction and Editing - Construct thread by distance on (TRUE) or off (FALSE). If set to FALSE, the number of threads are set explicitly using the FZ_OBJT_SCREW_PARM_THREAD_CYCLES parameter. If set to TRUE, the number of threads are calculated by the thread distance ( FZ_OBJT_SCREW_PARM_THREAD_DIST parameter).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_SCREW_PARM_HAS_TIP
Construction and Editing - Screw tip on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: TRUE
FZ_OBJT_SCREW_PARM_HAS_NECK
Construction and Editing - Screw neck on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: TRUE
FZ_OBJT_SCREW_PARM_HAS_HEAD
Construction and Editing - Screw head on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: TRUE
FZ_OBJT_SCREW_PARM_CLOCKWISE
Construction and Editing - Screw threads run clockwise (TRUE) or counterclockwise (FALSE).
Type: fzrt_boolean
Default Value: TRUE
FZ_OBJT_SCREW_PARM_PNTS_PER_CYCLE
Construction and Editing - # of points per cycle.
Type: fzrt_int
Range: value >= 3
Default Value: 12
FZ_OBJT_SCREW_PARM_HEAD_TYPE
Construction and Editing - Screw head type.
Type: fz_objt_screw_headtype_enum
Default Value: FZ_OBJT_SCREW_HEAD_TYPE_CONIC
FZ_OBJT_SCREW_PARM_SLOT_TYPE
Construction and Editing - Screw slot type.
Type: fz_objt_screw_slottype_enum
Default Value: FZ_OBJT_SCREW_SLOT_TYPE_NONE
FZ_OBJT_SCREW_PARM_GAP_FACTOR
Construction and Editing - Screw thread gap, as factor of distance between two threads.
Type: double
Range: 0.0 < value < 1.0
Default Value: 0.5
FZ_OBJT_SCREW_PARM_THREAD_DIST
Construction and Editing - Distance between two threads.
Type: double
Range: value > 0.0
Default Value: English 8.0 in, Metric 20.0 cm
FZ_OBJT_SCREW_PARM_AXP1
Editing - Screw axis point 1.
Type: fz_xyz_td
FZ_OBJT_SCREW_PARM_AXP2
Editing - Screw axis point 2.
Type: fz_xyz_td
FZ_OBJT_SCREW_PARM_AXP3
Editing - Screw axis point 3. This point needs to be located off the axis and determines where the treads start.
Type: fz_xyz_td
FZ_OBJT_SCREW_PARM_BODY_LENGTH
Editing - Screw body length.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_BODY_RADIUS
Editing - Screw body radius.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_NECK_LENGTH
Editing - Screw neck length.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_NECK_RADIUS
Editing - Screw neck radius.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_HEAD_LENGTH
Editing - Screw head length.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_HEAD_RADIUS
Editing - Screw head radius.
Type: double
Range: value > 0.0
FZ_OBJT_SCREW_PARM_TIP_FACTOR
Editing - Screw tip length as a factor of the body length.
Type: double
Range: 0.0 < value < 1.0
FZ_OBJT_SCREW_PARM_THREAD_DEPTH_FACTOR
Editing - Screw thread depth factor. Thread depth as a factor of the screw's body radius.
Type: double
Range: 0.0 < value < 1.0
FZ_OBJT_SCREW_PARM_THREAD_CYCLES
Editing - Screw number of thread cycles.
Type: fzrt_int rimin 1
Availability
5.0.0.0
Example Files
See Also
, , ,
Defined in