formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Double Hyperboloid

# fz_objt_hbl2_parm_enum

Description

Parameter identifiers for a parametric double hyperboloid object. Used for the "which" argument of , fz_objt_cnstr_hbl2_opts_set, , fz_objt_edit_hbl2_parm_set

enum fz_objt_hbl2_parm_enum {

FZ_OBJT_HBL2_PARM_PARTIAL,

FZ_OBJT_HBL2_PARM_CAP_TYPE,

FZ_OBJT_HBL2_PARM_U_MINMAX,

FZ_OBJT_HBL2_PARM_RADII,

FZ_OBJT_HBL2_PARM_HEIGHT,

FZ_OBJT_HBL2_PARM_HALF_ONLY,

FZ_OBJT_HBL2_PARM_ORIGIN,

FZ_OBJT_HBL2_PARM_ROTATION };

Members

FZ_OBJT_HBL2_PARM_PARTIAL

Construction and Editing - Double hyperboloid partial on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HBL2_PARM_CAP_TYPE

Construction and Editing - Double hyperboloid closure closure type. ptype fz_objt_prim_cap_type_enum

Default Value: FZ_OBJT_PRIM_CAP_TYPE_AXIAL

FZ_OBJT_HBL2_PARM_U_MINMAX

Construction and Editing - Double hyperboloid horizontal min max. The x value indicates the start of the double hyperboloid surface in the horizontal direction (around the double hyperboloid's center axis). The y value indicates the end. x must be less than y. For example, x = 0.0, y = 0.5 defines a half double hyperboloid, starting at the double hyperboloid's local positive x axis, going counterclockwise, ending at the negative x axis.

Type: fz_xy_td

Range: 0.0 <= value <= 1.0

Default Value: {0.0,1.0}

FZ_OBJT_HBL2_PARM_RADII

Editing - Double hyperboloid radii.

Type: fz_xy_td

Range: value > 0.0

FZ_OBJT_HBL2_PARM_HEIGHT

Editing - Double hyperboloid height.

Type: double

Range: value > 0.0

FZ_OBJT_HBL2_PARM_HALF_ONLY

Editing - Half Only Option on (TRUE) or off (FALSE). If set to TRUE, the Double hyperboloid will be of single volume If set to FASLE, the Double hyperboloid will be of two volumes.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_HBL2_PARM_ORIGIN

Editing - Double hyperboloid origin.

Type: fz_xyz_td

FZ_OBJT_HBL2_PARM_ROTATION

Editing - Double hyperboloid rotation. Rotation angles are applied in z y x order to transform the double hyperboloid from alignment with the world axes to it's 3d orientation.

Type: fz_xyz_td

Availability

5.5.0.0

See Also

, fz_objt_cnstr_hbl2_opts_set

Defined in

fz_objt_prim_api.h