formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Generative Objects

# fz_volm_scatter_parm_enum

Description

Parameter identifiers for a volume scatter operation.

enum fz_volm_scatter_parm_enum {

FZ_VOLM_SCATTER_PARM_KEEP_COPIES,

FZ_VOLM_SCATTER_PARM_SCATTER_INDIVIDUALLY,

FZ_VOLM_SCATTER_PARM_SEPARATE,

FZ_VOLM_SCATTER_PARM_SEPARATION,

FZ_VOLM_SCATTER_PARM_ROTATE_X_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_ROTATE_X_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_ROTATE_Y_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_ROTATE_Y_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_ROTATE_Z_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_ROTATE_Z_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_UNIFORM_SCALE,

FZ_VOLM_SCATTER_PARM_SCALE_X_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_SCALE_X_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_SCALE_Y_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_SCALE_Y_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_SCALE_Z_RANGE_MIN,

FZ_VOLM_SCATTER_PARM_SCALE_Z_RANGE_MAX,

FZ_VOLM_SCATTER_PARM_RANDOM_SEED1,

FZ_VOLM_SCATTER_PARM_RANDOM_SEED2 };

Members

FZ_VOLM_SCATTER_PARM_KEEP_COPIES

Number of scattered list entities to keep.

Type: fzrt_int

Default Value: 0

FZ_VOLM_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_VOLM_SCATTER_PARM_SEPARATE

TRUE indicates that copies should not be allowed to overlap

Type: fzrt_boolean

Default Value: TRUE

FZ_VOLM_SCATTER_PARM_SEPARATION

Minimum distance allowed between object copies

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_X_RANGE_MIN

Allow random rotation around X axis, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_X_RANGE_MAX

Allow random rotation around X axis, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_Y_RANGE_MIN

Allow random rotation around Y axis, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_Y_RANGE_MAX

Allow random rotation around Y axis, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_Z_RANGE_MIN

Allow random rotation around Z axis, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_ROTATE_Z_RANGE_MAX

Allow random rotation around Z axis, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_UNIFORM_SCALE

TRUE indicates that relative dimensions of the scattered objects should be maintained.

Type: fzrt_boolean

Default Value: FALSE

FZ_VOLM_SCATTER_PARM_SCALE_X_RANGE_MIN

Allow random scale in X direction, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_SCALE_X_RANGE_MAX

Allow random scale in X direction, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_SCALE_Y_RANGE_MIN

Allow random scale in Y direction, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_SCALE_Y_RANGE_MAX

Allow random scale in Y direction, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_SCALE_Z_RANGE_MIN

Allow random scale in Z direction, min value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_SCALE_Z_RANGE_MAX

Allow random scale in Z direction, max value.

Type: double

Default Value: 0.0

FZ_VOLM_SCATTER_PARM_RANDOM_SEED1

Number used to initialize random number generation.
A different seed produces different scattering results.

Type: fzrt_int

FZ_VOLM_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

fz_objt_gend_api.h