NDEVR
API Documentation
CameraEditor

Editor for a Virtual Camera which allows for adjustment of background colors, locations, etc. More...

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

Public Member Functions

 CameraEditor (QTModelManager *manager, const DynamicPointer< Camera > &camera, QWidget *parent=Q_NULLPTR)
 Constructs a CameraEditor for the given camera.
virtual ~CameraEditor ()
 Destructor.
void setHorizontal (bool horizontal) override
 Switches the editor layout between horizontal and vertical orientation.
void showEvent (QShowEvent *event) override
 Handles the show event to refresh the editor when it becomes visible.
void updateFar (double value)
 Slot invoked when the far clipping plane distance is changed.
void updateName ()
 Slot invoked when the camera name is changed by the user.
void updateNear (double value)
 Slot invoked when the near clipping plane distance is changed.
void updateOrientation ()
 Slot invoked when the camera orientation is changed by the user.
void updateValues () override
 Updates all displayed values from the current camera state.
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 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.

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.
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.

Detailed Description

Editor for a Virtual Camera which allows for adjustment of background colors, locations, etc.


Definition at line 50 of file CameraEditor.h.

Constructor & Destructor Documentation

◆ CameraEditor()

CameraEditor::CameraEditor ( QTModelManager * manager,
const DynamicPointer< Camera > & camera,
QWidget * parent = Q_NULLPTR )

Constructs a CameraEditor for the given camera.

Parameters
[in]managerThe model manager providing data context.
[in]cameraThe camera to edit.
[in]parentThe optional parent widget.

Member Function Documentation

◆ setHorizontal()

void CameraEditor::setHorizontal ( bool horizontal)
overridevirtual

Switches the editor layout between horizontal and vertical orientation.

Parameters
[in]horizontalWhether to use horizontal layout.

Reimplemented from Editor.

◆ showEvent()

void CameraEditor::showEvent ( QShowEvent * event)
override

Handles the show event to refresh the editor when it becomes visible.

Parameters
[in]eventThe show event.

◆ updateFar()

void CameraEditor::updateFar ( double value)

Slot invoked when the far clipping plane distance is changed.

Parameters
[in]valueThe new far clipping plane distance.

◆ updateNear()

void CameraEditor::updateNear ( double value)

Slot invoked when the near clipping plane distance is changed.

Parameters
[in]valueThe new near clipping plane distance.

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