Interaction Class Members
In This Topic
The following tables list the members exposed by Interaction.
Public Constructors
Public Properties
| Name | Description |
| Description | Description of undo step for this interaction. |
| DraggingMouseCursor | Mouse cursor which will be used for next dragging operation. |
| InstallationSpace | Installation space, the editor belongs to. |
| IsAutorestartEnabled | Returns true , if interaction should restart after stop. |
| IsInsertInteraction | Returns true , if interaction is used to insert one ore more placements on page. |
| IsObjectPlacementModeActive | Returns true , if special object placement mode is active. |
| IsPlacementFilterActive | If true, then placement-filter is active. |
| IsReadOnly | Returns true , if function does not change the project database. |
| IsSelectionInteraction | Returns true , if interaction is a helper interaction to select placements. |
| MousePosition | current mouse position |
| Page | Page, the editor belongs to. |
| Project | Project, the editor belongs to. |
| PromptForCommandLine | Prompt for command line. |
| PromptForStatusLine | Prompt for status line. |
| RootPlacement3D | Root placement to which the editor belongs. |
| StartPosition | start position of Interaction. The StartPosition is needed to calculate the current position while ortho mode is active or after input of length or angle the start position is automatically set after point input and before call of OnPoint after start of an interaction StartPosition is null |
| WereLogicalPlacementsChanged | Returns true, if logical placements were changed. |
Top
Public Methods
| Name | Description |
| ClearCursor | Remove Cursor-Representation. |
| Dispose | Destructor for deterministic finalization of Interaction object. |
| IsEnabled | Returns true, if interaction should be enabled in ribbon |
| OnAngle | Is called after input of an angle by the user. |
| OnCalculateCursorPos | Is called to calculate the cursor position. |
| OnCalculateStaticCursorPos | Is called to manipulate the position of the static CAD cursor. |
| OnCancel | Is called after abort of interaction. |
| OnChar | Is called after keyboard inputs by the user. |
| OnCursorMove | Is called on move of cursor by mouse or keys. |
| OnDeactivate | Is called after start of a new interaction with same or higher priority. In this case the current interaction is deactivated until the new interaction stops. |
| OnDrawCursor | Is called to get drawable objects for the cursor representation. |
| OnEdge | Is called after edged of a 3D mesh was selected by user. |
| OnEdgeBelowMouse | Is called after edge was found below the mouse pointer. |
| OnElementFound | Is called, when the placement below the mouse pointer changes as result of mouse movement. |
| OnEndDrag | Is called after end of a dragging operation. |
| OnFace | Is called after face of a 3D mesh was selected by user. |
| OnFaceBelowMouse | Is called after face was found below the mouse pointer. |
| OnFilterElement | Is called by framework to determine if oObject should be included in selection or will be highlighted. |
| OnInputFinish | Is called after special input operation has finished. |
| OnLength | Is called after input of length. |
| OnMouseLeavingWindow | Is called after Mouse leave the window. |
| OnPoint | Is called after a point input by user via mouse or keyboard. That means, that the user has clicked into the CAD Window or opened the command line and input the coordinates of a point. |
| OnReactivate | Is called after stop of the current interaction and this interaction is reactivated. |
| OnRestart | Is called after restart of the interaction. |
| OnReturnFromSubInteraction | Is called on end of sub-interaction. |
| OnSelect | Is called after object selection in the graphical editor by user. |
| OnSpecialEvent | Special event has occurred. Usually caused by user input. |
| OnStart | Is called after start of interaction |
| OnStartDrag | Is called after begin of a dragging operation. |
| OnStop | Is called before an interaction stops. |
| OnSuccess | Is called after successful input of all necessary data as reaction to the request code Success |
| OnVertex | Is called after vertex of a 3D mesh was selected by user. |
| OnVertexBelowMouse | Is called after vertex was found below the mouse pointer. |
| SetRubberboxCursor | Active Rubber-box cursor. |
| SetRubberlineCursor | Active Rubber-line cursor. |
| SetSelection | can be called to change selection. should only be used inside the OnSelect() method |
| SetStaticCursor | Overloaded. Sets Eplan.EplApi.DataModel.StorableObject, that will be temporary drawn as Cursor Representation. |
Top
See Also