formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Generative Objects
Description
Creates randomized copies of source objects and groups, and places them at random positions on faces of boundary objects
Plugin Prototype
fzrt_error_td fz_surface_scatter(
fzrt_int | windex, |
source_obj_list, | |
fzrt_int | num_source_objs, |
fzrt_int * | source_group_list, |
fzrt_int | num_source_groups, |
surface_obj_list, | |
fzrt_int * | surface_findx_list, |
fzrt_int | num_surface_objs, |
fzrt_int | max_copies, |
surf_scatter_opts, | |
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
surface_obj_list [Input]
Array of objects to be used as surfaces upon which to scatter objects
surface_findx_list [Input]
Array of indices of faces of objects upon which to scatter objects
num_surface_objs [Input]
Number of surface objects
max_copies [Input]
Maximum number of copies of source objects or groups to scatter
surf_scatter_opts [Input, Optional]
surface scatter options. For defaults see fz_surf_scatter_parm_enum
scattered_list [Result]
Entity list of scattered objects and groups
Returns
Error codes
Availability
8.5.0.1
Function Set
Defined in