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

# fz_objt_cone_parm_enum

Description

Parameter identifiers for a parametric cone object. Used for the "which" argument of ,, , fz_objt_edit_cone_parm_set

enum fz_objt_cone_parm_enum {

FZ_OBJT_CONE_PARM_PARTIAL,

FZ_OBJT_CONE_PARM_CAP_TYPE,

FZ_OBJT_CONE_PARM_U_MINMAX,

FZ_OBJT_CONE_PARM_RADII,

FZ_OBJT_CONE_PARM_HEIGHT,

FZ_OBJT_CONE_PARM_TRUNCATE,

FZ_OBJT_CONE_PARM_TOPRATIO,

FZ_OBJT_CONE_PARM_ORIGIN,

FZ_OBJT_CONE_PARM_ROTATION };

Members

FZ_OBJT_CONE_PARM_PARTIAL

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

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_CONE_PARM_CAP_TYPE

Construction and Editing - Cone closure type. ptype fz_objt_prim_cap_type_enum

Default Value: FZ_OBJT_PRIM_CAP_TYPE_AXIAL

FZ_OBJT_CONE_PARM_U_MINMAX

Construction and Editing - Cone horizontal min max. The x value indicates the start of the cone surface in the horizontal direction (around the cone's axis). The y value indicates the end. x must be less than y. For example, x = 0.0, y = 0.5 defines a half cone, starting at the cone'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_CONE_PARM_RADII

Editing - Cone radii.

Type: fz_xy_td

Range: value > 0.0

FZ_OBJT_CONE_PARM_HEIGHT

Editing - Cone height.

Type: double

Range: value > 0.0

FZ_OBJT_CONE_PARM_TRUNCATE

Editing - Cone truncated on (TRUE) or off (FALSE). If set to TRUE, the cone will be truncated using the top ratio parameter. If set to FASLE, the cone always has a tip.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_CONE_PARM_TOPRATIO

Editing - Cone top ratio. If set to 0.0, the cone has a tip. For values larger than 0.0, the cone appears truncated. A value of 1.0 creates a cylinder. Values larger than 1.0 create an inverted truncated cone (top is larger than base).

Type: double

Range: value >= 0.0

FZ_OBJT_CONE_PARM_ORIGIN

Editing - Cone origin.

Type: fz_xyz_td

FZ_OBJT_CONE_PARM_ROTATION

Editing - Cylinder rotation. Rotation angles are applied in z y x order to transform the cone from alignment with the world axes to its 3d orientation.

Type: fz_xyz_td

Availability

5.0.0.0

See Also

, , , fz_objt_edit_cone_parm_set

Defined in

fz_objt_prim_api.h