NDEVR
API Documentation
LineOfSightEditor

A popup Editor dialog for showing options or information related to LineOfSight model objects. More...

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

Public Member Functions

 LineOfSightEditor (const DynamicPointer< QTDesignObject > &line_of_sight, QWidget *parent=nullptr)
 Constructs a LineOfSightEditor for the given line-of-sight design object.
LineOfSight lineOfSight () const
 Returns the LineOfSight object being edited.
void moveCameraToLineOfSight (UUID camera_id=Constant< UUID >::Invalid) const
 Moves the specified camera to the line-of-sight viewpoint.
void updateAllLineOfSights ()
 Recalculates all line-of-sight analyses in the scene.
void updateLineOfSiteFromDialog ()
 Updates the line-of-sight model from the current dialog values.
virtual void updateValues () override
 Refreshes the editor UI to reflect the current state of the line-of-sight object.
Public Member Functions inherited from Editor
 Editor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
 Constructs an Editor targeting the given design object.
 Editor (QWidget *parent=nullptr)
 Constructs an Editor with no design object target.
virtual Buffer< QWidget * > bottomOptions ()
 Returns widgets to be placed at the bottom of the editor layout.
virtual StringView customDialogIcon () const
 Returns a custom icon name for the editor dialog, or an empty string if none.
virtual TranslatedString customDialogTitle () const
 Returns a custom title for the editor dialog, or an empty string if none.
virtual bool disableExport () const
 Returns whether exporting should be disabled for this editor.
Model getModel () const
 Returns the target design object as a Model.
DesignObject getObject () const
 Returns the target design object.
virtual bool isBusy () const
 Returns whether the editor is currently busy performing an operation.
void isBusyStatusChanged ()
 Emitted when the busy status of the editor changes.
virtual bool isHorizontal () const
 Returns whether the editor layout is horizontal.
virtual void moveTargetWithMouse ()
 Initiates interactive mouse-based movement of the target object in the viewport.
void objectUpdatedSignal ()
 Emitted when the target object has been updated.
virtual InterfaceOrientationControllerorientationController () const
 Returns the orientation controller associated with this editor.
virtual Buffer< QWidget * > printableWidgetOptions ()
 Returns option widgets to configure printing for this editor.
virtual Buffer< QWidget * > printableWidgets ()
 Returns the widgets that can be printed from this editor.
virtual void requestScrollEnabled (bool enabled)
 Requests enabling or disabling scrolling within the editor.
virtual void setHorizontal (bool horizontal)
 Sets whether the editor layout is horizontal.
virtual void setReadOnly (bool read_only)
 Sets whether the editor is in read-only mode.
virtual void setTarget (const DynamicPointer< QTDesignObject > &object)
 Sets the design object target for this editor.
virtual void setup (DesignObjectDialog *, const ShowPropertiesSettings &)
 Sets up the editor with a parent dialog and property display settings.
virtual EditorShowMode showMode () const
 Returns the preferred display mode for this editor.
const DynamicPointer< QTDesignObject > & target () const
 Returns the current design object target.

Protected Attributes

BasicThreadm_los_all_thread = nullptr
 Background thread for computing all line-of-sight analyses.
BasicThreadm_los_thread = nullptr
 Background thread for computing a single line-of-sight analysis.
Ui::LineOfSightEditorUI * ui
 The auto-generated UI form for the editor.
Protected Attributes inherited from Editor
DynamicPointer< QTDesignObjectm_design_object
 The design object being edited.
bool m_is_read_only = false
 Whether the editor is in read-only mode.
InterfaceOrientationControllerm_orientation_controller
 The orientation controller for this editor.

Additional Inherited Members

Protected Member Functions inherited from Editor
void onDesignObjectDeletedSlot ()
 Slot called when the target design object is deleted.
void onDesignObjectUpdateSlot ()
 Slot called when the target design object is updated.

Detailed Description

A popup Editor dialog for showing options or information related to LineOfSight model objects.


Definition at line 14 of file LineOfSightEditor.h.

Constructor & Destructor Documentation

◆ LineOfSightEditor()

LineOfSightEditor::LineOfSightEditor ( const DynamicPointer< QTDesignObject > & line_of_sight,
QWidget * parent = nullptr )

Constructs a LineOfSightEditor for the given line-of-sight design object.

Parameters
[in]line_of_sightThe line-of-sight design object to edit.
[in]parentThe parent widget, or nullptr if no parent.

References LineOfSightEditor().

Referenced by LineOfSightEditor().

Member Function Documentation

◆ lineOfSight()

LineOfSight LineOfSightEditor::lineOfSight ( ) const

Returns the LineOfSight object being edited.

Returns
The current LineOfSight.

◆ moveCameraToLineOfSight()

void LineOfSightEditor::moveCameraToLineOfSight ( UUID camera_id = ConstantUUID >::Invalid) const

Moves the specified camera to the line-of-sight viewpoint.

Parameters
[in]camera_idThe UUID of the camera to move, or Invalid to use the active camera.

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