C++ Syntax

__int32

MKI_InputPointExitProc(

__int32 f_nCommandID,

__int32 f_nPointIndex,

MKI_CONST_POINT_REF f_rPoint );

typedef __int32

(*MKI_INPUTPOINTEXIT_PROC)(

__int32 f_nCommandID,

__int32 f_nPointIndex,

MKI_CONST_POINT_REF f_rPoint );

This procedure is called during the execution of an external command, i.e. a command that is handled by a plug-in.

Parameters

CommandID

[__int32] Identifier of the current command. Valid range: 0 <= Value < MKI_PLUGIN_MENU_MAX.

PointIndex

[__int32] Zero-based index of the point that is currently entered. Valid range: 0 <= Value < MKI_INPUT_MAX.

Point

[MKI_CONST_POINT_REF] Coordinates of the current mouse position in internal [mm] (relative to the page center, scale-independent).

Return Value

Should return one of the following values:

MKI_INPUT_OK

Point may be accepted, continue entry of next point entry (or finish command, if the current point was the final point).

MKI_INPUT_CANCEL

Cancel the complete command (usually due to user termination).

MKI_INPUT_ERROR

Cancel the complete command (usually due to calculation overflow, invalid data etc.).

MKI_INPUT_OVERFLOW

Too many points entered, ignore this point (an error-beep will sound).

MKI_INPUT_OBJTYPE New in Version 6.04

An invalid or unusable object type has been identified (an error-beep will sound).

MKI_INPUT_IGNORE

Ignore this point entry, let the user enter it again (no error-beep will sound).

MKI_INPUT_IDLE New in Version 6.31

Point cannot be used, let the user enter it again (an error-beep will sound).

MKI_INPUT_SNAP New in Version 6.32

No valid point snapped, let the user enter it again (an error-beep will sound).

MKI_INPUT_IDENT New in Version 6.32

No valid element identified, let the user enter it again (an error-beep will sound).

MKI_INPUT_FINISH

Finish the command (even though not all points have been entered!).

Comment

This procedure is called each time the entry of a point is finished by either clicking with the mouse or by entering a coordinate via direct coordinate entry. At this time, the plug-in can perform calculations that would have too time-consuming to do them during point entry. Also, it should store the given coordinates, as they are the final and definite coordinates of the current point.

If the command requires a variable number of points, this procedure must return MKI_INPUT_FINISH if the command shall be finished now. Returning MKI_INPUT_OK will continue with the next point entry.

The name MKI_InputPointExitProc is only a placeholder, the procedure may have any name.