Namespaces | Classes | Enumerations | Functions

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...
 

Detailed Description

Enumeration Type Documentation

enum AccuSnapEnableFlag
Enumerator
ACCUSNAP_ENABLE_OffByDefault 
ACCUSNAP_ENABLE_OnByDefault 
ACCUSNAP_ENABLE_Never 

Function Documentation

void mdlAccuSnap_clear ( )

Remove the AccuSnap indicator from the screen, unhilite elements, and clear Accusnap.

Remarks
Required Library: mdlbltin.lib
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.

Parameters
[in]onOfftrue to enable AccuSnap locating, false to disable it
See also
mdlAutoLocate_enable
Remarks
Required Library: mdlbltin.lib
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.

Parameters
[in]onOfftrue to enable AccuSnap snapping, false to disable it
Remarks
Required Library: mdlbltin.lib
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

Returns
current AccuSnap path
Remarks
Required Library: mdlbltin.lib
bool mdlAccuSnap_isActive ( )

Determine whether AccuSnap is currently active (meaning both the tool and the user indicated they want it).

Returns
true if AccuSnap is active, false if it is inactive.
Remarks
Required Library: mdlbltin.lib
bool mdlAccuSnap_isLocateEnabled ( )

Indicates whether AutoLocate has been enabled by the current tool.

Returns
true if AutoLocate has been enabled by the current tool.
See also
mdlAutoLocate_isUserEnabled
Remarks
Required Library: mdlbltin.lib
bool mdlAccuSnap_isSnapEnabled ( )

Indicates whether AccuSnap snapping has been enabled.

Returns
true if AccuSnap has been enabled by the active command.
Remarks
Required Library: mdlbltin.lib
bool mdlAccuSnap_isSnapped ( )

Determine whether AccuSnap is currently snapped to an element.

Returns
true if AccuSnap is snapped to an element, false if it is not.
Remarks
Required Library: mdlbltin.lib
DgnPlatform::AccuSnapEnableFlag mdlAccuSnap_isUserEnabled ( )

See whether or not the USER wants AccuSnap active.

AccuSnap

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.

Returns
the AccuSnapEnableFlag value for whether the user has enabled AccuSnap.
Remarks
Required Library: mdlbltin.lib
void mdlAccuSnap_setUserEnabled ( DgnPlatform::AccuSnapEnableFlag  flag)

Turn Accusnap on or off in the accusnap button bar.

Parameters
[in]flagsee AccuSnapEnableFlag for possible values.
Remarks
Required Library: mdlbltin.lib
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.

Parameters
[in]doSuppresstrue to suspend AccuSnap, false to resume
Returns
resulting suppress count
Remarks
Required Library: mdlbltin.lib
void mdlAccuSnap_suspend ( bool  doSuspend)

Temporarily suspend Accusnap.

Calls to this function must be paired.

Parameters
[in]doSuspendtrue to suspend AccuSnap, false to resume it.
Remarks
Required Library: mdlbltin.lib

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.