formZ SDK | 5.0 API Reference | Project | Modeling | Attributes

# fz_objt_attr_add_objt_decal_grp

Description

Adds a new decal group to the decal attribute of an object. If the object does not have a decal attribute an error is returned. A new decal attribute can be created with fz_objt_attr_create_objt_decal. The optional decal_index argument returns the index of the decal group which was added. An error is also returned if there are already 32 decal groups in the attribute, which is the limit.

Plugin Prototype

fzrt_error_td fz_objt_attr_add_objt_decal_grp(

fzrt_int | windex,
fz_objt_ptr | obj,
fz_tag_td * | rmtl_tag,
fzrt_int * | decal_index )

Parameters

windex [Input]

project window index

obj [Input]

object

rmtl_tag [Input]

the tag of the surface associated with the decal.

decal_index [Result, Optional]

The index of the new decal group.

Availability

5.0.0.0

Example Files

util_attr_decal.fsl

See Also

fz_objt_attr_delete_objt_decal_grp, fz_objt_attr_create_objt_decal, fz_objt_attr_clear_objt_decal

Function Set

fz_objt_attr_fset

Defined in

fz_objt_decal_api.h