Parameters of the point input operation.
typedef struct { char prompt[256]; bool changeFilter; bool changeCursorSet; bool changePlane; bool enableQuickSelection; Int32 filler_1; API_NeigFilter filter; API_CursorSet cursorSet; API_Coord3D planeCoord; API_Vector3D planeNormal; API_Coord3D pos; API_Neig neig; API_Guid guid; Int32 dbElemIdx; Int32 bodyIdx; ULong ipgon; } API_GetPointType;
Members
- prompt
- [in] Prompt string to be displayed in the control box during input
- changeFilter
- [in] Use the
filter
field for filtering neigs during input - changeCursorSet
- [in] Use the
cursorSet
field for changing cursor forms - changePlane
- [in] Use the
planeCoord
andplaneNormal
fields for defining input plane - enableQuickSelection
- [in] Enabling Quick Selection (magnetic cursor)
- filter
- [in] Neig filter for cursor snapping. See APIIo_InitNeigFilterID
- cursorSet
- [in] Cursor set for customized visual feedback
- planeCoord
- [in] A point of the input plane
- planeNormal
- [in] The normal vector of the input plane
- pos
- [out] The coordinate of the clicked point
- neig
- [out] The neig found at the clicked point
- guid
- [out] Guid of the clicked element.
- dbElemIdx
- [out] Database elem index of the clicked element.
- bodyIdx
- [out] Index of the clicked body in the clicked element.
- ipgon
- [out] Index of the clicked polygon in the clicked body.
Remarks
For the utilization of API_GetPointType see the APIIo_GetPointID function.
Requirements
- Version: API 3.1 or later
- Header: APIdefs_Interface.h
See Also
APIIo_GetPointID, API_NeigFilter, API_CursorSet, API_Coord3D, API_Vector3D, API_Neig, API Types