NDEVR
API Documentation
PaperViewModelLogic

Logic for handling PaperView in the NDEVR space, including dialogs and imports. More...

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

Public Member Functions

 PaperViewModelLogic (QTModelManager *manager)
 Constructs the paper view model logic for the given manager.
virtual void setupPropertiesDialog (DesignObjectDialog *dialog, const DynamicPointer< QTDesignObject > &object) override
 Modifies property dialogs when paper view objects are created or selected.
virtual void setupUI (WindowManager *) override
 Override to set up custom UI elements for this model type.
Public Member Functions inherited from CustomModelLogic
virtual const UUIDid () const
 Returns the unique identifier for this custom model logic instance.
virtual void registerAll ()
 Registers all callbacks (context menu, tree widgets, dialog, NDV) with the manager.
const Buffer< String > & typeNames () const
 Returns the type names handled by this custom model logic.

Static Public Member Functions

static void SetEnabled (bool is_enabled, QTModelManager *manager)
 Enables or disables the default paper view model logic for the given manager.

Additional Inherited Members

Protected Member Functions inherited from CustomModelLogic
 CustomModelLogic (QTModelManager *manager, const Buffer< String > &type_names)
 Constructs a CustomModelLogic for multiple model type names.
 CustomModelLogic (QTModelManager *manager, const StringView &type_name)
 Constructs a CustomModelLogic for a single model type name.
virtual ~CustomModelLogic ()
 Destructor.
virtual void addMenuItems (Model &, QTModelManager *, QMenu &, const Buffer< UUID > &, const SelectionInfo &)
 Override to add custom context menu items when a model of this type is selected.
virtual bool canBeHandledBySelectionWidget () const
 Returns whether this model type can be handled by the generic selection widget.
ContextMenuCallbackcontextMenuCallback ()
 Returns the context menu callback for this model logic.
CustomDesignObjectDialogSetupCallback * dialogSetupCallback ()
 Returns the dialog setup callback for this model logic.
virtual void executeMenuItems (Model &, QTModelManager *, QAction *, const Buffer< UUID > &, const SelectionInfo &, PopupInfo)
 Override to handle execution of custom context menu actions.
NDVSetupCallbackndvFileReadLogic ()
 Returns the NDV file read setup callback for this model logic.
void setSorter (const std::function< bool(const Model &a, const Model &b)> &sort_function)
 Sets a custom sorting function for models of this type.
virtual void setTreeWidgetsForSelection (const Model &, Buffer< QWidget * > &, SceneTree *)
 Override to provide custom tree widgets shown when the model is selected.
virtual void setupModel (Model &)
 Override to perform setup when a model of this type is read from an NDV file.
CustomTreeWidgetstreeWidgetCallback ()
 Returns the tree widget callback for this model logic.
Protected Attributes inherited from CustomModelLogic
ContextMenuCallbackm_custom_context_menu = nullptr
 Callback for custom context menu actions.
CustomDesignObjectDialogSetupCallback * m_dialog_callback = nullptr
 Callback for customizing property dialogs.
UUID m_id
 The unique identifier for this logic instance.
QTModelManagerm_manager
 The model manager providing data context.
NDVSetupCallbackm_ndv_setup_callback = nullptr
 Callback for NDV file read setup.
CustomModelSorter * m_sorter = nullptr
 Custom sorting logic for the model type.
CustomTreeWidgetsm_tree_button_menu = nullptr
 Callback for custom tree selection widgets.
Buffer< Stringm_type_names
 The model type names handled by this logic.

Detailed Description

Logic for handling PaperView in the NDEVR space, including dialogs and imports.


SetEnabled enables all default PaperView logic.

Definition at line 11 of file PaperViewModelLogic.h.

Constructor & Destructor Documentation

◆ PaperViewModelLogic()

PaperViewModelLogic::PaperViewModelLogic ( QTModelManager * manager)

Constructs the paper view model logic for the given manager.

Parameters
[in]managerThe model manager to register with.

Member Function Documentation

◆ SetEnabled()

void PaperViewModelLogic::SetEnabled ( bool is_enabled,
QTModelManager * manager )
static

Enables or disables the default paper view model logic for the given manager.

Parameters
[in]is_enabledWhether to enable the paper view logic.
[in]managerThe model manager to register with.

◆ setupPropertiesDialog()

virtual void PaperViewModelLogic::setupPropertiesDialog ( DesignObjectDialog * dialog,
const DynamicPointer< QTDesignObject > & object )
overridevirtual

Modifies property dialogs when paper view objects are created or selected.

Parameters
[in]dialogThe properties dialog to modify.
[in]objectThe design object being inspected.

Reimplemented from CustomModelLogic.

◆ setupUI()

virtual void PaperViewModelLogic::setupUI ( WindowManager * )
overridevirtual

Override to set up custom UI elements for this model type.

Parameters
[in]managerThe window manager for creating UI components (unused parameter name).

Reimplemented from CustomModelLogic.


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