GeometrySurfacingFunction

A QtModelFunction that manages the geometry surfacing tool, including selection and UI. More...

Inheritance diagram for GeometrySurfacingFunction:

Collaboration diagram for GeometrySurfacingFunction:

Public Member Functions
	GeometrySurfacingFunction (QTModelManager *manager)
	Constructs a GeometrySurfacingFunction.
virtual	~GeometrySurfacingFunction ()
	Destroys the GeometrySurfacingFunction.
virtual SubSelectionMode	defaultSelectionMode () const override
	Returns the default sub-selection mode for this function.
virtual QWidget *	editWidget () override
	Returns the editing widget for this function.
virtual TranslatedString	expandedHint () const override
	Returns an expanded hint description.
virtual TranslatedString	group () const override
	Returns the function group name.
virtual TranslatedString	hint () const override
	Returns a short hint description.
virtual bool	isSelecting () const override
	Returns whether the tool is currently in selection mode.
virtual void	onCancel () override
	Cancels the current surfacing operation.
virtual void	onSelect (const Buffer< UUID > &selection) override
	Called when a selection is made.
virtual bool	processKeyEvent (const KeyEvent &event, DesignObjectLookup *lookup, Camera *camera) override
	Processes a keyboard event during surfacing mode.
virtual void	refreshState (ModelEditController &controller) override
	Refreshes the tool state based on the current edit controller.
virtual bool	selectionModeAllowed (const SubSelectionMode &mode) const override
	Checks whether the given sub-selection mode is allowed.
virtual void	setupFilters (SelectionController *controller) override
	Configures selection filters for the surfacing tool.
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
QTModelManager *	m_manager
	The application model manager.
GeometrySurfacingWidget *	m_widget
	The surfacing configuration widget.
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 QtModelFunction that manages the geometry surfacing tool, including selection and UI.

---

Definition at line 71 of file GeometrySurfacingWidget.h.

Constructor & Destructor Documentation

GeometrySurfacingFunction()

GeometrySurfacingFunction::GeometrySurfacingFunction

(

QTModelManager *

manager

)

Constructs a GeometrySurfacingFunction.

Parameters

[in]

manager

The model manager for accessing design data.

Member Function Documentation

defaultSelectionMode()

virtual SubSelectionMode GeometrySurfacingFunction::defaultSelectionMode ( ) const

overridevirtual

Returns the default sub-selection mode for this function.

Returns

The default selection mode.

Implements ModelFunction.

editWidget()

virtual QWidget * GeometrySurfacingFunction::editWidget ( )

overridevirtual

Returns the editing widget for this function.

Returns

The GeometrySurfacingWidget.

Implements QtModelFunction.

expandedHint()

virtual TranslatedString GeometrySurfacingFunction::expandedHint ( ) const

overridevirtual

Returns an expanded hint description.

Returns

The translated expanded hint text.

Reimplemented from ModelFunction.

group()

virtual TranslatedString GeometrySurfacingFunction::group ( ) const

overridevirtual

Returns the function group name.

Returns

The translated group name.

Reimplemented from ModelFunction.

hint()

virtual TranslatedString GeometrySurfacingFunction::hint ( ) const

overridevirtual

Returns a short hint description.

Returns

The translated hint text.

Reimplemented from ModelFunction.

isSelecting()

virtual bool GeometrySurfacingFunction::isSelecting ( ) const

overridevirtual

Returns whether the tool is currently in selection mode.

Returns

True if selecting.

Implements ModelFunction.

onSelect()

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

overridevirtual

Called when a selection is made.

Parameters

[in]

selection

The selected model UUIDs.

Reimplemented from ModelFunction.

processKeyEvent()

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

overridevirtual

Processes a keyboard event during surfacing mode.

Parameters

[in]	event	The key event.
[in]	lookup	The design object lookup.
[in]	camera	The active camera.

Returns

True if the event was handled.

Reimplemented from ModelFunction.

refreshState()

virtual void GeometrySurfacingFunction::refreshState ( ModelEditController & controller )

overridevirtual

Refreshes the tool state based on the current edit controller.

Parameters

[in]

controller

The model edit controller.

Implements ModelFunction.

selectionModeAllowed()

virtual bool GeometrySurfacingFunction::selectionModeAllowed ( const SubSelectionMode & mode ) const

overridevirtual

Checks whether the given sub-selection mode is allowed.

Parameters

[in]

mode

The selection mode to check.

Returns

True if the mode is allowed.

Implements ModelFunction.

setupFilters()

virtual void GeometrySurfacingFunction::setupFilters ( SelectionController * controller )

overridevirtual

Configures selection filters for the surfacing tool.

Parameters

[in]

controller

The selection controller to configure.

Reimplemented from ModelFunction.

---

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

• NDEVRSurfacingInterface/Headers/GeometrySurfacingWidget.h