1 // Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // Author : OPEN CASCADE
24 // File: GLViewer_Viewer.cxx
25 // Created: November, 2004
26 //#include <GLViewerAfx.h>
28 #include "GLViewer_Viewer.h"
29 #include "GLViewer_Selector.h"
30 #include "GLViewer_ViewPort.h"
31 #include "GLViewer_ViewFrame.h"
33 //#include "SUIT_Desktop.h"
34 #include "SUIT_ViewWindow.h"
35 #include "SUIT_ViewManager.h"
37 #include <QApplication>
39 #include <QColorDialog>
40 #include <QMouseEvent>
41 #include <QWheelEvent>
43 #include <QRubberBand>
45 /* used for sketching */
46 static QEvent* l_mbPressEvent = 0;
51 GLViewer_Viewer::GLViewer_Viewer( const QString& /*title*/ )
54 mySelMode( NoSelection ),
63 GLViewer_Viewer::~GLViewer_Viewer()
70 \param theViewManager - new view manager
72 void GLViewer_Viewer::setViewManager(SUIT_ViewManager* theViewManager)
74 SUIT_ViewModel::setViewManager(theViewManager);
77 connect(theViewManager, SIGNAL(mousePress(SUIT_ViewWindow*, QMouseEvent*)),
78 this, SLOT(onMouseEvent(SUIT_ViewWindow*, QMouseEvent*)));
80 connect(theViewManager, SIGNAL(mouseMove(SUIT_ViewWindow*, QMouseEvent*)),
81 this, SLOT(onMouseEvent(SUIT_ViewWindow*, QMouseEvent*)));
83 connect(theViewManager, SIGNAL(mouseRelease(SUIT_ViewWindow*, QMouseEvent*)),
84 this, SLOT(onMouseEvent(SUIT_ViewWindow*, QMouseEvent*)));
86 connect(theViewManager, SIGNAL(wheel(SUIT_ViewWindow*, QWheelEvent*)),
87 this, SLOT(onWheelEvent(SUIT_ViewWindow*, QWheelEvent*)));
92 Builds popup for GL viewer
94 void GLViewer_Viewer::contextMenuPopup( QMenu* thePopup )
96 if( thePopup->actions().count() > 0 )
97 thePopup->addSeparator();
99 thePopup->addAction( tr( "CHANGE_BGCOLOR" ), this, SLOT( onChangeBgColor() ) );
103 Sets the background color with color selection dialog. [ virtual protected slot ]
105 void GLViewer_Viewer::onChangeBgColor()
107 GLViewer_ViewPort* vp = getActiveView()->getViewPort();
108 QColor selColor = QColorDialog::getColor( vp->backgroundColor() );
110 if( selColor.isValid() )
111 vp->setBackgroundColor( selColor );
115 Returns the active view. [ public ]
117 GLViewer_ViewFrame* GLViewer_Viewer::getActiveView() const
119 SUIT_ViewManager* aMgr = getViewManager();
120 return (GLViewer_ViewFrame*)( aMgr != 0 ? aMgr->getActiveView() : 0 );
125 Sets the selection mode for this viewer. [ public ]
127 void GLViewer_Viewer::setSelectionMode( GLViewer_Viewer::SelectionMode mode )
129 if ( mySelMode != mode )
132 onSelectionModeChanged();
137 Returns selector of this viewer. [ public ]
139 GLViewer_Selector* GLViewer_Viewer::getSelector() const
143 GLViewer_Viewer* mthis = (GLViewer_Viewer*)this;
144 mthis->mySelector = mthis->createSelector();
147 connect( mySelector, SIGNAL( selSelectionDone( bool, SelectionChangeStatus ) ), SLOT( onSelectionDone( bool, SelectionChangeStatus ) ) );
148 connect( mySelector, SIGNAL( selSelectionCancel() ), SLOT( onSelectionCancel() ) );
155 Returns the selection mode of this viewer. [ public ]
157 GLViewer_Viewer::SelectionMode GLViewer_Viewer::getSelectionMode() const
163 Handles requests for sketching in the active view. [ virtual public ]
165 void GLViewer_Viewer::activateSketching( int type )
167 GLViewer_ViewPort* vp = 0;
168 if ( !getActiveView() || !( vp = getActiveView()->getViewPort() ) )
171 if ( !vp->isSketchingEnabled() )
174 /* Finish current sketching */
175 if ( type == NoSketching )
179 onSketchingFinished();
184 /* Activate new sketching */
187 activateSketching( NoSketching ); /* concurrency not suported */
188 mySketcher = createSketcher( type );
189 onSketchingStarted();
194 Handles requests for transformations in the active view. [ virtual public ]
196 void GLViewer_Viewer::activateTransform( int type )
198 GLViewer_ViewPort* vp = 0;
199 if ( !getActiveView() || !( vp = getActiveView()->getViewPort() ) )
202 if ( !vp->isTransformEnabled() )
205 /* Finish current transform */
206 if ( type == NoTransform )
210 onTransformationFinished();
211 delete myTransformer;
215 /* Activate new transform */
218 activateTransform( NoTransform ); /* concurrency not suported */
219 myTransformer = createTransformer( type );
220 onTransformationStarted();
221 myTransformer->exec();
226 Creates default transformer. [ virtual protected ]
228 GLViewer_ViewTransformer* GLViewer_Viewer::createTransformer( int type )
230 return new GLViewer_ViewTransformer( this, type );
234 Creates default sketcher. [ virtual protected ]
236 GLViewer_ViewSketcher* GLViewer_Viewer::createSketcher( int type )
238 return new GLViewer_ViewSketcher( this, type );
242 Returns null by default. [ virtual protected ]
244 GLViewer_Selector* GLViewer_Viewer::createSelector()
250 Unhilights detected entities, lock selection, sets event filter
251 on the whole application. [ virtual protected ]
253 void GLViewer_Viewer::onTransformationStarted()
257 getSelector()->lock( true ); /* disable selection */
259 /* Watch events: any mouse/key event outside the
260 viewport will be considered as the end of
264 qApp->installEventFilter( this );
268 Unlock selection, removes event filter. [ virtual protected ]
270 void GLViewer_Viewer::onTransformationFinished()
273 getSelector()->lock( false ); /* enable selection */
275 /* Stop watch events */
278 qApp->removeEventFilter( this );
282 Unhilights detected entities. [ virtual protected ]
284 void GLViewer_Viewer::onSketchingStarted()
290 Selection by rectangle. [ virtual protected ]
292 void GLViewer_Viewer::onSketchingFinished()
294 if ( !getSelector() )
299 if ( mySketcher->type() == Rect )
301 QRect* selRect = (QRect*)mySketcher->data();
304 bool append = bool( mySketcher->buttonState() & GLViewer_Selector::appendKey() );
305 getSelector()->select( *selRect, append );
311 Installed while 'fit area' and 'global panning' operations are active. [ virtual protected ]
313 bool GLViewer_Viewer::eventFilter( QObject* o, QEvent* e )
315 if( !getActiveView() )
318 if (e->type() == QEvent::KeyPress)
320 QKeyEvent* keyEvent = static_cast<QKeyEvent*>(e);
321 if (keyEvent->key() == Qt::Key_Escape)
323 activateTransform( NoTransform );
324 activateSketching( NoSketching );
328 return QObject::eventFilter( o, e );
332 Called when smth is selected in this viewer. [ virtual protected slot ]
334 void GLViewer_Viewer::onSelectionDone( bool /*bAdded*/, SelectionChangeStatus status )
336 emit selectionChanged( status );
340 Called when selection is cleared in this viewer. [ virtual protected slot ]
342 void GLViewer_Viewer::onSelectionCancel()
344 emit selectionChanged( SCS_Invalid );
348 Listens to key events of the active view. [ virtual protected slot ]
350 void GLViewer_Viewer::onKeyEvent( SUIT_ViewWindow*, QKeyEvent* )
355 Listens to mouse events of the active view. [ virtual protected slot ]
357 void GLViewer_Viewer::onMouseEvent( SUIT_ViewWindow*, QMouseEvent* e )
359 //cout << "GLViewer_Viewer::onMouseEvent" << endl;
362 case QEvent::MouseButtonPress:
363 handleMousePress( e );
365 case QEvent::MouseMove:
366 handleMouseMove( e );
368 case QEvent::MouseButtonRelease:
369 handleMouseRelease( e );
376 Listens to mouse events of the active view. [ virtual protected slot ]
378 void GLViewer_Viewer::onWheelEvent( SUIT_ViewWindow*, QWheelEvent* e )
380 //cout << "GLViewer_Viewer::onMouseEvent" << endl;
391 Enables / disables rectangle sketching. [ virtual protected ]
393 void GLViewer_Viewer::onSelectionModeChanged()
395 bool enable = ( mySelMode == Multiple );
396 QVector<SUIT_ViewWindow*> views = getViewManager()->getViews();
397 for ( int i = 0, n = views.count(); i < n; i++ )
399 GLViewer_ViewPort* vp = ((GLViewer_ViewFrame*)views[i])->getViewPort();
401 vp->setSketchingEnabled( enable );
406 Updates all views of this viewer. Use 'flags' to customize update process. [ virtual public ]
408 void GLViewer_Viewer::update( int flags )
410 QVector<SUIT_ViewWindow*> views = getViewManager()->getViews();
411 for ( int i = 0, n = views.count(); i < n; i++ )
412 ((GLViewer_ViewFrame*)views[i])->onUpdate( flags );
416 Unhilights the currect detected objects. [ virtual private ]
418 void GLViewer_Viewer::unhilightDetected()
421 getSelector()->undetectAll();
425 Mouse press handler. If 'accelKey()' is pressed, activates default
426 transformations( Zoom or Pan ) in the active viewport. [ private ]
428 void GLViewer_Viewer::handleMousePress( QMouseEvent* e )
430 /* test accel for transforms */
431 if ( e->modifiers() & GLViewer_ViewTransformer::accelKey() )
433 Qt::MouseButton bs = e->button();
434 if ( (int)bs == GLViewer_ViewTransformer::zoomButton() ) // todo Qt::MouseButton is unsigned int: comparison of int with uint
435 activateTransform( Zoom );
436 else if ( (int)bs == GLViewer_ViewTransformer::panButton() ) // todo Qt::MouseButton is unsigned int: comparison of int with uint
437 activateTransform( Pan );
441 //checking for other operations before selection in release event
442 startOperations( e );
445 /* we may need it for sketching... */
446 l_mbPressEvent = new QMouseEvent( *e );
448 //checking for other operations before selection in release event
449 // startOperations( e );
451 /*e->button() == LeftButton && getSelector() )
453 bool append = bool ( e->state() & GLViewer_Selector::appendKey() );
454 getSelector()->select( append );
459 Mouse move handler. If dragged with MB1, activates rectangle sketching in
460 the active viewport, otherwise highlights the selectable entities. [ private ]
462 void GLViewer_Viewer::handleMouseMove( QMouseEvent* e )
464 /* Highlight for selection */
465 bool dragged = ( e->buttons() & ( Qt::LeftButton | Qt::MidButton | Qt::RightButton ) );
469 getSelector()->detect( e->x(), e->y() );
471 /* Try to activate default sketching
473 else if ( (int)e->button() == GLViewer_ViewSketcher::sketchButton() ) // todo Qt::MouseButton is unsigned int: comparison of int with uint
475 activateSketching( Rect );
478 /* Activated OK. We should not forget initial mousepress
479 event and this mousemove event to start sketching from
480 the point of initial click */
481 if ( l_mbPressEvent )
483 QApplication::sendEvent( getActiveView()->getViewPort(), l_mbPressEvent );
484 delete l_mbPressEvent;
487 QApplication::sendEvent( getActiveView()->getViewPort(), e );
491 //Try to activate other operations
492 updateOperations( e );
496 Mouse move handler. Activates popup of the active view. [ private ]
498 void GLViewer_Viewer::handleMouseRelease( QMouseEvent* e )
501 /* tmp - in handleMousePress*/
502 if( e->button() == Qt::LeftButton && !(getActiveView()->getViewPort()->currentBlock() & BS_Selection) )
506 bool append = bool ( e->modifiers() & GLViewer_Selector::appendKey() );
507 getSelector()->select( append );
511 //Try to done active operations
512 finishOperations( e );
514 if ( l_mbPressEvent )
516 delete l_mbPressEvent;
522 Wheel rolling handler
524 void GLViewer_Viewer::handleWheel( QWheelEvent* e )
526 startOperations( e );
529 int GLViewer_ViewTransformer::panBtn = Qt::MidButton;
530 int GLViewer_ViewTransformer::zoomBtn = Qt::LeftButton;
531 int GLViewer_ViewTransformer::fitRectBtn = Qt::LeftButton;
532 int GLViewer_ViewTransformer::panGlobalBtn = Qt::LeftButton;
533 int GLViewer_ViewTransformer::acccelKey = Qt::ControlModifier;
538 GLViewer_ViewTransformer::GLViewer_ViewTransformer( GLViewer_Viewer* v, int type )
543 myMajorBtn( Qt::NoButton ),
546 if ( myType == GLViewer_Viewer::Pan ||
547 myType == GLViewer_Viewer::Zoom ||
548 myType == GLViewer_Viewer::PanGlobal ||
549 myType == GLViewer_Viewer::FitRect )
551 /* 'long' transforms need this */
552 initTransform( true );
559 GLViewer_ViewTransformer::~GLViewer_ViewTransformer()
561 if ( myType == GLViewer_Viewer::Pan ||
562 myType == GLViewer_Viewer::Zoom ||
563 myType == GLViewer_Viewer::PanGlobal ||
564 myType == GLViewer_Viewer::FitRect )
566 /* 'long' transforms need this */
567 initTransform( false );
570 //QAD_Application::getDesktop()->clearInfo();
576 Inits long transformations ( Zoom, Pan etc ) [ protected ]
578 Saves viewport state( cursor etc ) and installs event filter to process
579 mouse events if 'init' is true. Restores viewport state if 'init' is false.
581 void GLViewer_ViewTransformer::initTransform( bool init )
583 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
586 mySavedCursor = avp->cursor();
587 mySavedMouseTrack = avp->hasMouseTracking();
588 avp->setMouseTracking( false );
589 avp->installEventFilter( this );
593 avp->removeEventFilter( this );
594 avp->setMouseTracking( mySavedMouseTrack );
595 avp->setCursor( mySavedCursor );
600 Runs transfomation. Redefine to add your own 'instant' transforms
601 ( for ex., 'FitAll' is an instant transform ). [ virtual public ]
603 void GLViewer_ViewTransformer::exec()
605 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
611 case GLViewer_Viewer::Zoom:
612 myMajorBtn = zoomButton();
613 avp->setCursor( *avp->getZoomCursor() );
615 case GLViewer_Viewer::Pan:
616 myMajorBtn = panButton();
617 avp->setCursor( *avp->getPanCursor() );
619 case GLViewer_Viewer::PanGlobal:
620 myMajorBtn = panGlobalButton();
621 avp->setCursor( *avp->getPanglCursor() );
622 avp->fitAll( true, false ); /* view is ready now */
624 case GLViewer_Viewer::FitRect:
625 myMajorBtn = fitRectButton();
626 avp->setCursor( *avp->getHandCursor() );
628 case GLViewer_Viewer::Reset:
629 avp->reset(); onTransform( Fin );
631 case GLViewer_Viewer::FitAll:
632 avp->fitAll(); onTransform( Fin );
634 case GLViewer_Viewer::FitSelect:
635 avp->fitSelect(); onTransform( Fin );
642 Catches mouse events for the viewport. [ virtual protected ]
644 bool GLViewer_ViewTransformer::eventFilter( QObject* o, QEvent* e )
648 case QEvent::MouseMove:
649 case QEvent::MouseButtonPress:
650 case QEvent::MouseButtonRelease:
652 TransformState state = EnTrain;
653 QMouseEvent* me = ( QMouseEvent* )e;
655 myButtonState = me->buttons();
656 if ( e->type() == QEvent::MouseButtonPress )
657 myButtonState |= me->button(); /* add pressed button */
659 if ( e->type() == QEvent::MouseButtonRelease )
660 myButtonState |= me->button(); /* add release button */
662 int mouseOnlyState = ( myButtonState & ( Qt::LeftButton | Qt::MidButton | Qt::RightButton ) );
663 if ( myStart.isNull() )
667 myMajorBtn = mouseOnlyState;
670 if ( e->type() == QEvent::MouseButtonRelease )
675 onTransform( state );
680 return QObject::eventFilter( o, e );
684 Transforms the viewport. Used for 'non-instant' transforms
685 only( ex. Rotate, Pan etc ). [ virtual protected ]
687 void GLViewer_ViewTransformer::onTransform( TransformState state )
689 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
690 bool doTrsf = ( myButtonState & myMajorBtn );
693 case GLViewer_Viewer::Zoom:
694 if ( state != Fin && doTrsf )
696 avp->zoom( myStart.x(), myStart.y(), myCurr.x(), myCurr.y() );
700 case GLViewer_Viewer::Pan:
701 if ( state != Fin && doTrsf )
703 avp->pan( myCurr.x() - myStart.x(), myStart.y() - myCurr.y() );
707 case GLViewer_Viewer::PanGlobal:
710 avp->setCenter( myCurr.x(), myCurr.y() );
713 case GLViewer_Viewer::FitRect:
717 QRect rect( qMin( myStart.x(), myCurr.x() ), qMin( myStart.y(), myCurr.y() ),
718 qAbs( myStart.x() - myCurr.x() ), qAbs( myStart.y() - myCurr.y() ) );
719 if ( !rect.isEmpty() )
724 avp->fitRect( rect );
741 myViewer->activateTransform( GLViewer_Viewer::NoTransform );
745 Draws rectangle by starting and current points
747 void GLViewer_ViewTransformer::drawRect(const QRect& theRect)
750 myRectBand = new QRubberBand( QRubberBand::Rectangle, myViewer->getActiveView()->getViewPort() );
752 palette.setColor(myRectBand->foregroundRole(), Qt::white);
753 myRectBand->setPalette(palette);
757 myRectBand->setGeometry( theRect );
758 myRectBand->setVisible( theRect.isValid() );
762 \brief Delete rubber band on the end on the dragging operation.
764 void GLViewer_ViewTransformer::endDrawRect()
766 if ( myRectBand ) myRectBand->hide();
773 Returns the type of the transformer. [ public ]
775 int GLViewer_ViewTransformer::type() const
781 int GLViewer_ViewSketcher::sketchBtn = Qt::LeftButton;
786 GLViewer_ViewSketcher::GLViewer_ViewSketcher( GLViewer_Viewer* viewer, int type )
795 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
799 mySavedCursor = avp->cursor();
800 avp->setCursor( *GLViewer_ViewPort::getHandCursor() );
801 avp->installEventFilter( this );
803 if ( myType == GLViewer_Viewer::Rect )
804 myData = new QRect();
810 GLViewer_ViewSketcher::~GLViewer_ViewSketcher()
812 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
813 avp->removeEventFilter( this );
814 avp->setCursor( mySavedCursor );
816 if ( myType == GLViewer_Viewer::Rect )
817 delete ( QRect* ) myData;
823 Catches mouse events for the viewport. [ virtual protected ]
825 bool GLViewer_ViewSketcher::eventFilter( QObject* o, QEvent* e )
829 case QEvent::MouseMove:
830 case QEvent::MouseButtonPress:
831 case QEvent::MouseButtonRelease:
833 SketchState state = EnTrain;
834 QMouseEvent* me = (QMouseEvent*)e;
836 myButtonState = me->buttons();
837 if ( e->type() == QEvent::MouseButtonPress )
838 myButtonState |= me->button(); /* add pressed button */
840 if ( myStart.isNull() )
846 int mouseOnlyState = ( myButtonState & ( Qt::LeftButton | Qt::MidButton | Qt::RightButton ) );
847 if ( e->type() == QEvent::MouseButtonRelease && mouseOnlyState == sketchButton() )
857 return QObject::eventFilter( o, e );
861 Draws in the viewport. [ virtual protected ]
863 void GLViewer_ViewSketcher::onSketch( SketchState state )
865 GLViewer_ViewPort* avp = myViewer->getActiveView()->getViewPort();
869 if( myType == GLViewer_Viewer::Rect )
871 QRect* sketchRect = ( QRect* )data();
872 if ( myButtonState & sketchButton() )
874 QRect rect( qMin( myStart.x(), myCurr.x() ), qMin( myStart.y(), myCurr.y() ),
875 qAbs( myStart.x() - myCurr.x() ), qAbs( myStart.y() - myCurr.y() ) );
876 if ( !rect.isEmpty() )
878 if ( !sketchRect->isEmpty() && myRectBand )
879 myRectBand->hide(); /* erase */
882 drawRect( *sketchRect );
889 myViewer->activateSketching( GLViewer_Viewer::NoSketching );
894 Draws rectangle by starting and current points
896 void GLViewer_ViewSketcher::drawRect(const QRect& theRect)
899 myRectBand = new QRubberBand( QRubberBand::Rectangle, myViewer->getActiveView()->getViewPort() );
901 palette.setColor(myRectBand->foregroundRole(), Qt::white);
902 myRectBand->setPalette(palette);
906 myRectBand->setGeometry( theRect );
907 myRectBand->setVisible( theRect.isValid() );
911 \brief Delete rubber band on the end on the dragging operation.
913 void GLViewer_ViewSketcher::endDrawRect()
915 if ( myRectBand ) myRectBand->hide();