src/OBJECT/VISU_ActorFactory.h

   1 //  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  VISU OBJECT : interactive object for VISU entities implementation
  24 //  File   :
  25 //  Author :
  26 //  Module : VISU
  27 //  $Header$
  28 //
  29 #ifndef VISU_ACTOR_FACTORY_H
  30 #define VISU_ACTOR_FACTORY_H
  31
  32 #include "VISU_BoostSignals.h"
  33 #include "VISU_ActorBase.h"
  34
  35 class VISU_ActorBase;
  36
  37 //----------------------------------------------------------------------------
  38 namespace VISU
  39 {
  40   //! This class defines an abstaract interface to manage actors
  41   /*!
  42     Actors are created by corresponding presentations and published in the defined view.
  43     Each actor can be published only into one view but one presentation can have many actors.
  44     Due to the complexity of the actor presentation interaction the new interface defines common
  45     and simply way to manage them properly.
  46     @note
  47     This interface inherits from boost::bsignals::trackable in order to provide automatic
  48     diconnection from defined signals if the object is destroyed.
  49   */
  50   struct TActorFactory: public virtual boost::signalslib::trackable
  51   {
  52     //! Just to make this class virtual
  53     virtual
  54     ~TActorFactory()
  55     {}
  56
  57     //! Gets know whether the factory instance can be used for actor management or not
  58     virtual
  59     bool
  60     GetActiveState() = 0;
  61
  62     //! Return modified time of the factory
  63     virtual
  64     unsigned long int
  65     GetMTime() = 0;
  66
  67     //! To update the actor
  68     virtual
  69     void
  70     UpdateActor(VISU_ActorBase* theActor) = 0;
  71
  72     //! To unregister the actor
  73     virtual
  74     void
  75     RemoveActor(VISU_ActorBase* theActor) = 0;
  76   };
  77 }
  78
  79 #endif //VISU_ACTOR_FACTORY_H