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

# fz_objt_sweep_parm_enum

Description

Parameter identifiers for a parametric sweep object. Used for the "which" argument of , , and . After creating a sweep object, the source and path objects can be replaced by passing in a new object using the API function. Note, that the same restrictions apply for the new objects as for the ones used to construct the sweep initially. When getting the source/path objects from an existing sweep object via , a copy of the source or 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.

enum fz_objt_sweep_parm_enum {

FZ_OBJT_SWEEP_PARM_SRC_ALIGN,

FZ_OBJT_SWEEP_PARM_FACT_TRIANG,

FZ_OBJT_SWEEP_PARM_CAP_START_ON,

FZ_OBJT_SWEEP_PARM_CAP_END_ON,

FZ_OBJT_SWEEP_PARM_AXL_PERP_TO_PLANE,

FZ_OBJT_SWEEP_PARM_AXL_PLANE_NORM,

FZ_OBJT_SWEEP_PARM_AXL_SRC_SCL_ON,

FZ_OBJT_SWEEP_PARM_AXL_SRC_SCL,

FZ_OBJT_SWEEP_PARM_AXL_SRC_ROT_ON,

FZ_OBJT_SWEEP_PARM_AXL_SRC_ROT,

FZ_OBJT_SWEEP_PARM_2PTH_PSRV_HGT,

FZ_OBJT_SWEEP_PARM_NRBZ_DEG_U,

FZ_OBJT_SWEEP_PARM_NRBZ_DEG_V,

FZ_OBJT_SWEEP_PARM_TYPE,

FZ_OBJT_SWEEP_PARM_MODEL_TYPE,

FZ_OBJT_SWEEP_PARM_SMOOTH_TYPE,

FZ_OBJT_SWEEP_PARM_SRC_OBJ1,

FZ_OBJT_SWEEP_PARM_SRC_OBJ2,

FZ_OBJT_SWEEP_PARM_PTH_OBJ1,

FZ_OBJT_SWEEP_PARM_PTH_OBJ2 };

Members

FZ_OBJT_SWEEP_PARM_SRC_ALIGN

Construction - Source alignment.

Type: fz_objt_sweep_srcalign_enum

Default Value: FZ_OBJT_SWEEP_SRCALIGN_CENTROID

FZ_OBJT_SWEEP_PARM_FACT_TRIANG

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

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_SWEEP_PARM_CAP_START_ON

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

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_SWEEP_PARM_CAP_END_ON

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

Type: fzrt_boolean

Default Value: TRUE

FZ_OBJT_SWEEP_PARM_AXL_PERP_TO_PLANE

Construction and Editing - Axial sweep, perpendicular to plane on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_SWEEP_PARM_AXL_PLANE_NORM

Construction and Editing - Axial sweep, normal direction for perpendicular to plane option .
This parameter is a normalized vector which indicates the perpendicular normal) direction of the plane to which the sweep cross section is held perpendicular, if the Perpendicular To Plane option is used.

Type: fz_xyz_td

FZ_OBJT_SWEEP_PARM_AXL_SRC_SCL_ON

Construction and Editing - Axial sweep, source scale on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_SWEEP_PARM_AXL_SRC_SCL

Construction and Editing - Axial sweep, source scale factor.

Type: fz_xy_td

Default Value: {1.0,1.0}

Range: value > 0.0

FZ_OBJT_SWEEP_PARM_AXL_SRC_ROT_ON

Construction and Editing - Axial sweep, source rotation on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_SWEEP_PARM_AXL_SRC_ROT

Construction and Editing - Axial sweep, source rotation angle.

Type: double

Default Value: 0.0

FZ_OBJT_SWEEP_PARM_2PTH_PSRV_HGT

Construction and Editing - 2 path sweep, preserve height on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_SWEEP_PARM_NRBZ_DEG_U

Construction and Editing - Length degree of nurbz object.

Type: fzrt_int

Default Value: 2

Range: 1 <= value <= 10

FZ_OBJT_SWEEP_PARM_NRBZ_DEG_V

Construction and Editing - Depth degree of nurbz object.

Type: fzrt_int

Default Value: 2

Range: 1 <= value <= 10

FZ_OBJT_SWEEP_PARM_TYPE

Editing - Sweep type.
This is a read only parameter and indicates whether the sweep is an axial, 2 source, 2 path or boundary sweep

Type: fz_objt_sweep_type_enum

FZ_OBJT_SWEEP_PARM_MODEL_TYPE

Editing - Model type.

Type: fz_objt_model_type_enum

FZ_OBJT_SWEEP_PARM_SMOOTH_TYPE

Editing - Smooth type.

Type: fz_objt_smooth_type_enum

FZ_OBJT_SWEEP_PARM_SRC_OBJ1

Editing - Sweep source object 1.
This is the source object for all sweep types.

Type: fz_objt_ptr

FZ_OBJT_SWEEP_PARM_SRC_OBJ2

Editing - Sweep source object 2.
This is the 2nd source object for the 2 source sweep.

Type: fz_objt_ptr

FZ_OBJT_SWEEP_PARM_PTH_OBJ1

Editing - Sweep path object 1.
This is the path object for all sweep types.

Type: fz_objt_ptr

FZ_OBJT_SWEEP_PARM_PTH_OBJ2

Editing - Sweep path object 2.
This is the 2nd path object for the 2 path sweep.

Type: fz_objt_ptr

Availability

5.0.0.0

Example Files

util_objt_cnstr_sweep.fsl

See Also

,, ,,

Defined in

fz_objt_swep_api.h