Class SBGEditor#

This class is the base class for Editor.

#include <SBGEditor.hpp>

Inherits the following classes: SBGWindowWidget

Public Slots inherited from SBGWindowWidget#

Type	Name
slot void	stopHighlighting

Public Signals#

Type	Name
signal void	editing (bool)

Public Signals inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
signal void	shown (bool) Emitted when the widget is shown or hidden.

Public Functions#

Type	Name
	SB_DECLARE_DATA (SBGEditor)
virtual void	beginEditing () Called when editing is about to begin.
virtual void	display (SBNode::RenderingPass renderingPass) To display elements related to the editor.
virtual void	display () To display elements related to the editor (deprecated)
virtual void	displayForInterface () To display interface elements related to the editor (deprecated)
virtual void	displayForShadow () To display shadowing elements related to the editor (deprecated)
virtual void	endEditing () Called when editing is about to end.
virtual void	getContextMenuActions (SBVector< SBGAction * > & actionVector) Returns the editor's context menu actions.
virtual QString	getDescription () const Returns the menu item text.
virtual int	getFormat () override const Returns the format.
virtual QPixmap	getLogo () override const Returns the pixmap logo.
virtual QString	getName () override const Returns the class name.
SBGWindowWidget *	getPropertyWidget () const Get the property window.
virtual void	getQuickAccessActions (SBVector< SBGAction * > & actionVector) Returns the editor's quick access actions.
virtual QKeySequence	getShortcut () const Returns the shortcut.
virtual QString	getToolTip () const Returns the tool tip.
virtual SBCContainerUUID	getUUID () override const Returns the widget UUID.
virtual void	handleMoveEvent (const SBPosition3 & position, SBNode * node) Handles mouse move event.
virtual void	handlePressEvent (const SBPosition3 & position, SBNode * node) Handles mouse press event.
virtual void	handleReleaseEvent (const SBPosition3 & position, SBNode * node) Handles mouse release event.
virtual bool	isSelectionDependent () const Returns true when the editor's context menu actions depend on the current selection.
virtual void	keyPressEvent (QKeyEvent * event) override Handles key press event.
virtual void	keyReleaseEvent (QKeyEvent * event) override Handles key release event.
virtual void	mouseDoubleClickEvent (QMouseEvent * event) override Handles mouse double click event.
virtual void	mouseMoveEvent (QMouseEvent * event) override Handles mouse move event.
virtual void	mousePressEvent (QMouseEvent * event) override Handles mouse press event.
virtual void	mouseReleaseEvent (QMouseEvent * event) override Handles mouse release event.
void	setPropertyWidget (SBGWindowWidget * propertyWidget) Set the property window.
virtual void	wheelEvent (QWheelEvent * event) override Handles wheel event.
virtual	~SBGEditor ()

Public Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
	SB_DECLARE_DATA (SBGWindowWidget)
virtual QString	getCitation () const Returns the citation information.
SBGWindowDock *	getDockWindow () const Returns the pointer to the embedding dock window, if any.
virtual int	getFormat () const Returns the format.
bool	getHighlightingFlag () const Returns the highlighting flag.
bool	getLockedFlag () const Returns whether the widget is locked (on top)
virtual QPixmap	getLogo () const Returns the pixmap logo.
virtual QString	getName () const Returns the widget name (used as a title for the embedding window)
virtual SBUUID	getUUID () const Returns the widget UUID.
SBGWindow *	getWindow () const Returns the pointer to the embedding window, if any.
void	highlight (const SBQuantity::second & duration=SBQuantity::second(1.0)) Highlights the widget for a moment.
void	loadDefaultSettings () Loads default settings.
virtual void	loadSettings (SBGSettings * settings) Loads `settings` .
void	saveDefaultSettings () Saves default settings.
virtual void	saveSettings (SBGSettings * settings) Saves `settings` .
void	setHighlightingFlag (bool highlightingFlag) Sets the highlighting flag.
void	setLockedFlag (bool lockedFlag) Sets whether the widget is locked (on top)
virtual	~SBGWindowWidget () Destructor.

Protected Attributes#

Type	Name
SBGWindowWidget *	propertyWidget

Protected Attributes inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
SBGWindowWidgetData *	dataPointer

Protected Functions#

Type	Name
	SBGEditor ()

Protected Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
	SBGWindowWidget ()
	SBGWindowWidget (SBGWindowWidgetData * dataPointer)
void	changeEvent (QEvent * event)
void	hideEvent (QHideEvent * event)
void	showEvent (QShowEvent * event)

Public Signals Documentation#

signal editing#

void editing;

Public Functions Documentation#

function SB_DECLARE_DATA#

SBGEditor::SB_DECLARE_DATA (
    SBGEditor
)

function beginEditing#

Called when editing is about to begin.

virtual void SBGEditor::beginEditing ()

function display [1/2]#

To display elements related to the editor.

virtual void SBGEditor::display (
    SBNode::RenderingPass renderingPass
)

function display [2/2]#

To display elements related to the editor (deprecated)

virtual void SBGEditor::display ()

function displayForInterface#

To display interface elements related to the editor (deprecated)

virtual void SBGEditor::displayForInterface ()

function displayForShadow#

To display shadowing elements related to the editor (deprecated)

virtual void SBGEditor::displayForShadow ()

function endEditing#

Called when editing is about to end.

virtual void SBGEditor::endEditing ()

function getContextMenuActions#

Returns the editor's context menu actions.

virtual void SBGEditor::getContextMenuActions (
    SBVector< SBGAction * > & actionVector
)

function getDescription#

Returns the menu item text.

virtual QString SBGEditor::getDescription () const

function getFormat#

Returns the format.

virtual int SBGEditor::getFormat () override const

Implements SBGWindowWidget::getFormat

function getLogo#

Returns the pixmap logo.

virtual QPixmap SBGEditor::getLogo () override const

Implements SBGWindowWidget::getLogo

function getName#

Returns the class name.

virtual QString SBGEditor::getName () override const

Implements SBGWindowWidget::getName

function getPropertyWidget#

Get the property window.

SBGWindowWidget * SBGEditor::getPropertyWidget () const

function getQuickAccessActions#

Returns the editor's quick access actions.

virtual void SBGEditor::getQuickAccessActions (
    SBVector< SBGAction * > & actionVector
)

function getShortcut#

Returns the shortcut.

virtual QKeySequence SBGEditor::getShortcut () const

function getToolTip#

Returns the tool tip.

virtual QString SBGEditor::getToolTip () const

function getUUID#

Returns the widget UUID.

virtual SBCContainerUUID SBGEditor::getUUID () override const

Implements SBGWindowWidget::getUUID

function handleMoveEvent#

Handles mouse move event.

virtual void SBGEditor::handleMoveEvent (
    const SBPosition3 & position,
    SBNode * node
)

function handlePressEvent#

Handles mouse press event.

virtual void SBGEditor::handlePressEvent (
    const SBPosition3 & position,
    SBNode * node
)

function handleReleaseEvent#

Handles mouse release event.

virtual void SBGEditor::handleReleaseEvent (
    const SBPosition3 & position,
    SBNode * node
)

function isSelectionDependent#

Returns true when the editor's context menu actions depend on the current selection.

virtual bool SBGEditor::isSelectionDependent () const

function keyPressEvent#

Handles key press event.

virtual void SBGEditor::keyPressEvent (
    QKeyEvent * event
) override

function keyReleaseEvent#

Handles key release event.

virtual void SBGEditor::keyReleaseEvent (
    QKeyEvent * event
) override

function mouseDoubleClickEvent#

Handles mouse double click event.

virtual void SBGEditor::mouseDoubleClickEvent (
    QMouseEvent * event
) override

function mouseMoveEvent#

Handles mouse move event.

virtual void SBGEditor::mouseMoveEvent (
    QMouseEvent * event
) override

function mousePressEvent#

Handles mouse press event.

virtual void SBGEditor::mousePressEvent (
    QMouseEvent * event
) override

function mouseReleaseEvent#

Handles mouse release event.

virtual void SBGEditor::mouseReleaseEvent (
    QMouseEvent * event
) override

function setPropertyWidget#

Set the property window.

void SBGEditor::setPropertyWidget (
    SBGWindowWidget * propertyWidget
)

function wheelEvent#

Handles wheel event.

virtual void SBGEditor::wheelEvent (
    QWheelEvent * event
) override

function ~SBGEditor#

virtual SBGEditor::~SBGEditor ()

Protected Attributes Documentation#

variable propertyWidget#

SBGWindowWidget* propertyWidget;

Protected Functions Documentation#

function SBGEditor#

SBGEditor::SBGEditor ()