SBGEditor Class Reference

This class is the base class for Editor.

GUI attributes <br>
SBGWindowWidget *	propertyWidget

Identity
virtual SBCContainerUUID	getUUID () const override
	Returns the widget UUID.
virtual QString	getName () const override
	Returns the class name.
virtual QString	getDescription () const
	Returns the menu item text.
virtual QPixmap	getLogo () const override
	Returns the pixmap logo.
virtual int	getFormat () const override
	Returns the format.
virtual QKeySequence	getShortcut () const
	Returns the shortcut.
virtual QString	getToolTip () const
	Returns the tool tip.

Editing
virtual void	beginEditing ()
	Called when editing is about to begin.
virtual void	endEditing ()
	Called when editing is about to end.

Actions
virtual bool	isSelectionDependent () const
	Returns true when the editor's context menu actions depend on the current selection.
virtual void	getQuickAccessActions (SBVector< SBGAction * > &actionVector)
	Returns the editor's quick access actions.
virtual void	getContextMenuActions (SBVector< SBGAction * > &actionVector)
	Returns the editor's context menu actions.

Event
virtual void	mousePressEvent (QMouseEvent *event)
	Handles mouse press event.
virtual void	mouseReleaseEvent (QMouseEvent *event)
	Handles mouse release event.
virtual void	mouseMoveEvent (QMouseEvent *event)
	Handles mouse move event.
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	Handles mouse double click event.
virtual void	wheelEvent (QWheelEvent *event)
	Handles wheel event.
virtual void	keyPressEvent (QKeyEvent *event)
	Handles key press event.
virtual void	keyReleaseEvent (QKeyEvent *event)
	Handles key release 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 void	handleMoveEvent (const SBPosition3 &position, SBNode *node)
	Handles mouse move event.

Display
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)

GUI
SBGWindowWidget *	getPropertyWidget () const
	Get the property window.
void	setPropertyWidget (SBGWindowWidget *propertyWidget)
	Set the property window.
	SB_DECLARE_DATA (SBGEditor)
void	editing (bool)
	SBGEditor ()

Additional Inherited Members
Public Slots inherited from SBGWindowWidget
void	stopHighlighting ()
Signals inherited from SBGWindowWidget
void	shown (bool)
	Emitted when the widget is shown or hidden.
Public Member Functions inherited from SBGWindowWidget
virtual	~SBGWindowWidget ()
	Destructor.
virtual QString	getCitation () const
	Returns the citation information.
SBGWindow *	getWindow () const
	Returns the pointer to the embedding window, if any.
SBGWindowDock *	getDockWindow () const
	Returns the pointer to the embedding dock window, if any.
virtual void	loadSettings (SBGSettings *settings)
	Loads settings.
virtual void	saveSettings (SBGSettings *settings)
	Saves settings.
void	loadDefaultSettings ()
	Loads default settings
void	saveDefaultSettings ()
	Saves default settings
void	setLockedFlag (bool lockedFlag)
	Sets whether the widget is locked (on top)
bool	getLockedFlag () const
	Returns whether the widget is locked (on top)
void	highlight (const SBQuantity::second &duration=SBQuantity::second(1.0))
	Highlights the widget for a moment.
bool	getHighlightingFlag () const
	Returns the highlighting flag.
void	setHighlightingFlag (bool highlightingFlag)
	Sets the highlighting flag.
	SB_DECLARE_DATA (SBGWindowWidget)
Protected Member Functions inherited from SBGWindowWidget
	SBGWindowWidget ()
	SBGWindowWidget (SBGWindowWidgetData *dataPointer)
void	hideEvent (QHideEvent *event)
void	showEvent (QShowEvent *event)
void	changeEvent (QEvent *event)
Protected Attributes inherited from SBGWindowWidget
SBGWindowWidgetData *	dataPointer

Member Function Documentation

getFormat()

int SBGEditor::getFormat ( ) const

overridevirtual

Reimplemented from SBGWindowWidget.

getLogo()

QPixmap SBGEditor::getLogo ( ) const

overridevirtual

Reimplemented from SBGWindowWidget.

getName()

QString SBGEditor::getName ( ) const

overridevirtual

Reimplemented from SBGWindowWidget.

getUUID()

SBCContainerUUID SBGEditor::getUUID ( ) const

overridevirtual

Reimplemented from SBGWindowWidget.