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

# fz_attr_decal_parm_enum

Description

Parameter identifiers for the decal attribute. Used for the "which" argument of fz_objt_attr_get_objt_decal_parm and fz_objt_attr_set_objt_decal_parm

enum fz_attr_decal_parm_enum {

FZ_ATTR_DECAL_PARM_NAME,

FZ_ATTR_DECAL_PARM_CENTER_HORIZ,

FZ_ATTR_DECAL_PARM_CENTER_VERT,

FZ_ATTR_DECAL_PARM_MIRROR_HORIZ,

FZ_ATTR_DECAL_PARM_MIRROR_VERT,

FZ_ATTR_DECAL_PARM_FLIP,

FZ_ATTR_DECAL_PARM_SOLID_SIZE,

FZ_ATTR_DECAL_PARM_MAP_TYPE,

FZ_ATTR_DECAL_PARM_ORIGIN,

FZ_ATTR_DECAL_PARM_ROTATION,

FZ_ATTR_DECAL_PARM_SIZE_X,

FZ_ATTR_DECAL_PARM_SIZE_Y,

FZ_ATTR_DECAL_PARM_INF_REPS_X,

FZ_ATTR_DECAL_PARM_INF_REPS_Y,

FZ_ATTR_DECAL_PARM_REPS_X,

FZ_ATTR_DECAL_PARM_REPS_Y,

FZ_ATTR_DECAL_PARM_SCALE_WITH_OBJ,

FZ_ATTR_DECAL_PARM_SIZE_LOCK,

FZ_ATTR_DECAL_PARM_RMTL_TAG,

FZ_ATTR_DECAL_PARM_COLOR_ON,

FZ_ATTR_DECAL_PARM_REFL_ON,

FZ_ATTR_DECAL_PARM_TRANS_ON,

FZ_ATTR_DECAL_PARM_BUMP_ON,

FZ_ATTR_DECAL_PARM_TRANS_OPAQUE_ON,

FZ_ATTR_DECAL_PARM_VISIBLE };

Members

FZ_ATTR_DECAL_PARM_NAME

Decal group name. The name cannot be longer than 32 characters.

Type: char*

FZ_ATTR_DECAL_PARM_CENTER_HORIZ

Center the horizontal tile

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_CENTER_VERT

Center the vertical tile

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_MIRROR_HORIZ

mirror the horizontal tile

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_MIRROR_VERT

Mirror the vertical tile

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_FLIP

Flip the horizontal and vertical direction of the decal

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_SOLID_SIZE

The size of a solid texture used by a decal.

Type: double

Range: value > 0.0

FZ_ATTR_DECAL_PARM_MAP_TYPE

Mapping type. Certain restrictions apply when switching the mapping type of a decal. For more details see fz_objt_attr_set_objt_decal_parm.

Type: fz_map_space_type_enum

FZ_ATTR_DECAL_PARM_ORIGIN

The origin of the decal

Type: fz_xyz_td

Range: 0.0 <= value <= 1.0 if the the mapping type is FZ_MAP_SPACE_PARAMETRIC (only x and y are used). For all other mapping types, the origin parameter specifies a 3D location.

FZ_ATTR_DECAL_PARM_ROTATION

The rotation of the decal in 3d space. The angles are applied in z y x order. FZ_MAP_SPACE_PARAMETRIC does not have a rotation parameter.

Type: fz_xyz_td

FZ_ATTR_DECAL_PARM_SIZE_X

The horizontal size of a decal tile. For FZ_MAP_SPACE_PARAMETRIC the tile size is a factor of the length/depth of the parametric surface. At a factor of 1.0 the decal occupies the surface with one tile. For FZ_MAP_SPACE_FLAT, FZ_MAP_SPACE_CUBIC and the vertical size of FZ_MAP_SPACE_CYLINDER mapping, the tile size is a linear dimension, which must be greater than 0.0. For the horizontal size of FZ_MAP_SPACE_CYLINDER and for FZ_MAP_SPACE_SPHERE the tile size is an angular dimension in the range 0.0 < value < 2PI. The FZ_ATTR_DECAL_PARM_SIZE_X/Y and FZ_ATTR_DECAL_PARM_REPS_X/Y parameters are interdependent. When changing one, the other parameter will automatically be updated.

Type: double

Range: value > 0.0

FZ_ATTR_DECAL_PARM_SIZE_Y

The vertical size of a decal tile.

Type: double

Range: value > 0.0

FZ_ATTR_DECAL_PARM_INF_REPS_X

Use an infinite number of horizontal tile repetitions.

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_INF_REPS_Y

Use an infinite number of vertical tile repetitions.

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_REPS_X

The # of horizontal repetitions of a decal tile if FZ_ATTR_DECAL_PARM_INF_REPS_X is FALSE.

Type: double

Range: value > 0.0

FZ_ATTR_DECAL_PARM_REPS_Y

The # of vertical repetitions of a decal tile if FZ_ATTR_DECAL_PARM_INF_REPS_Y is FALSE.

Type: double

Range: value > 0.0

FZ_ATTR_DECAL_PARM_SCALE_WITH_OBJ

Scale the decal size, when uniform scaling is applied to the object.

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_SIZE_LOCK

The size lock option. Only, None, Square and Current are available.

Type: fz_map_space_size_lock_enum

FZ_ATTR_DECAL_PARM_RMTL_TAG

The surface style tag associated with the decal.

Type: fz_tag_td

FZ_ATTR_DECAL_PARM_COLOR_ON

Use the color component of the decal's surface style

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_REFL_ON

Use the reflection component of the decal's surface style

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_TRANS_ON

Use the transparency component of the decal's surface style

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_BUMP_ON

Use the bump component of the decal's surface style

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_TRANS_OPAQUE_ON

Use the transparency component as an opacity mask (TRUE) or transparency mask (FALSE).

Type: fzrt_boolean

FZ_ATTR_DECAL_PARM_VISIBLE

Is the decal visible (TRUE) or not (FALSE).

Type: fzrt_boolean

Availability

5.0.0.0

Example Files

util_attr_decal.fsl

See Also

fz_objt_attr_get_objt_decal_parm, fz_objt_attr_set_objt_decal_parm, fz_objt_attr_get_objt_decal_parm

Defined in

fz_objt_decal_api.h