formZ SDK | 5.0 API Reference | Project | Modeling | Selection (Pick)

# fz_model_pick_axis

Description

Picks a graphical axis line. Tests to see if the specified click point (screen location) is on an Axis line. This pick is not added to the pick buffer, hence, this function can only be used in post-pick applications. When pick_world != NULL, the world axis line are checked. When pick_plane != NULL, the reference plane axis line are checked. When pick_world != NULL && pick_plane != NULL, both axis lines are checked and the closest to the screen point is chosen.

Plugin Prototype

fzrt_error_td fz_model_pick_axis(

fzrt_int | windex,
fzrt_point * | location,
fz_axis_enum * | pick_world,
fz_axis_enum * | pick_plane,
fz_xyz_td * | pick_pt,
fz_xyz_td * | axis_pt1,
fz_xyz_td * | axis_pt2 )

Parameters

windex [Input]

project window index

location [Input]

pick location (screen location)

pick_world [Result, Optional]

Selected world axis or FZ_AXIS_NONE for none picked (if NULL, no check of world axis performed)

pick_plane [Result, Optional]

Selected reference plane axis or FZ_AXIS_NONE for none picked (if NULL, no check of reference plane axis performed)

pick_pt [Result, Optional]

picked location on axis line, in WORLD space

axis_pt1 [Result, Optional]

end point of axis line picked, in WORLD space

axis_pt2 [Result, Optional]

opposite end point of axis line picked, in WORLD space

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_model_fset

Defined in

fz_objt_api.h