formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Torus
Description
Parameter identifiers for a parametric torus object. Used for the "which" argument of , fz_objt_cnstr_tors_opts_set, ,
enum fz_objt_tors_parm_enum {
FZ_OBJT_TORS_PARM_PARTIAL,
FZ_OBJT_TORS_PARM_CAP_TYPE,
FZ_OBJT_TORS_PARM_U_MINMAX,
FZ_OBJT_TORS_PARM_V_MINMAX,
FZ_OBJT_TORS_PARM_MAJOR_RADIUS,
FZ_OBJT_TORS_PARM_MINOR_RADII,
FZ_OBJT_TORS_PARM_ORIGIN,
FZ_OBJT_TORS_PARM_ROTATION };
Members
FZ_OBJT_TORS_PARM_PARTIAL
Construction and Editing - Torus partial on (TRUE) or off (FALSE).
Type: fzrt_boolean
Default Value: FALSE
FZ_OBJT_TORS_PARM_CAP_TYPE
Construction and Editing - Torus closure closure type. ptype fz_objt_prim_cap_type_enum
Default Value: FZ_OBJT_PRIM_CAP_TYPE_AXIAL
FZ_OBJT_TORS_PARM_U_MINMAX
Construction and Editing - Torus horizontal min max. The x value indicates the start of the torus surface in the horizontal direction (around the torus'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 torus, starting at the torus'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_TORS_PARM_V_MINMAX
Construction and Editing - Torus vertical min max. The x value indicates the start of the torus surface in the vertical direction (along the torus's cross section direction). The y value indicates the end. x must be less than y. x = 0.0 means that the torus starts at the horizontal plane. For example, x = 0.5, y = 1.0 defines the lower half (the bottom slice of a bagel), and x = 0.0, y = 0.5 defines the upper half (the part of the bagel with all the poppy seeds on it).
Type: fz_xy_td
Range: 0.0 <= value <= 1.0
Default Value: {0.5,1.0}
FZ_OBJT_TORS_PARM_MAJOR_RADIUS
Editing - Torus major radius. The torus's major radius cannot be less than the torus's minor x radius.
Type: double
Range: value > 0.0
FZ_OBJT_TORS_PARM_MINOR_RADII
Editing - Torus minor radii. The torus's minor x radius cannot be greater than the torus's major radius.
Type: fz_xy_td
Range: value > 0.0
FZ_OBJT_TORS_PARM_ORIGIN
Editing - Torus origin.
Type: fz_xyz_td
FZ_OBJT_TORS_PARM_ROTATION
Editing - Torus rotation. Rotation angles are applied in z y x order to transform the torus from alignment with the world axes to its 3d orientation.
Type: fz_xyz_td
Availability
5.0.0.0
See Also
Defined in