C++ Syntax

class MKI_SNAP_POINT

{

public:

MKI_MATRIX m_cMatrix;

MKI_POINT m_cClickPoint,

m_cBestPoint;

double m_dRadius,

m_dDistance;

__int32 m_nMode,

m_nBestType;

LPWSTR m_pszDescription1,

m_pszDescription2;

bool m_fStopped;

MKI_SNAP_DATA( void ); New in Version 2023.0

void

Init( void ); New in Version 2023.0

};

This structure contains information for point snapping as required by plug-ins whose MKI_PlugInNotify procedure is called with the MKI_NOTIFY_EXT_SNAP mode.

Element Description

Matrix New in Version 2013.2

[MKI_MATRIX] Additional display matrix to be applied before snapping.

ClickPoint

[MKI_POINT] Coordinates of the point that the user clicked with the mouse in internal [mm]. The snapping point closest to this point shall be found. Do not modify!

BestPoint Renamed in Version 2023.0

[MKI_POINT] Coordinates of the currently best snapping point in internal [mm]. If a better snapping point is found, these coordinates will be replaced.

Radius

[double] Snapping radius in internal [mm] around ClickPoint. Only points within this circular area shall be used (unless they are center or quadrant points defined by clicking onto an object's outline). Do not modify!

Distance

[double] Distance of the currently best snapping point to the clicked point in internal [mm]. If a better snapping point is found, this distance will be replaced.

Mode

[__int32] A bit-wise OR combination of snapping mode valid for this operation (see MKI_SNAPMODE_*).

BestType Changed in Version 2023.2

[__int32] Type of the currently best snapping point (see MKI_SNAPTYPE_*, must never be MKI_SNAPTYPE_NONE). Once a better snapping point is found, this value will be replaced.

Description1 New in Version 2023.0

[LPWSTR] Description of the first entity from which the currently best snapping point is derived. Maximum length is 255 characters. May be nullptr.

Description2 New in Version 2023.0

[LPWSTR] Description of the second entity from which the currently best snapping point is derived (only used in case of an intersection). Maximum length is 255 characters. May be nullptr.

Stopped New in Version 2013.2

[bool] If true, the snapping process was terminated by the user, you should immediately abort processing.