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

# fz_volume_scatter

Description

Creates randomized copies of source objects and groups, and places them at random positions within the volumes of boundary objects

Plugin Prototype

fzrt_error_td fz_volume_scatter(

fzrt_int | windex,
fz_objt_ptr * | source_obj_list,
fzrt_int | num_source_objs,
fzrt_int * | source_group_list,
fzrt_int | num_source_groups,
fz_objt_ptr * | boundary_obj_list,
fzrt_int | num_boundary_objs,
fzrt_int | max_copies,
fz_volm_scatter_opts_ptr | volm_scatter_opts,
fz_enty_list_ptr | scattered_list )

Parameters

windex [Input]

Project window index

source_obj_list [Input]

Array of objects from which copies will be scattered

num_source_objs [Input]

Number of source objects

source_group_list [Input]

Array of groups from which copies will be scattered

num_source_groups [Input]

Number of source groups

boundary_obj_list [Input]

Array of objects to be used as volumes in which to scatter objects

num_boundary_objs [Input]

Number of boundary objects

max_copies [Input]

Maximum number of copies of source objects or groups to scatter

volm_scatter_opts [Input, Optional]

Volume scatter options. For defaults see fz_volm_scatter_parm_enum

scattered_list [Result]

Entity list of scattered objects and groups

Returns

Error codes

Availability

8.5.0.1

Function Set

fz_model_fset

Defined in

fz_objt_gend_api.h