formZ SDK | 5.0 API Reference | Project | File Formats | Structured File Translator

# fz_ffmt_data_model_import_cmpt

Description

Creates a symbol definition. This function places the symbol definition in the library specified by the symbol options. It also transforms the definition as defined by the transform options and the file and formZ units options.

Plugin Prototype

fzrt_error_td fz_ffmt_data_model_import_cmpt(

fzrt_int | windex,
fz_ffmt_ref_td | ffmt_id,
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_mat4x4_td * | mat,
fz_xyz_td * | origin,
fz_xyz_td * | scale_pt,
fz_tag_td * | new_cmpt_tag )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

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

mat [Input, Optional]

A 4x4 matrix to transform all imported objects by. If not NULL, this matrix is concatenated with the tform matrix (from tform opts and the units scaling). The resulting matrix is applied to all imported symbol definition objects. If NULL, only the tform and units scaling are applied to all imported symbol definition objects.

origin [Input, Optional]

origin point of the definition level. This should be specified in the file's coordinate .

Default Value: {0.0, 0.0, 0.0}

scale_pt [Input, Optional]

Handle point of the definition level. This should be specified in the file's coordinate .

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

new_cmpt_tag [Result, Optional]

new component level

Returns

TRUE if the symbol is referenced by a symbol instance object in the project. FALSE otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_data_model_fset

Defined in

fz_ffmt_api.h