SBGEditor Class Reference

This class is the base class for Editor.

Public Types

enum  RenderingPass {
  RenderingPass::Setup,
  RenderingPass::OpaqueGeometry,
  RenderingPass::SelectableGeometry,
  RenderingPass::ShadowingGeometry,
  RenderingPass::TransparentGeometry,
  RenderingPass::Interface,
  RenderingPass::Text
}
 The rendering pass. More...
 

Signals

void editing (bool)
 
- Signals inherited from SBGWindowWidget
void shown (bool)
 Emitted when the widget is shown or hidden.
 

Identity

virtual SBCContainerUUID getUUID () const
 Returns the widget UUID.
 
virtual QString getName () const
 Returns the class name.
 
virtual QString getDescription () const
 Returns the menu item text.
 
virtual QPixmap getLogo () const
 Returns the pixmap logo.
 
virtual int getFormat () const
 Returns the format.
 
virtual QKeySequence getShortcut () const
 Returns the shorcut.
 
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 (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

SBGWindowWidgetgetPropertyWidget () const
 Get the property window.
 
void setPropertyWidget (SBGWindowWidget *propertyWidget)
 Set the property window.
 

GUI attributes

SBGWindowWidgetpropertyWidget
 

Additional Inherited Members

- Public Member Functions inherited from SBGWindowWidget
 SB_DECLARE_DATA (SBGWindowWidget)
 
virtual ~SBGWindowWidget ()
 Destructor.
 
virtual QString getCitation () const
 Returns the citation information.
 
SBGWindowgetWindow () const
 Returns the pointer to the embedding SAMSON window.
 
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)
 
bool getHighlightingFlag () const
 Returns the highlighting flag.
 
void setHighlightingFlag (bool highlightingFlag)
 Sets the highlighting flag.
 
- Protected Member Functions inherited from SBGWindowWidget
void hideEvent (QHideEvent *event)
 
void showEvent (QShowEvent *event)
 
 SBGWindowWidget ()
 
 SBGWindowWidget (SBGWindowWidgetData *dataPointer)
 Builds a particle at position p.
 
- Protected Attributes inherited from SBGWindowWidget
SBGWindowWidgetData * dataPointer
 

Member Enumeration Documentation

◆ RenderingPass

Enumerator
Setup 

The pass where setup is performed (no rendering occurs)

OpaqueGeometry 

The pass where opaque geometry is rendered.

SelectableGeometry 

The pass where selectable geometry is rendered.

ShadowingGeometry 

The pass where shadowing geometry is rendered.

TransparentGeometry 

The pass where transparent geometry is rendered.

Interface 

The pass where 2D and 3D interface components are rendered.

Text 

The pass where text is rendered.