formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Generative Objects
Description
Parameter identifiers for a surface scatter operation.
enum fz_surf_scatter_parm_enum {
FZ_SURF_SCATTER_PARM_KEEP_COPIES,
FZ_SURF_SCATTER_PARM_SCATTER_INDIVIDUALLY,
FZ_SURF_SCATTER_PARM_DIRECTION,
FZ_SURF_SCATTER_PARM_JUSTIFICATION,
FZ_SURF_SCATTER_PARM_SEPARATE,
FZ_SURF_SCATTER_PARM_SEPARATION,
FZ_SURF_SCATTER_PARM_SETBACK,
FZ_SURF_SCATTER_PARM_USE_SOURCE_AXIS,
FZ_SURF_SCATTER_PARM_USE_SURFACE_NORMAL,
FZ_SURF_SCATTER_PARM_ROTATE_X_RANGE_MIN,
FZ_SURF_SCATTER_PARM_ROTATE_X_RANGE_MAX,
FZ_SURF_SCATTER_PARM_ROTATE_Y_RANGE_MIN,
FZ_SURF_SCATTER_PARM_ROTATE_Y_RANGE_MAX,
FZ_SURF_SCATTER_PARM_ROTATE_Z_RANGE_MIN,
FZ_SURF_SCATTER_PARM_ROTATE_Z_RANGE_MAX,
FZ_SURF_SCATTER_PARM_UNIFORM_SCALE,
FZ_SURF_SCATTER_PARM_SCALE_X_RANGE_MIN,
FZ_SURF_SCATTER_PARM_SCALE_X_RANGE_MAX,
FZ_SURF_SCATTER_PARM_SCALE_Y_RANGE_MIN,
FZ_SURF_SCATTER_PARM_SCALE_Y_RANGE_MAX,
FZ_SURF_SCATTER_PARM_SCALE_Z_RANGE_MIN,
FZ_SURF_SCATTER_PARM_SCALE_Z_RANGE_MAX,
FZ_SURF_SCATTER_PARM_OFFSET_MIN,
FZ_SURF_SCATTER_PARM_OFFSET_MAX,
FZ_SURF_SCATTER_PARM_RANDOM_SEED1,
FZ_SURF_SCATTER_PARM_RANDOM_SEED2 };
Members
FZ_SURF_SCATTER_PARM_KEEP_COPIES
Number of scattered list entities to keep.
Type: fzrt_int
Default Value: 0
FZ_SURF_SCATTER_PARM_SCATTER_INDIVIDUALLY
TRUE indicates that individual objects and groups should be selected from the
source arrays, FALSE indicates that all sources should be scattered as a set
Type: fzrt_boolean
Default Value: TRUE
FZ_SURF_SCATTER_PARM_DIRECTION
Specifies direction in or out with respect to surface normals.
Type: fz_surf_scatter_direction_enum
Default Value: FZ_SURF_SCATTER_DIR_OUT
FZ_SURF_SCATTER_PARM_JUSTIFICATION
Specifies object position, before offset, relative to surface.
Type: fz_surf_scatter_justify_enum
Default Value: FZ_SURF_SCATTER_JUSTIFY_ABOVE
FZ_SURF_SCATTER_PARM_SEPARATE
TRUE indicates that copies should not be allowed to overlap
Type: fzrt_boolean
Default Value: TRUE
FZ_SURF_SCATTER_PARM_SEPARATION
Minimum distance allowed between object copies
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SETBACK
Limits the scatter so that objects will be be placed no closer to a boundary or face
edge than the specified distance.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_USE_SOURCE_AXIS
TRUE indicates the Z-axis of each of the scattered objects is aligned before rotation of
object, FALSE indicates that source orientation is used.
Type: fzrt_boolean
Default Value: TRUE
FZ_SURF_SCATTER_PARM_USE_SURFACE_NORMAL
TTRUE indicates that scattered objects are initially aligned to the normal of the surface,
FALSE indicates that the Cartesian Z-axis is used.
Type: fzrt_boolean
Default Value: TRUE
FZ_SURF_SCATTER_PARM_ROTATE_X_RANGE_MIN
Allow random rotation around X axis, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_ROTATE_X_RANGE_MAX
Allow random rotation around X axis, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_ROTATE_Y_RANGE_MIN
Allow random rotation around Y axis, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_ROTATE_Y_RANGE_MAX
Allow random rotation around Y axis, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_ROTATE_Z_RANGE_MIN
Allow random rotation around Z axis, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_ROTATE_Z_RANGE_MAX
Allow random rotation around Z axis, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_UNIFORM_SCALE
TRUE indicates that relative dimensions of the scattered objects should be maintained.
Type: fzrt_boolean
Default Value: FALSE
FZ_SURF_SCATTER_PARM_SCALE_X_RANGE_MIN
Allow random scale in X direction, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SCALE_X_RANGE_MAX
Allow random scale in X direction, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SCALE_Y_RANGE_MIN
Allow random scale in Y direction, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SCALE_Y_RANGE_MAX
Allow random scale in Y direction, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SCALE_Z_RANGE_MIN
Allow random scale in Z direction, min value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_SCALE_Z_RANGE_MAX
Allow random scale in Z direction, max value.
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_OFFSET_MIN
Minimum random translation along the placement axis..
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_OFFSET_MAX
Maximum random translation along the placement axis..
Type: double
Default Value: 0.0
FZ_SURF_SCATTER_PARM_RANDOM_SEED1
Number used to initialize random number generation.
A different seed produces different scattering results.
Type: fzrt_int
FZ_SURF_SCATTER_PARM_RANDOM_SEED2
Number used to initialize random number generation.
A different seed produces different scattering results.
Type: fzrt_int
Availability
8.5.0.1
Defined in