src/SelectBasics/SelectBasics_EntityOwner.hxx

   1 // Created on: 1995-02-09
   2 // Created by: Mister rmi
   3 // Copyright (c) 1995-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _SelectBasics_EntityOwner_HeaderFile
  18 #define _SelectBasics_EntityOwner_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Transient.hxx>
  22 #include <Standard_Type.hxx>
  23 #include <TopLoc_Location.hxx>
  24
  25 //! defines an abstract owner of sensitive primitives.
  26 //! Owners are typically used to establish a connection
  27 //! between sensitive entities and high-level objects (e.g. presentations).
  28 //!
  29 //! Priority : It's possible to give a priority:
  30 //! the scale : [0-9] ; the default priority is 0
  31 //! it allows the predominance of one selected object upon
  32 //! another one if many objects are selected at the same time
  33 //!
  34 //! example : Selection of shapes : the owners are
  35 //! selectable objects (presentations)
  36 //!
  37 //! a user can give vertex priority [3], edges [2] faces [1] shape [0],
  38 //! so that if during selection one vertex one edge and one face are
  39 //! simultaneously detected, the vertex will only be hilighted.
  40 class SelectBasics_EntityOwner : public Standard_Transient
  41 {
  42   DEFINE_STANDARD_RTTIEXT(SelectBasics_EntityOwner, Standard_Transient)
  43 public:
  44
  45   //! sets the selectable priority of the owner
  46   void SetPriority (const Standard_Integer thePriority) { mypriority = thePriority; }
  47
  48   Standard_Integer Priority() const { return mypriority; }
  49
  50   Standard_EXPORT virtual Standard_Boolean HasLocation() const = 0;
  51
  52   Standard_EXPORT virtual void SetLocation (const TopLoc_Location& aLoc) = 0;
  53
  54   Standard_EXPORT virtual void ResetLocation() = 0;
  55
  56   Standard_EXPORT virtual TopLoc_Location Location() const = 0;
  57
  58 public:
  59
  60   //! sets the selectable priority of the owner
  61   void Set (const Standard_Integer thePriority) { SetPriority (thePriority); }
  62
  63 protected:
  64
  65   Standard_EXPORT SelectBasics_EntityOwner (const Standard_Integer thePriority = 0);
  66
  67 protected:
  68
  69   Standard_Integer mypriority;
  70
  71 };
  72
  73 DEFINE_STANDARD_HANDLE(SelectBasics_EntityOwner, Standard_Transient)
  74
  75 #endif // _SelectBasics_EntityOwner_HeaderFile