formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Helix

# fz_objt_helix_parm_enum

Description

Parameter identifiers for a parametric helix object. Used for the "which" argument of , fz_objt_edit_helix_parm_set, fz_objt_cnstr_helix_opts_get and fz_objt_cnstr_helix_opts_set.

enum fz_objt_helix_parm_enum {

FZ_OBJT_HELIX_PARM_CAP_START,

FZ_OBJT_HELIX_PARM_CAP_END,

FZ_OBJT_HELIX_PARM_FACT_TRIANG,

FZ_OBJT_HELIX_PARM_PATH_SCL_ON,

FZ_OBJT_HELIX_PARM_PATH_SCL,

FZ_OBJT_HELIX_PARM_SRC_SCL_ON,

FZ_OBJT_HELIX_PARM_SRC_SCL,

FZ_OBJT_HELIX_PARM_SRC_ROT_ON,

FZ_OBJT_HELIX_PARM_ROT_1STPT_ON,

FZ_OBJT_HELIX_PARM_SRC_ROT,

FZ_OBJT_HELIX_PARM_CLOCKWISE,

FZ_OBJT_HELIX_PARM_FACT_STEPS,

FZ_OBJT_HELIX_PARM_NRBZ_DEG_U,

FZ_OBJT_HELIX_PARM_TYPE,

FZ_OBJT_HELIX_PARM_MODEL_TYPE,

FZ_OBJT_HELIX_PARM_SMOOTH_TYPE,

FZ_OBJT_HELIX_PARM_SRC_OBJ,

FZ_OBJT_HELIX_PARM_PATH_OBJ,

FZ_OBJT_HELIX_PARM_NCYCLE,

FZ_OBJT_HELIX_PARM_LENGTH,

FZ_OBJT_HELIX_PARM_RADIUS,

FZ_OBJT_HELIX_PARM_AXIS_PNT1,

FZ_OBJT_HELIX_PARM_AXIS_PNT2,

FZ_OBJT_HELIX_PARM_AXIS_REF,

FZ_OBJT_HELIX_PARM_ANGLE };

Members

FZ_OBJT_HELIX_PARM_CAP_START

Construction and Editing - Start cap on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_HELIX_PARM_CAP_END

Construction and Editing - End cap on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_HELIX_PARM_FACT_TRIANG

Construction and Editing - Triangulate on (TRUE) or off (FALSE) for facetted objects.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_PATH_SCL_ON

Construction and Editing - Scale path on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_PATH_SCL

Construction and Editing - Path scale factor. The x field identifies the path width scale factor. The y field stands for the path length scale factor.

Type: fz_xy_td

Default Value: {1.0,1.0}

Range: value > 0.0

FZ_OBJT_HELIX_PARM_SRC_SCL_ON

Construction and Editing - Scale source on/off.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_SRC_SCL

Construction and Editing - Source scale factor.

Type: fz_xy_td

Default Value: {1.0,1.0}

Range: value > 0.0

FZ_OBJT_HELIX_PARM_SRC_ROT_ON

Construction and Editing - Rotate source on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_ROT_1STPT_ON

Construction and Editing - Rotate source around first point on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_SRC_ROT

Construction and Editing - Source rotation angle.

Type: double

Default Value: 0.0

FZ_OBJT_HELIX_PARM_CLOCKWISE

Construction and Editing - Helix direction clockwise on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HELIX_PARM_FACT_STEPS

Construction and Editing - Number of total steps for facetted objects.

Type: fzrt_int

Default Value: 72

Range: value >= (3 * num_cycles)

FZ_OBJT_HELIX_PARM_NRBZ_DEG_U

Construction and Editing - Length degree for smooth nurbz option.

Type: fzrt_int

Default Value: 2

Range: 1 <= value <= 10

FZ_OBJT_HELIX_PARM_TYPE

Editing - Helix type. This is a read only parameter and indicates whether the helix is a solid/surface helix, wire helxi around axis or wire helix around path

Type: fz_objt_helix_type_enum.

FZ_OBJT_HELIX_PARM_MODEL_TYPE

Editing - Model type.

Type: fz_objt_model_type_enum

FZ_OBJT_HELIX_PARM_SMOOTH_TYPE

Editing - Smooth type.

Type: fz_objt_smooth_type_enum

FZ_OBJT_HELIX_PARM_SRC_OBJ

Editing - Helix source object, if object is a solid/surface helix. After creating a solid/surface helix object, the source object itself can be replaced by passing in a new object using the fz_objt_edit_helix_parm_set API function. Note that the same restrictions apply for this object as for the one used to construct the helix initially. When getting this parameter from an existing helix object, a copy of the source 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_HELIX_PARM_PATH_OBJ

Editing - Helix path object, if object is a wire helix along path. After creating a wire helix object, the path object itself can be replaced by passing in a new object using the fz_objt_edit_helix_parm_set API function. Note that the same restrictions apply for this object as for the one used to construct the helix initially. When getting this parameter from an existing helix 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_HELIX_PARM_NCYCLE

Editing - Number of cycles. Equal to the revolution angle / 2PI

Type: double

Range: value > 0.0

FZ_OBJT_HELIX_PARM_LENGTH

Editing - Helix length, if helix is not a wire along path helix.

Type: double

Range: value > 0.0

FZ_OBJT_HELIX_PARM_RADIUS

Editing - Helix radius, if helix is a wire helix.

Type: double

Range: value > 0.0

FZ_OBJT_HELIX_PARM_AXIS_PNT1

Editing - Axis point 1, if helix is not a wire along path helix.

Type: fz_xyz_td

FZ_OBJT_HELIX_PARM_AXIS_PNT2

Editing - Axis point 2, if helix is not a wire along path helix.

Type: fz_xyz_td

FZ_OBJT_HELIX_PARM_AXIS_REF

Editing - Axis reference point, if helix is not a wire along path helix. This is a third point, not located on the axis. It determines, where the helix starts.

Type: fz_xyz_td

FZ_OBJT_HELIX_PARM_ANGLE

Editing - Revolution angle. Equal to the number of cycles * 2PI

Type: double

Range: value > 0.0

Availability

5.0.0.0

See Also

fz_objt_cnstr_helix_opts_get, fz_objt_cnstr_helix_opts_set, , fz_objt_edit_helix_parm_set

Defined in

fz_objt_helx_api.h