NDEVR
API Documentation
FrameOfReferenceCommandWidget

A widget that is shown when the user scales a 3D model. More...

Inheritance diagram for FrameOfReferenceCommandWidget:
[legend]
Collaboration diagram for FrameOfReferenceCommandWidget:
[legend]

Public Member Functions

 FrameOfReferenceCommandWidget (QTModelManager *manager)
 Constructs a FrameOfReferenceCommandWidget.
virtual ~FrameOfReferenceCommandWidget ()
 Destructor.
void applyTransform ()
 Applies the configured frame-of-reference transform to the target model.
virtual SubSelectionMode defaultSelectionMode () const override
 Returns the default sub-selection mode for this command.
virtual QWidget * editWidget () override
 Returns the edit widget for this command.
virtual TranslatedString expandedHint () const override
 Returns an expanded hint with more detail about this command.
virtual TranslatedString group () const override
 Returns the group name for categorizing this command.
virtual TranslatedString hint () const override
 Returns a short hint describing this command.
virtual bool isSelecting () const override
 Returns whether the command is currently in a selecting state.
virtual void onCancel () override
 Cancels the current command operation.
virtual void onSelect (const Buffer< UUID > &selection) override
 Called when the user makes a selection during the command.
virtual bool processKeyEvent (const KeyEvent &event, DesignObjectLookup *lookup, Camera *camera) override
 Processes a key event during the command interaction.
virtual void refreshState (ModelEditController &controller) override
 Refreshes the command state based on the current edit controller.
virtual bool selectionModeAllowed (const SubSelectionMode &mode) const override
 Returns whether the given sub-selection mode is allowed during this command.
virtual void setupFilters (SelectionController *controller) override
 Sets up selection filters for this command.
Public Member Functions inherited from QtModelFunction
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 bool processMouseEvent (MouseControllerEvent &)
 Processes a mouse controller event during this function's operation.
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.

Protected Attributes

QTModelManagerm_manager
 The model manager providing data access.
StationModel m_station
 The station model used for frame-of-reference calculations.
UUID m_target = Constant<UUID>::Invalid
 The UUID of the target model being transformed.
Protected Attributes inherited from ModelFunction
ModelEditController * m_controller = nullptr
 Pointer to the owning ModelEditController.

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.

Detailed Description

A widget that is shown when the user scales a 3D model.


Definition at line 10 of file FrameOfReferenceCommandWidget.h.

Constructor & Destructor Documentation

◆ FrameOfReferenceCommandWidget()

FrameOfReferenceCommandWidget::FrameOfReferenceCommandWidget ( QTModelManager * manager)

Constructs a FrameOfReferenceCommandWidget.

Parameters
[in]managerThe QTModelManager providing data access.

Member Function Documentation

◆ defaultSelectionMode()

virtual SubSelectionMode FrameOfReferenceCommandWidget::defaultSelectionMode ( ) const
overridevirtual

Returns the default sub-selection mode for this command.

Returns
The default SubSelectionMode.

Implements ModelFunction.

◆ editWidget()

virtual QWidget * FrameOfReferenceCommandWidget::editWidget ( )
overridevirtual

Returns the edit widget for this command.

Returns
A pointer to the edit QWidget.

Implements QtModelFunction.

◆ expandedHint()

virtual TranslatedString FrameOfReferenceCommandWidget::expandedHint ( ) const
overridevirtual

Returns an expanded hint with more detail about this command.

Returns
The translated expanded hint text.

Reimplemented from ModelFunction.

◆ group()

virtual TranslatedString FrameOfReferenceCommandWidget::group ( ) const
overridevirtual

Returns the group name for categorizing this command.

Returns
The translated group name.

Reimplemented from ModelFunction.

◆ hint()

virtual TranslatedString FrameOfReferenceCommandWidget::hint ( ) const
overridevirtual

Returns a short hint describing this command.

Returns
The translated hint text.

Reimplemented from ModelFunction.

◆ isSelecting()

virtual bool FrameOfReferenceCommandWidget::isSelecting ( ) const
overridevirtual

Returns whether the command is currently in a selecting state.

Returns
True if the command is actively selecting.

Implements ModelFunction.

◆ onSelect()

virtual void FrameOfReferenceCommandWidget::onSelect ( const Buffer< UUID > & selection)
overridevirtual

Called when the user makes a selection during the command.

Parameters
[in]selectionThe UUIDs of the selected objects.

Reimplemented from ModelFunction.

◆ processKeyEvent()

virtual bool FrameOfReferenceCommandWidget::processKeyEvent ( const KeyEvent & event,
DesignObjectLookup * lookup,
Camera * camera )
overridevirtual

Processes a key event during the command interaction.

Parameters
[in]eventThe key event to process.
[in]lookupThe design object lookup for resolving objects.
[in]cameraThe active camera.
Returns
True if the event was handled.

Reimplemented from ModelFunction.

◆ refreshState()

virtual void FrameOfReferenceCommandWidget::refreshState ( ModelEditController & controller)
overridevirtual

Refreshes the command state based on the current edit controller.

Parameters
[in]controllerThe model edit controller.

Implements ModelFunction.

◆ selectionModeAllowed()

virtual bool FrameOfReferenceCommandWidget::selectionModeAllowed ( const SubSelectionMode & mode) const
overridevirtual

Returns whether the given sub-selection mode is allowed during this command.

Parameters
[in]modeThe sub-selection mode to check.
Returns
True if the mode is allowed.

Implements ModelFunction.

◆ setupFilters()

virtual void FrameOfReferenceCommandWidget::setupFilters ( SelectionController * controller)
overridevirtual

Sets up selection filters for this command.

Parameters
[in]controllerThe selection controller to configure.

Reimplemented from ModelFunction.


The documentation for this class was generated from the following file: