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

# fz_objt_attr_get_face_rmtl

Description

Gets the surface style of a face. If check_obj is TRUE, the object's surface style tag is returned, if the face does not have its own surface style. If check_obj is FALSE and the face does not have its own surface style, -1 is returned as a tag. If display is TRUE, layer override is taken into account. Otherwise, the true face/object attribute is returned. To get what's rendered on the screen, TRUE should be passed for "display" ("check_obj" doesn't matter). To get the real attribute, FALSE should be passed for "check_obj" and "display".

Plugin Prototype

fzrt_error_td fz_objt_attr_get_face_rmtl(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | findx,
fzrt_boolean | check_obj,
fzrt_boolean | display,
fz_tag_td * | rmtl_tag )

Parameters

windex [Input]

project window index

obj [Input]

object

findx [Input]

face index

check_obj [Input]

if TRUE, the function gets the object's surface style tag, if the face does not have its own.

display [Input]

get from display context or attribute

rmtl_tag [Result]

surface style tag

Returns

Error codes

Availability

5.0.0.0

Example Files

util_attr_rmtl.fsl

See Also

fz_objt_attr_get_objt_rmtl,,, fz_objt_attr_clear_face_rmtl,

Function Set

fz_objt_attr_fset

Defined in

fz_objt_attr_api.h