 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
Can be used to add functionality to the ModelCommandsWidget by showing a unique widget when the action is undertaken. More...
Public Member Functions | |
| virtual QWidget * | editWidget ()=0 |
| Returns the widget used to configure this model function. | |
| virtual bool | shouldShowInterface () const override |
| Returns whether the function should show a UI interface. | |
| Public Member Functions inherited from ModelFunction | |
| virtual bool | canAutoFinishNow () const |
| Checks whether the function can automatically finish in its current state. | |
| virtual SubSelectionMode | defaultSelectionMode () const =0 |
| Returns the default sub-selection mode for this function. | |
| virtual TranslatedString | expandedHint () const |
| Returns an expanded hint with more detailed description of the function. | |
| virtual TranslatedString | group () const |
| Returns the group or category this function belongs to for UI organization. | |
| virtual TranslatedString | hint () const |
| Returns a short hint or tooltip string describing the function. | |
| virtual bool | isSelecting () const =0 |
| Checks whether the function is currently in a selection state. | |
| virtual void | onCancel ()=0 |
| Called when the function's operation is cancelled. | |
| virtual void | onSelect (const Buffer< UUID > &) |
| Called when objects are selected during this function's operation. | |
| virtual bool | processKeyEvent (const KeyEvent &, DesignObjectLookup *, Camera *) |
| Processes a keyboard event during this function's operation. | |
| virtual bool | processMouseEvent (MouseControllerEvent &) |
| Processes a mouse controller event during this function's operation. | |
| virtual void | refreshState (ModelEditController &controller)=0 |
| Refreshes the internal state of this function based on the current controller state. | |
| virtual void | requestCancel () |
| Requests cancellation of the current function through the controller. | |
| virtual void | requestFinish () |
| Requests that the function finishes its operation through the controller. | |
| virtual void | requestFinishSelection () |
| Requests that the selection phase of this function be completed. | |
| virtual bool | selectionModeAllowed (const SubSelectionMode &mode) const =0 |
| Checks whether a given sub-selection mode is valid for this function. | |
| virtual void | setupFilters (SelectionController *) |
| Sets up selection filters on the given selection controller for this function. | |
Additional Inherited Members | |
| Public Attributes inherited from ModelFunction | |
| String | icon |
| The icon identifier used for toolbar/menu display. | |
| UUID | id |
| Unique identifier for this model function. | |
| TranslatedString | name |
| The display name of the function shown in UI. | |
| Protected Member Functions inherited from ModelFunction | |
| virtual void | setController (ModelEditController *controller) |
| Sets the owning controller for this function. | |
| Protected Attributes inherited from ModelFunction | |
| ModelEditController * | m_controller = nullptr |
| Pointer to the owning ModelEditController. | |
Can be used to add functionality to the ModelCommandsWidget by showing a unique widget when the action is undertaken.
Definition at line 57 of file ModelCommandsWidget.h.
|
pure virtual |
Returns the widget used to configure this model function.
Implemented in FrameOfReferenceCommandWidget, GeometrySurfacingFunction, PaintCommandWidget, and ScaleCommandWidget.
|
inlineoverridevirtual |
Returns whether the function should show a UI interface.
Always returns true.
Reimplemented from ModelFunction.
Definition at line 69 of file ModelCommandsWidget.h.