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

# fz_objt_revolve_parm_enum

Description

Parameter identifiers for a parametric revolved object. Used for the "which" argument of fz_objt_edit_revolve_parm_get, fz_objt_edit_revolve_parm_set, fz_objt_cnstr_revolve_opts_get and fz_objt_cnstr_revolve_opts_set.

enum fz_objt_revolve_parm_enum {

FZ_OBJT_REVOLVE_PARM_CAP_START_ON,

FZ_OBJT_REVOLVE_PARM_CAP_END_ON,

FZ_OBJT_REVOLVE_PARM_FACT_STEPS,

FZ_OBJT_REVOLVE_PARM_FACT_REM_COPL_ON,

FZ_OBJT_REVOLVE_PARM_FACT_TRIANG_ON,

FZ_OBJT_REVOLVE_PARM_FACT_ADJ_ENDS_ON,

FZ_OBJT_REVOLVE_PARM_NRBZ_DEG_U,

FZ_OBJT_REVOLVE_PARM_MODEL_TYPE,

FZ_OBJT_REVOLVE_PARM_SMOOTH_TYPE,

FZ_OBJT_REVOLVE_PARM_AXIS_PNT1,

FZ_OBJT_REVOLVE_PARM_AXIS_PNT2,

FZ_OBJT_REVOLVE_PARM_ANGLE,

FZ_OBJT_REVOLVE_PARM_SRC_OBJ,

FZ_OBJT_REVOLVE_PARM_CLOCKWISE };

Members

FZ_OBJT_REVOLVE_PARM_CAP_START_ON

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

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_REVOLVE_PARM_CAP_END_ON

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

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_REVOLVE_PARM_FACT_STEPS

Construction and Editing - Number of steps for facetted objects.

Type: fzrt_int

Default Value: 16

Range: value >= 3

FZ_OBJT_REVOLVE_PARM_FACT_REM_COPL_ON

Construction and Editing - Remove coplanar faces on (TRUE) or off (FALSE) for facetted objects.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_REVOLVE_PARM_FACT_TRIANG_ON

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

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_REVOLVE_PARM_FACT_ADJ_ENDS_ON

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

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_REVOLVE_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_REVOLVE_PARM_MODEL_TYPE

Editing - Model type.

Type: fz_objt_model_type_enum

FZ_OBJT_REVOLVE_PARM_SMOOTH_TYPE

Editing - Smooth type.

Type: fz_objt_smooth_type_enum

FZ_OBJT_REVOLVE_PARM_AXIS_PNT1

Editing - Axis point 1.

Type: fz_xyz_td

FZ_OBJT_REVOLVE_PARM_AXIS_PNT2

Editing - Axis point 2.

Type: fz_xyz_td

FZ_OBJT_REVOLVE_PARM_ANGLE

Construction and Editing - Angle of revolution. A zero angle is not allowed.

Type: double

Range: -2PI <= value <= 2PI, but not 0.0

FZ_OBJT_REVOLVE_PARM_SRC_OBJ

Editing - Revolve source object. After creating a revolved object, the source object itself can be replaced by passing in a new object using the fz_objt_edit_revolve_parm_set api function. Note, that the same restrictions apply for this object as for the one used to construct the revolved object initially. When getting this parameter from an existing revolved 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_REVOLVE_PARM_CLOCKWISE

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

Type: fzrt_boolean

Default Value: FALSE

Availability: 5.5.0.0

Availability

5.0.0.0

Example Files

util_objt_cnstr_revl.fsl

See Also

fz_objt_cnstr_revolve_opts_get, fz_objt_cnstr_revolve_opts_set, fz_objt_edit_revolve_parm_get, fz_objt_edit_revolve_parm_set

Defined in

fz_objt_revl_api.h