formZ SDK | 5.0 API Reference | Project | Symbols

# fz_symb_def_model_create

Description

Creates a modeling definition level in the given library. The objects for the definition are contained in the src_obj array. If the definition also contains lights, they are defined in the src_lite array. Either array may be passed as NULL, but not both at the same time.
Note, that after creating the definition, the objects/lights are not deleted or ghosted but stay as is.

Plugin Prototype

fzrt_error_td fz_symb_def_model_create(

fzrt_int | windex,
fz_symb_lib_ptr | lib_ptr,
char * | name,
fzrt_int | lev_indx,
fz_objt_ptr * | src_obj,
fzrt_int | num_src,
fz_lite_ptr * | src_lite,
fzrt_int | num_lite,
fz_xyz_td * | origin,
fz_xyz_td * | scale_pt,
fz_symb_def_ptr * | new_def,
fz_symb_lev_ptr * | new_lev )

Parameters

windex [Input]

project window index

lib_ptr [Input]

the library in which the definition is created

name [Input]

the name of the definition. If the name does not exist, a new definition is created. If it already exists, the level will be added to the definition. If the level also exists it will be overwritten. The name cannot contain more than 32 characters.

lev_indx [Input]

the level index

Range: 0 <= lev_indx <= 2

src_obj [Input, Optional]

array with object pointers

num_src [Input, Optional]

number of entries in the src_obj array

src_lite [Input, Optional]

array with light pointers

num_lite [Input, Optional]

number of entries in the src_lite array

origin [Input, Optional]

origin point of the definition level.

Default Value: {0.0, 0.0, 0.0}

scale_pt [Input, Optional]

Handle point of the definition level.

Default Value: the upper right corner of the 3D bounding box of the objects/lights.

new_def [Result, Optional]

definition (new or existing) to which the definition level was added

new_lev [Result, Optional]

new definition level

Returns

Error codes

Availability

5.0.0.0

Example Files

util_symb_test.fsl

Function Set

fz_symb_model_fset

Defined in

fz_symb_api.h