SHAPER  9.12.0
SHAPERGUI_SalomeViewer Class Referenceabstract

A class for providing access of SHAPERGUI functionality to SALOME viewer functionality. More...

Inheritance diagram for SHAPERGUI_SalomeViewer:
Inheritance graph

Public Types

typedef std::list< std::pair< std::wstring, std::vector< int > > > TextColor
 Type for mapping from text to color to display the names lines in different colors. More...
 

Signals

void lastViewClosed ()
 Signal emited when last view window is closed. More...
 
void tryCloseView (ModuleBase_IViewWindow *theWnd)
 Signal emited before view window is closed. More...
 
void deleteView (ModuleBase_IViewWindow *theWnd)
 Signal emited on delete view window. More...
 
void viewCreated (ModuleBase_IViewWindow *theWnd)
 Signal emited on creation of view window. More...
 
void activated (ModuleBase_IViewWindow *theWnd)
 Signal emited on key release. More...
 
void mousePress (ModuleBase_IViewWindow *theWnd, QMouseEvent *theEvent)
 Signal emited on mouse press. More...
 
void mouseRelease (ModuleBase_IViewWindow *theWnd, QMouseEvent *theEvent)
 Signal emited on mouse release. More...
 
void mouseDoubleClick (ModuleBase_IViewWindow *theWnd, QMouseEvent *theEvent)
 Signal emited on mouse double click. More...
 
void mouseMove (ModuleBase_IViewWindow *theWnd, QMouseEvent *theEvent)
 Signal emited on mouse move. More...
 
void keyPress (ModuleBase_IViewWindow *theWnd, QKeyEvent *theEvent)
 Signal emited on key press. More...
 
void keyRelease (ModuleBase_IViewWindow *theWnd, QKeyEvent *theEvent)
 Signal emited on key release. More...
 
void selectionChanged ()
 Signal emited on selection changed. More...
 
void contextMenuRequested (QContextMenuEvent *)
 Signal emited on selection changed. More...
 
void viewTransformed (int theTransformation)
 Signal emitted on transformation of view point in view window. More...
 
void trihedronVisibilityChanged (bool theState)
 Signal emited on selection changed. More...
 

Public Member Functions

 SHAPERGUI_SalomeViewer (QObject *theParent)
 Constructor. More...
 
virtual HandleAAISContext () const
 Returns AIS_InteractiveContext from current OCCViewer. More...
 
virtual Handlevv3dViewer () const
 Retrurns V3d_Vioewer from current viewer. More...
 
virtual Handlettrihedron () const
 Trihedron 3d object shown in the viewer. More...
 
virtual HandleaactiveView () const
 Returns Vsd_View object from currently active view window. More...
 
virtual QWidgetactiveViewPort () const
 Returns viewer view port. More...
 
virtual void enableSelection (bool isEnabled)
 Enable or disable selection in the viewer. More...
 
virtual bool isSelectionEnabled () const
 Returns true if selection is enabled. More...
 
virtual void enableMultiselection (bool isEnable)
 Enable or disable multiselection in the viewer. More...
 
virtual bool isMultiSelectionEnabled () const
 Returns true if multiselection is enabled. More...
 
virtual bool enableDrawMode (bool isEnabled)
 Enable or disable draw mode in the viewer. More...
 
void reconnectActions (SUIT_ViewWindow *theWindow, const bool theUseSHAPERSlot)
 For some signals it disconnects the window from usual signal and connect it to the module ones. More...
 
virtual void fitAll ()
 Perfroms the fit all for the active view. More...
 
virtual void eraseAll ()
 Erases all presentations from the viewer. More...
 
virtual void setViewProjection (double theX, double theY, double theZ, double theTwist)
 Sets the view projection. More...
 
void setSelector (SHAPERGUI_OCCSelector *theSel)
 Set selector. More...
 
virtual void addSelectionFilter (const Handle &&theFilter)
 Add selection filter to the viewer. More...
 
virtual void removeSelectionFilter (const Handle &&theFilter)
 Remove selection filter from the viewer. More...
 
virtual bool hasSelectionFilter (const Handle &&theFilter)
 Returns true if the selection filter is set to the viewer. More...
 
virtual void clearSelectionFilters ()
 Remove all selection filters from the viewer. More...
 
SHAPERGUI_OCCSelectorselector () const
 Returns current selector. More...
 
virtual void update ()
 Update current viewer. More...
 
virtual bool canDragByMouse () const
 Method returns True if the viewer can process editing objects by mouse drugging. More...
 
void activateViewer (bool toActivate)
 Activate or deactivate viewer. More...
 
virtual bool isColorScaleVisible () const
 Returns True if ColorScale is visible. More...
 
virtual void setColorScaleShown (bool on)
 Show/Hide ColorScale object. More...
 
virtual void setColorScalePosition (double theX, double theY)
 Set position of color scale. More...
 
virtual void setColorScaleSize (double theW, double theH)
 Set size of color scale. More...
 
virtual void setColorScaleRange (double theMin, double theMax)
 Set range of color scale. More...
 
virtual void setColorScaleIntervals (int theNb)
 Set number of intervals of color scale. More...
 
virtual void setColorScaleTextHeigth (int theH)
 Set text heigth of color scale. More...
 
virtual void setColorScaleTextColor (const QColor &theColor)
 Set color of text of color scale. More...
 
virtual void setColorScaleTitle (const QString &theText)
 Set title of color scale. More...
 
virtual void setText (const ModuleBase_IViewer::TextColor &theText, const int theSize)
 Sets the text displayed in right-top corner of the 3D view. More...
 
virtual void setFitter (OCCViewer_Fitter *theFitter)
 
virtual OCCViewer_Fitter * fitter () const
 
const double Scale (const Handle &&theView)
 Returns a scale factor of the given view. More...
 
void SetScale (const Handle &&theView, const double theVal)
 Remember a scale factor for the view object. More...
 
virtual void updateHighlight ()
 Fit all along Z (perpendicular to display) More...
 
void set2dMode (bool is2d)
 Set flag which indicates that viewer is used for 2d operations. More...
 
bool is2dMode () const
 Returns current state of 2d mode flag. More...
 
void showSelectionHighlight ()
 Switches On additional highlight for objects preselection. More...
 
void hideSelectionHighlight ()
 Switches Off additional highlight for objects preselection. More...
 
virtual void setFitter (AppElements_Fitter *theFitter)=0
 

Static Public Attributes

static HandleDDefaultHighlightDrawer
 

Protected Attributes

QMap< Handle,, double > myWindowScale
 A map for storing a scale factors dependent on view object. More...
 
bool myIs2dMode
 
bool myShowHighlight
 

Detailed Description

A class for providing access of SHAPERGUI functionality to SALOME viewer functionality.

Member Typedef Documentation

◆ TextColor

typedef std::list<std::pair<std::wstring, std::vector<int> > > ModuleBase_IViewer::TextColor
inherited

Type for mapping from text to color to display the names lines in different colors.

Constructor & Destructor Documentation

◆ SHAPERGUI_SalomeViewer()

SHAPERGUI_SalomeViewer::SHAPERGUI_SalomeViewer ( QObject theParent)

Constructor.

Parameters
theParenta parent object

Member Function Documentation

◆ HandleAAISContext()

virtual SHAPERGUI_SalomeViewer::HandleAAISContext ( ) const
virtual

Returns AIS_InteractiveContext from current OCCViewer.

Implements ModuleBase_IViewer.

◆ Handlevv3dViewer()

virtual SHAPERGUI_SalomeViewer::Handlevv3dViewer ( ) const
virtual

Retrurns V3d_Vioewer from current viewer.

Implements ModuleBase_IViewer.

◆ Handlettrihedron()

virtual SHAPERGUI_SalomeViewer::Handlettrihedron ( ) const
virtual

Trihedron 3d object shown in the viewer.

Implements ModuleBase_IViewer.

◆ HandleaactiveView()

virtual SHAPERGUI_SalomeViewer::HandleaactiveView ( ) const
virtual

Returns Vsd_View object from currently active view window.

Implements ModuleBase_IViewer.

◆ activeViewPort()

QWidget * SHAPERGUI_SalomeViewer::activeViewPort ( ) const
virtual

Returns viewer view port.

Implements ModuleBase_IViewer.

◆ enableSelection()

void SHAPERGUI_SalomeViewer::enableSelection ( bool  isEnabled)
virtual

Enable or disable selection in the viewer.

Implements ModuleBase_IViewer.

◆ isSelectionEnabled()

bool SHAPERGUI_SalomeViewer::isSelectionEnabled ( ) const
virtual

Returns true if selection is enabled.

Implements ModuleBase_IViewer.

◆ enableMultiselection()

void SHAPERGUI_SalomeViewer::enableMultiselection ( bool  isEnable)
virtual

Enable or disable multiselection in the viewer.

Implements ModuleBase_IViewer.

◆ isMultiSelectionEnabled()

bool SHAPERGUI_SalomeViewer::isMultiSelectionEnabled ( ) const
virtual

Returns true if multiselection is enabled.

Implements ModuleBase_IViewer.

◆ enableDrawMode()

bool SHAPERGUI_SalomeViewer::enableDrawMode ( bool  isEnabled)
virtual

Enable or disable draw mode in the viewer.

Implements ModuleBase_IViewer.

◆ reconnectActions()

void SHAPERGUI_SalomeViewer::reconnectActions ( SUIT_ViewWindow *  theWindow,
const bool  theUseSHAPERSlot 
)

For some signals it disconnects the window from usual signal and connect it to the module ones.

◆ fitAll()

void SHAPERGUI_SalomeViewer::fitAll ( )
virtual

Perfroms the fit all for the active view.

Implements ModuleBase_IViewer.

◆ eraseAll()

void SHAPERGUI_SalomeViewer::eraseAll ( )
virtual

Erases all presentations from the viewer.

Implements ModuleBase_IViewer.

◆ setViewProjection()

void SHAPERGUI_SalomeViewer::setViewProjection ( double  theX,
double  theY,
double  theZ,
double  theTwist 
)
virtual

Sets the view projection.

Parameters
theXthe X projection value
theYthe Y projection value
theZthe Z projection value
theTwistthe twist angle in radians

Implements ModuleBase_IViewer.

◆ setSelector()

void SHAPERGUI_SalomeViewer::setSelector ( SHAPERGUI_OCCSelector theSel)

Set selector.

Parameters
theSela selector instance

◆ addSelectionFilter()

void SHAPERGUI_SalomeViewer::addSelectionFilter ( const Handle &&  theFilter)
virtual

Add selection filter to the viewer.

Implements ModuleBase_IViewer.

◆ removeSelectionFilter()

void SHAPERGUI_SalomeViewer::removeSelectionFilter ( const Handle &&  theFilter)
virtual

Remove selection filter from the viewer.

Implements ModuleBase_IViewer.

◆ hasSelectionFilter()

bool SHAPERGUI_SalomeViewer::hasSelectionFilter ( const Handle &&  theFilter)
virtual

Returns true if the selection filter is set to the viewer.

Parameters
theFiltera selection filter

Implements ModuleBase_IViewer.

◆ clearSelectionFilters()

void SHAPERGUI_SalomeViewer::clearSelectionFilters ( )
virtual

Remove all selection filters from the viewer.

◆ selector()

SHAPERGUI_OCCSelector* SHAPERGUI_SalomeViewer::selector ( ) const
inline

Returns current selector.

◆ update()

void SHAPERGUI_SalomeViewer::update ( )
virtual

Update current viewer.

Implements ModuleBase_IViewer.

◆ canDragByMouse()

bool SHAPERGUI_SalomeViewer::canDragByMouse ( ) const
virtual

Method returns True if the viewer can process editing objects by mouse drugging.

If this is impossible thet it has to return False.

Reimplemented from ModuleBase_IViewer.

◆ activateViewer()

void SHAPERGUI_SalomeViewer::activateViewer ( bool  toActivate)

Activate or deactivate viewer.

Parameters
toActivate- activation flag

◆ isColorScaleVisible()

bool SHAPERGUI_SalomeViewer::isColorScaleVisible ( ) const
virtual

Returns True if ColorScale is visible.

Implements ModuleBase_IViewer.

◆ setColorScaleShown()

void SHAPERGUI_SalomeViewer::setColorScaleShown ( bool  on)
virtual

Show/Hide ColorScale object.

Implements ModuleBase_IViewer.

◆ setColorScalePosition()

void SHAPERGUI_SalomeViewer::setColorScalePosition ( double  theX,
double  theY 
)
virtual

Set position of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleSize()

void SHAPERGUI_SalomeViewer::setColorScaleSize ( double  theW,
double  theH 
)
virtual

Set size of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleRange()

void SHAPERGUI_SalomeViewer::setColorScaleRange ( double  theMin,
double  theMax 
)
virtual

Set range of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleIntervals()

void SHAPERGUI_SalomeViewer::setColorScaleIntervals ( int  theNb)
virtual

Set number of intervals of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleTextHeigth()

void SHAPERGUI_SalomeViewer::setColorScaleTextHeigth ( int  theH)
virtual

Set text heigth of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleTextColor()

void SHAPERGUI_SalomeViewer::setColorScaleTextColor ( const QColor &  theColor)
virtual

Set color of text of color scale.

Implements ModuleBase_IViewer.

◆ setColorScaleTitle()

void SHAPERGUI_SalomeViewer::setColorScaleTitle ( const QString &  theText)
virtual

Set title of color scale.

Implements ModuleBase_IViewer.

◆ setText()

void SHAPERGUI_SalomeViewer::setText ( const ModuleBase_IViewer::TextColor theText,
const int  theSize 
)
virtual

Sets the text displayed in right-top corner of the 3D view.

Parameters
theTextthe text to display, or empty string to erase presentation; the first item is the font name and text color
theSizesize of the text font

Implements ModuleBase_IViewer.

◆ Scale()

const double ModuleBase_IViewer::Scale ( const Handle &&  theView)
inlineinherited

Returns a scale factor of the given view.

Parameters
theViewa view object

◆ SetScale()

void ModuleBase_IViewer::SetScale ( const Handle &&  theView,
const double  theVal 
)
inlineinherited

Remember a scale factor for the view object.

Parameters
theViewa view object
theVala scale factor

◆ updateHighlight()

virtual void ModuleBase_IViewer::updateHighlight ( )
inlinevirtualinherited

Fit all along Z (perpendicular to display)

Show highlight for pre-highlighted sub-shape

Reimplemented in XGUI_ViewerProxy.

◆ set2dMode()

void ModuleBase_IViewer::set2dMode ( bool  is2d)
inlineinherited

Set flag which indicates that viewer is used for 2d operations.

Parameters
is2da new 2d mode state

◆ is2dMode()

bool ModuleBase_IViewer::is2dMode ( ) const
inlineinherited

Returns current state of 2d mode flag.

◆ showSelectionHighlight()

void ModuleBase_IViewer::showSelectionHighlight ( )
inlineinherited

Switches On additional highlight for objects preselection.

◆ hideSelectionHighlight()

void ModuleBase_IViewer::hideSelectionHighlight ( )
inlineinherited

Switches Off additional highlight for objects preselection.

◆ lastViewClosed

void ModuleBase_IViewer::lastViewClosed ( )
signalinherited

Signal emited when last view window is closed.

◆ tryCloseView

void ModuleBase_IViewer::tryCloseView ( ModuleBase_IViewWindow theWnd)
signalinherited

Signal emited before view window is closed.

◆ deleteView

void ModuleBase_IViewer::deleteView ( ModuleBase_IViewWindow theWnd)
signalinherited

Signal emited on delete view window.

◆ viewCreated

void ModuleBase_IViewer::viewCreated ( ModuleBase_IViewWindow theWnd)
signalinherited

Signal emited on creation of view window.

◆ activated

void ModuleBase_IViewer::activated ( ModuleBase_IViewWindow theWnd)
signalinherited

Signal emited on key release.

◆ mousePress

void ModuleBase_IViewer::mousePress ( ModuleBase_IViewWindow theWnd,
QMouseEvent *  theEvent 
)
signalinherited

Signal emited on mouse press.

◆ mouseRelease

void ModuleBase_IViewer::mouseRelease ( ModuleBase_IViewWindow theWnd,
QMouseEvent *  theEvent 
)
signalinherited

Signal emited on mouse release.

◆ mouseDoubleClick

void ModuleBase_IViewer::mouseDoubleClick ( ModuleBase_IViewWindow theWnd,
QMouseEvent *  theEvent 
)
signalinherited

Signal emited on mouse double click.

◆ mouseMove

void ModuleBase_IViewer::mouseMove ( ModuleBase_IViewWindow theWnd,
QMouseEvent *  theEvent 
)
signalinherited

Signal emited on mouse move.

◆ keyPress

void ModuleBase_IViewer::keyPress ( ModuleBase_IViewWindow theWnd,
QKeyEvent *  theEvent 
)
signalinherited

Signal emited on key press.

◆ keyRelease

void ModuleBase_IViewer::keyRelease ( ModuleBase_IViewWindow theWnd,
QKeyEvent *  theEvent 
)
signalinherited

Signal emited on key release.

◆ selectionChanged

void ModuleBase_IViewer::selectionChanged ( )
signalinherited

Signal emited on selection changed.

◆ contextMenuRequested

void ModuleBase_IViewer::contextMenuRequested ( QContextMenuEvent *  )
signalinherited

Signal emited on selection changed.

◆ viewTransformed

void ModuleBase_IViewer::viewTransformed ( int  theTransformation)
signalinherited

Signal emitted on transformation of view point in view window.

Parameters
theTransformationtype of transformation (see AppElements_ViewWindow::OperationType)

◆ trihedronVisibilityChanged

void ModuleBase_IViewer::trihedronVisibilityChanged ( bool  theState)
signalinherited

Signal emited on selection changed.

Field Documentation

◆ myWindowScale

QMap<Handle,, double> ModuleBase_IViewer::myWindowScale
protectedinherited

A map for storing a scale factors dependent on view object.