Namespaces | |
| Bentley | |
| The Bentley namespace contains types defined by the Bentley Library. | |
| Bentley::DgnPlatform | |
| The DgnPlatform namespace contains types defined by the DgnPlatform. | |
Classes | |
| struct | AccuSnapHandler |
| An Event Handler for responding to significant events during AccuSnap processing. More... | |
| struct | TentativePoint |
| struct | AccuSnap |
Enumerations | |
| enum | AccuSnapEnableFlag { ACCUSNAP_ENABLE_OffByDefault = 0, ACCUSNAP_ENABLE_OnByDefault = 1, ACCUSNAP_ENABLE_Never = 2 } |
Functions | |
| DgnPlatform::AccuSnapEnableFlag | mdlAccuSnap_isUserEnabled () |
| See whether or not the USER wants AccuSnap active. More... | |
| void | mdlAccuSnap_setUserEnabled (DgnPlatform::AccuSnapEnableFlag flag) |
| Turn Accusnap on or off in the accusnap button bar. More... | |
| void | mdlAccuSnap_clear () |
| Remove the AccuSnap indicator from the screen, unhilite elements, and clear Accusnap. More... | |
| bool | mdlAccuSnap_isSnapEnabled () |
| Indicates whether AccuSnap snapping has been enabled. More... | |
| bool | mdlAccuSnap_isLocateEnabled () |
| Indicates whether AutoLocate has been enabled by the current tool. More... | |
| void | mdlAccuSnap_enableSnap (bool onOff) |
| Enable/disable AccuSnap snapping for this command. More... | |
| void | mdlAccuSnap_enableLocate (bool onOff) |
| Enable/disable AutoLocate for this command. More... | |
| void | mdlAccuSnap_suspend (bool doSuspend) |
| Temporarily suspend Accusnap. More... | |
| int | mdlAccuSnap_suppress (bool doSuppress) |
| Suspend Accusnap until reenabled. More... | |
| bool | mdlAccuSnap_isActive () |
| Determine whether AccuSnap is currently active (meaning both the tool and the user indicated they want it). More... | |
| bool | mdlAccuSnap_isSnapped () |
| Determine whether AccuSnap is currently snapped to an element. More... | |
| SnapPathCP | mdlAccuSnap_getCurrent () |
| Return current path from AccuSnap. More... | |
| enum AccuSnapEnableFlag |
| void mdlAccuSnap_clear | ( | ) |
Remove the AccuSnap indicator from the screen, unhilite elements, and clear Accusnap.
| void mdlAccuSnap_enableLocate | ( | bool | onOff | ) |
Enable/disable AutoLocate for this command.
AutoLocate does not become active unless both the command and the user enable it.
| [in] | onOff | true to enable AccuSnap locating, false to disable it |
| void mdlAccuSnap_enableSnap | ( | bool | onOff | ) |
Enable/disable AccuSnap snapping for this command.
AccuSnap does not become active unless both the command and the user enable it.
| [in] | onOff | true to enable AccuSnap snapping, false to disable it |
| SnapPathCP mdlAccuSnap_getCurrent | ( | ) |
Return current path from AccuSnap.
This will return the current path, regardless of whether the path is "hot" or not. Otherwise, it returns the same value as mdlSnap_getCurrent
| bool mdlAccuSnap_isActive | ( | ) |
Determine whether AccuSnap is currently active (meaning both the tool and the user indicated they want it).
| bool mdlAccuSnap_isLocateEnabled | ( | ) |
Indicates whether AutoLocate has been enabled by the current tool.
| bool mdlAccuSnap_isSnapEnabled | ( | ) |
Indicates whether AccuSnap snapping has been enabled.
| bool mdlAccuSnap_isSnapped | ( | ) |
Determine whether AccuSnap is currently snapped to an element.
| DgnPlatform::AccuSnapEnableFlag mdlAccuSnap_isUserEnabled | ( | ) |
See whether or not the USER wants AccuSnap active.
AccuSnap is the feature of MicroStation that automatically snaps to elements as the cursor passes over them.
AccuSnap is only active if both the user and the active tool have requested that it be active. The user controls AccuSnap from within MicroStation's user interface. The Accusnap settings dialog can be accessed from the pulldown menu Settings > Snaps > AccuSnap. The user can also force AccuSnap on or off by holding the Ctrl+Shift key combination. Note, forcing the use of AccuSnap via Ctrl+Shift will use AccuSnap even if the tool has not enabled it.
AccuSnap is disabled by MicroStation whenever a new tool is started, so it is not necessary to clear AccuSnap.
Enabling and disabling AccuSnap can be accomplished with the following basic AccuSnap functions:
To support AccuSnap for all datapoints, enable AccuSnap after your call to mdlState_startPrimitive, or mdlState_startModifyCommand.
In some tools, you may want to enable AccuSnap for the second datapoint. To do this, enable AccuSnap in your datapoint function. Remember that starting tools disables AccuSnap automatically, including when the current tool restarts.
| void mdlAccuSnap_setUserEnabled | ( | DgnPlatform::AccuSnapEnableFlag | flag | ) |
Turn Accusnap on or off in the accusnap button bar.
| [in] | flag | see AccuSnapEnableFlag for possible values. |
| int mdlAccuSnap_suppress | ( | bool | doSuppress | ) |
Suspend Accusnap until reenabled.
Calls to this function must be paired. This does the same thing as mdlAccuSnap_suspend, except that suppression is 'sticky' – it is not automatically cleared by MicroStation tools.
| [in] | doSuppress | true to suspend AccuSnap, false to resume |
| void mdlAccuSnap_suspend | ( | bool | doSuspend | ) |
Temporarily suspend Accusnap.
Calls to this function must be paired.
| [in] | doSuspend | true to suspend AccuSnap, false to resume it. |