formZ SDK | 5.0 API Reference | Project | Window Manager
Description
Underlay option parameters. Used for the "which" argument of and fz_wind_set_underlay_parm_data.
enum fz_wind_underlay_opts_parm_enum {
FZ_WIND_UNDERLAY_ON,
FZ_WIND_UNDERLAY_VIEW_3D,
FZ_WIND_UNDERLAY_3D_MATCH,
FZ_WIND_UNDERLAY_PROJ_SCALE,
FZ_WIND_UNDERLAY_PROJ_ORIG_H,
FZ_WIND_UNDERLAY_PROJ_ORIG_V,
FZ_WIND_UNDERLAY_PROJ_CENTER,
FZ_WIND_UNDERLAY_OVER_GRID,
FZ_WIND_UNDERLAY_FLOC,
FZ_WIND_UNDERLAY_FREP };
Members
FZ_WIND_UNDERLAY_ON
Indicates the underlay is on.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_UNDERLAY_VIEW_3D
Indicates the underlay will be placed in the 3D views.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_UNDERLAY_3D_MATCH
Indicates the image size and shape will be adjusted to that of the underlay.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_UNDERLAY_PROJ_SCALE
Indicates the size of the underlay image in a projection or drafting window.
Type: double
FZ_WIND_UNDERLAY_PROJ_ORIG_H
Indicates the horizontal alignment of the underlay in a projection or drafting window.
Type: double
FZ_WIND_UNDERLAY_PROJ_ORIG_V
Indicates the vertical alignment of the underlay in a projection or drafting window.
Type: double
FZ_WIND_UNDERLAY_PROJ_CENTER
Indicates the center of the underlay is placed at the origin in a projection or drafting window. Otherwise the top left corner of the underlay is placed at the origin. The origin is defined by FZ_WIND_UNDERLAY_PROJ_ORIG_H and FZ_WIND_UNDERLAY_PROJ_ORIG_V.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_UNDERLAY_OVER_GRID
Indicates the underlay is displayed on top of the reference grid and its axes.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_UNDERLAY_FLOC
Indicates the location of the file used for the underlay.
Type: fzrt_floc_ptr
FZ_WIND_UNDERLAY_FREP
Indicates the location of the file used for the underlay.
Type: fzrt_frep_ptr
Availability
5.0.0.0
Defined in