Eplan Platform API
Eplan.EplApi.EServices.Ged Namespace / Interaction Class
Properties Methods

In This Topic
    Interaction Class Members
    In This Topic

    The following tables list the members exposed by Interaction.

    Public Constructors
     NameDescription
    Public ConstructorInteraction ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyDescriptionDescription of undo step for this interaction.  
    Public PropertyDraggingMouseCursorMouse cursor which will be used for next dragging operation.  
    Public PropertyInstallationSpaceInstallation space, the editor belongs to.  
    Public PropertyIsAutorestartEnabledReturns true, if interaction should restart after stop.  
    Public PropertyIsInsertInteractionReturns true, if interaction is used to insert one ore more placements on page.  
    Public PropertyIsObjectPlacementModeActiveReturns true, if special object placement mode is active.  
    Public PropertyIsPlacementFilterActiveIf true, then placement-filter is active.  
    Public PropertyIsReadOnlyReturns true, if function does not change the project database.  
    Public PropertyIsSelectionInteractionReturns true, if interaction is a helper interaction to select placements.  
    Public PropertyMousePositioncurrent mouse position  
    Public PropertyPagePage, the editor belongs to.  
    Public PropertyProjectProject, the editor belongs to.  
    Public PropertyPromptForCommandLinePrompt for command line.  
    Public PropertyPromptForStatusLinePrompt for status line.  
    Public PropertyRootPlacement3DRoot placement to which the editor belongs.  
    Public PropertyStartPositionstart 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  
    Public PropertyWereLogicalPlacementsChangedReturns true, if logical placements were changed.  
    Top
    Public Methods
     NameDescription
    Public MethodClearCursorRemove Cursor-Representation.  
    Public MethodDisposeDestructor for deterministic finalization of Interaction object.  
    Public MethodGetResult  
    Public MethodIsEnabledReturns true, if interaction should be enabled in ribbon  
    Public MethodOnAngleIs called after input of an angle by the user.  
    Public MethodOnCalculateCursorPosIs called to calculate the cursor position.  
    Public MethodOnCalculateStaticCursorPosIs called to manipulate the position of the static CAD cursor.  
    Public MethodOnCancelIs called after abort of interaction.  
    Public MethodOnCharIs called after keyboard inputs by the user.  
    Public MethodOnCursorMoveIs called on move of cursor by mouse or keys.  
    Public MethodOnDeactivateIs 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.  
    Public MethodOnDrawCursorIs called to get drawable objects for the cursor representation.  
    Public MethodOnEdgeIs called after edged of a 3D mesh was selected by user.  
    Public MethodOnEdgeBelowMouseIs called after edge was found below the mouse pointer.  
    Public MethodOnElementFoundIs called, when the placement below the mouse pointer changes as result of mouse movement.  
    Public MethodOnEndDragIs called after end of a dragging operation.  
    Public MethodOnFaceIs called after face of a 3D mesh was selected by user.  
    Public MethodOnFaceBelowMouseIs called after face was found below the mouse pointer.  
    Public MethodOnFilterElementIs called by framework to determine if oObject should be included in selection or will be highlighted.  
    Public MethodOnInputFinishIs called after special input operation has finished.  
    Public MethodOnLengthIs called after input of length.  
    Public MethodOnMouseLeavingWindowIs called after Mouse leave the window.  
    Public MethodOnPointIs 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.  
    Public MethodOnReactivateIs called after stop of the current interaction and this interaction is reactivated.  
    Public MethodOnRestartIs called after restart of the interaction.  
    Public MethodOnReturnFromSubInteractionIs called on end of sub-interaction.  
    Public MethodOnSelectIs called after object selection in the graphical editor by user.  
    Public MethodOnSpecialEventSpecial event has occurred. Usually caused by user input.  
    Public MethodOnStartIs called after start of interaction  
    Public MethodOnStartDragIs called after begin of a dragging operation.  
    Public MethodOnStopIs called before an interaction stops.  
    Public MethodOnSuccessIs called after successful input of all necessary data as reaction to the request code Success  
    Public MethodOnVertexIs called after vertex of a 3D mesh was selected by user.  
    Public MethodOnVertexBelowMouseIs called after vertex was found below the mouse pointer.  
    Public MethodSetRubberboxCursorActive Rubber-box cursor.  
    Public MethodSetRubberlineCursorActive Rubber-line cursor.  
    Public MethodSetSelectioncan be called to change selection. should only be used inside the OnSelect() method  
    Public MethodSetStaticCursorOverloaded. Sets Eplan.EplApi.DataModel.StorableObject, that will be temporary drawn as Cursor Representation.  
    Top
    See Also

    Reference

    Interaction Class
    Eplan.EplApi.EServices.Ged Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support