CSOCreateAction Class Reference
Action for creating CSOs. More...
#include <CSOCreateAction.h>
Inheritance diagram for CSOCreateAction:
Public Member Functions | |
| CSOCreateAction (SoView2DCSOExtensibleEditor *editor) | |
 Public Member Functions inherited from CSOAbstractCreateAction | |
| CSOAbstractCreateAction (SoView2DCSOExtensibleEditor *editor, const std::string &id) | |
| bool | isSensitiveAt (const SoPointerPosition &pos) override |
Returns true if the gesture is startable at the given device position. | |
| void | startPressAt (const SoPointerPosition &pos) override |
| Starts a drag at given device position. | |
| void | dragMoveTo (const SoPointerPosition &pos) override |
| Continues the drag to given device position. | |
| SoPointingAction * | endPress (int clickCount) override |
| Ends the drag at last device position. | |
| int | getCurrentCursor (SoViewerProxy *) const override |
| Returns the cursor ID to display for this action, as defined in SoViewerProxy.h - this gets (at least) called after setMode(), isSensitiveAt(), startPressAt(), dragMoveTo(), and endPress(). | |
| void | setMode (int mode) override |
| This gets called if the mode was changed and before startPressAt is called. | |
| int | getNumModes () const override |
| Returns the number of different modes of this action - modes can be changed during drag, and handle drag restrictions or drag result. | |
| Public Member Functions inherited from CSOPointingAction | |
| CSOPointingAction (SoView2DCSOExtensibleEditor *editor, const std::string &id) | |
| Public Member Functions inherited from SoPointingAction | |
| SoPointingAction (SoInteractionOwner *owner, std::string id, bool positionSensitive=true) | |
| Standard constructor. | |
| virtual bool | isPositionSensitive () const |
Position sensitive actions can only start at positions where isSensitiveAt() return true. | |
| void | clearTriggers () |
| Removes all triggers. | |
| void | setTrigger (int triggerMask, int ignoreMask=0) |
| Sets the (only) default modifier/button mask for triggering this action. | |
| void | setTrigger (const Trigger &trigger) |
| Same with Trigger object. | |
| void | addTrigger (const Trigger &trigger) |
| Adds another default modifier/button mask as trigger. | |
| TriggerList | getTriggers () const |
| Returns the list of default modifier/button mask combinations set for this action. | |
| virtual bool | triggersAction (int mask) |
| Returns whether the given modifier/button combination activates this action according to the default bindings. | |
| virtual std::string | getCurrentStatusMessage () const |
| Returns a status message for display in the status bar of MeVisLab (make it short!), this is called at same time as getCurrentCursor. | |
| virtual void | setHighlightAt (const SoPointerPosition &) |
| This method is called so that highlighting of objects under the mouse cursor can occur. | |
| virtual void | unsetHighlight () |
| Removes any highlighting if this method is called. | |
| virtual void | dragCancelled () |
| This is called if the current drag operation is canceled, e.g., through a key command like Escape. | |
| virtual bool | wantsMouseOverUpdates () |
Override this to return true if this action should get location updates directly before rendering, so it can update its status. | |
| void | grabReleased () |
| Call this to release an interaction grab that has been established by the return value of endPress(), e.g., because it was aborted through a SoCommandAction. | |
| virtual void | releaseGrab (StopMode) |
| This will be called by the controller if you should release the grab established by endPress. | |
| virtual bool | wantsImmediateDragUpdates () |
Let this method return false if you do not want dragMoveTo to be called until it is clear that the interaction will not be handled as a click (endPress will be called with a clickCount greater zero). | |
| Public Member Functions inherited from SoInteraction | |
| SoInteraction (InteractionType type, SoInteractionOwner *owner, const std::string &id, bool registerWithOwner=true) | |
| Standard constructor. | |
| virtual | ~SoInteraction () |
| Virtual destructor. | |
| SoInteractionOwner * | getOwner () const |
| Returns the interaction provider of this entry. | |
| virtual bool | isEnabled () const |
Returns the enabled status of this interaction - if this returns false, the action is not selectable (but if a mouse action has already been started, it will not be aborted if this returns false). | |
| virtual void | setEnabled (bool enabled) |
| Sets the enabled status of this interaction. | |
| std::string | getID () const |
| Returns the ID of this interaction. | |
| void | setID (const std::string &id) |
| Sets the ID of this interaction. | |
| std::string | getFullID () const |
| Returns the ID string consisting of the ID of the provider and this action's ID, separated by '. | |
| InteractionType | getInteractionType () const |
| Returns type of interaction object. | |
| template<class T > | |
| bool | isOfType () const |
| Convenience method for checking type. | |
| int | getMenuPriority () const |
| void | setMenuPriority (int priority) |
| Sets the priority value for ordered display in menus/tool boxes. | |
| virtual std::string | getUserName () const |
| Returns user-visible name of this item for direct display (e.g., in tool box or menu). | |
| virtual void | setUserName (const std::string &name) |
| Sets the user name of this interaction entry. | |
| virtual std::string | getIconFile () const |
| Returns the filename of an icon (e.g., for use in a tool box or in menu). | |
| virtual void | setIconFile (const std::string &file) |
| Sets the filename of an icon used for this interaction entry. | |
| virtual std::string | getDescription () const |
| Returns the description for user help. | |
| virtual void | setDescription (const std::string &descr) |
| Sets the description for user help. | |
| virtual void | ref () |
| virtual void | unref () |
| int | getStateVersion () const |
| void | touch () |
| Increments the version number of attribute state to mark attribute changes. | |
Protected Member Functions | |
| void | callCreateStartPressAt (const SoPointerPosition &pos) override |
| void | callCreateDragMoveTo (const SoPointerPosition &pos) override |
| bool | callCreateEndPress (int clickCount) override |
| Protected Member Functions inherited from CSOAbstractCreateAction | |
| SoCSOEditorExtension * | getActiveEditorChecked () const |
| Protected Member Functions inherited from CSOPointingAction | |
| bool | isInsideImage (const SoPointerPosition &pos) |
| Returns whether the position is inside the image if needsValidVoxel is set; Otherwise, it just returns true. | |
| void | setView2DImage (const SoPointerPosition &pos) |
| void | updateImageStatistics (ml::CSO *cso) |
| void | setActionActive () |
| Set/unset the maskValid flag in the editor. | |
| void | unsetActionActive () |
| Protected Member Functions inherited from SoPointingAction | |
| virtual SoOffsetAction * | proxiedOffsetAction () const |
Additional Inherited Members | |
| Public Types inherited from SoPointingAction | |
| enum | StopMode { AbortAction , FinishAction } |
| Argument type for releaseGrab() More... | |
| enum | { Button1Mask = ManagedMouseButtonTrigger::Button1Mask , Button2Mask = ManagedMouseButtonTrigger::Button2Mask , Button3Mask = ManagedMouseButtonTrigger::Button3Mask , AllButtonsMask = ManagedMouseButtonTrigger::AllButtonsMask } |
| Configuration values for the Trigger type. More... | |
| enum | { TypeId = TypePointingAction } |
| typedef ManagedMouseButtonTrigger | Trigger |
| Class Trigger encapsulates the combination of required and ignored button, and modifier keys that activate a pointing action. | |
| typedef std::list< Trigger > | TriggerList |
| List of triggers. | |
| Public Types inherited from SoInteraction | |
| enum | { NoModifier = ManagedActionTrigger::NoModifier , ShiftModifier = ManagedActionTrigger::ShiftModifier , ControlModifier = ManagedActionTrigger::ControlModifier , AltModifier = ManagedActionTrigger::AltModifier , AllModifiersMask = ManagedActionTrigger::AllModifiersMask , ShiftMask = ShiftModifier , CtrlMask = ControlModifier , AltMask = AltModifier } |
| Constants to use where keyboard modifiers must be specified. More... | |
| enum | InteractionType { TypePointingAction , TypeCommandAction , TypeOffsetAction } |
| Enum identifying subtypes of this class. More... | |
| Protected Attributes inherited from CSOAbstractCreateAction | |
| SoRef< SoCSOEditorExtension > | _activeEditor |
| SbVec3f | _initialPosition |
| SbVec3f | _sliceNormal |
| Protected Attributes inherited from CSOPointingAction | |
| SoView2DCSOExtensibleEditor * | _editor |
| SoSFMLImage * | _image |
Detailed Description
Action for creating CSOs.
Definition at line 22 of file CSOCreateAction.h.
Constructor & Destructor Documentation
◆ CSOCreateAction()
| CSOCreateAction::CSOCreateAction | ( | SoView2DCSOExtensibleEditor * | editor | ) |
Member Function Documentation
◆ callCreateDragMoveTo()
|
overrideprotectedvirtual |
Implements CSOAbstractCreateAction.
◆ callCreateEndPress()
|
overrideprotectedvirtual |
Implements CSOAbstractCreateAction.
◆ callCreateStartPressAt()
|
overrideprotectedvirtual |
Implements CSOAbstractCreateAction.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/Inventor/SoCSO/SoView2DCSOEditor/SoView2DCSOExtensibleEditor/CSOActions/CSOCreateAction.h
