formZ SDK | 5.0 API Reference | Project | Modeling | View Manager

fz_view_parm_enum

Description

View parameters shared by all views.

enum fz_view_parm_enum {

FZ_VIEW_PARM_TYPE,

FZ_VIEW_PARM_NAME,

FZ_VIEW_PARM_VISIBLE,

FZ_VIEW_PARM_GHOST,

FZ_VIEW_PARM_LOCK,

FZ_VIEW_PARM_AREA,

FZ_VIEW_PARM_EYE,

FZ_VIEW_PARM_COI,

FZ_VIEW_PARM_CLIP,

FZ_VIEW_PARM_HITHER,

FZ_VIEW_PARM_YON,

FZ_VIEW_PARM_SPIN,

FZ_VIEW_PARM_UP,

FZ_VIEW_PARM_ANGLES,

FZ_VIEW_PARM_AXONOMETRIC_PROJ,

FZ_VIEW_PARM_ISOMETRIC_ANGLES,

FZ_VIEW_PARM_ISOMETRIC_SCALES,

FZ_VIEW_PARM_OBLIQUE_ANGLE,

FZ_VIEW_PARM_OBLIQUE_SCALE,

FZ_VIEW_PARM_PERSPECTIVE_ANGLE,

FZ_VIEW_PARM_PERSPECTIVE_FOCAL,

FZ_VIEW_PARM_PERSPECTIVE_STRAIGHT,

FZ_VIEW_PARM_PANORAMIC_ANG,

FZ_VIEW_PARM_PANORAMIC_RES };

Members

FZ_VIEW_PARM_TYPE

Type of view.

Type: fz_view_type_enum

Default Value: FZ_VIEW_TYPE_AXONOMETRIC

FZ_VIEW_PARM_NAME

View name (48 characters max).

Type: char*

FZ_VIEW_PARM_VISIBLE

Whether or not the view is visible in the project windows.

Type: fzrt_boolean

Default Value: FALSE

FZ_VIEW_PARM_GHOST

Whether or not the view is ghosted in the project windows.

Type: fzrt_boolean

Default Value: FALSE

FZ_VIEW_PARM_LOCK

Whether or not the view is locked in the project windows.

Type: fzrt_boolean

Default Value: FALSE

FZ_VIEW_PARM_AREA

The image area of the view. Does not apply to Panoramic views.

Type: fz_xy_mm_td

FZ_VIEW_PARM_EYE

Eye point for the view (where the view is looking from)

Type: fz_xyz_td

FZ_VIEW_PARM_COI

Center of interest point for the view (where the view is looking to).

Type: fz_xyz_td

FZ_VIEW_PARM_CLIP

Whether or not the display for the view should be clipped at hither and yon. Not used when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_PANORAMIC.

Type: fzrt_boolean

Default Value: FALSE

FZ_VIEW_PARM_HITHER

Location of the hither plane (depth plane closest to eye) as measured from the eye point. Not used when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_PANORAMIC.

Type: double

FZ_VIEW_PARM_YON

Location of the yon plane (depth plane farthest from eye) as measured from the eye point. Not used when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_PANORAMIC.

Type: double

FZ_VIEW_PARM_SPIN

Tilt of the view looking down the line of sight. Synchronized with FZ_VIEW_PARM_UP. Not used when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_ISOMETRIC || FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_OBLIQUE.

Type: double

FZ_VIEW_PARM_UP

Up vector for the view. Synchronized with FZ_VIEW_PARM_SPIN. Not used when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_ISOMETRIC || FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_OBLIQUE.

Type: fz_xyz_td

FZ_VIEW_PARM_ANGLES

View rotation angles. only valid when FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_AXONOMETRIC || FZ_VIEW_PARM_TYPE == FZ_VIEW_TYPE_PERSPECTIVE.

Type: fz_xyz_td

FZ_VIEW_PARM_AXONOMETRIC_PROJ

Type of axonometric projection.

Type: fz_view_axon_projection_enum

Default Value: FZ_VIEW_AXON_PROJ_NONE

FZ_VIEW_PARM_ISOMETRIC_ANGLES

Angles for isometric view.

Type: fz_xy_td

Default Value: {30.0,60.0}

FZ_VIEW_PARM_ISOMETRIC_SCALES

Scales for isometric view.

Type: fz_xyz_td

Default Value: {1.0,1.0,1.0}

FZ_VIEW_PARM_OBLIQUE_ANGLE

Angle for oblique view.

Type: double

Default Value: 30.0

FZ_VIEW_PARM_OBLIQUE_SCALE

Scale for oblique view.

Type: double

Default Value: 1.0

FZ_VIEW_PARM_PERSPECTIVE_ANGLE

Perspective viewing angle. Synchronized with FZ_VIEW_PARM_PERSPECTIVE_FOCAL.

Type: double

Default Value: 60.0

Range: 0.0 < value <= 178.0

FZ_VIEW_PARM_PERSPECTIVE_FOCAL

Perspective focal length. Synchronized with FZ_VIEW_PARM_PERSPECTIVE_ANGLE.

Type: double

Default Value: 31.177

Range: value >= 0.3141911651

FZ_VIEW_PARM_PERSPECTIVE_STRAIGHT

Whether or not perspective view keeps vertical lines straight.

Type: fzrt_boolean

Default Value: FALSE

FZ_VIEW_PARM_PANORAMIC_ANG

Panoramic view extents (angle).

Type: double

Default Value: 360.0

Range: 0.01 <= value <= 360.0

FZ_VIEW_PARM_PANORAMIC_RES

Panoramic display resolution (in pixels).

Type: fzrt_int

Default Value: 5

Range: 1 <= value <= 256

Availability

5.0.0.0

Example Files

util_views.fsl

Defined in

fz_view_api.h