src/OBJECT/SALOME_InteractiveObject.hxx

   1 //  SALOME OBJECT : implementation of interactive object visualization for OCC and VTK viewers
   2 //
   3 //  Copyright (C) 2003  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SALOME_InteractiveObject.hxx
  25 //  Module : SALOME
  26
  27 #ifndef _SALOME_InteractiveObject_HeaderFile
  28 #define _SALOME_InteractiveObject_HeaderFile
  29
  30 #ifndef _Standard_HeaderFile
  31 #include <Standard.hxx>
  32 #endif
  33 #ifndef _Handle_SALOME_InteractiveObject_HeaderFile
  34 #include <Handle_SALOME_InteractiveObject.hxx>
  35 #endif
  36
  37 #ifndef _Standard_CString_HeaderFile
  38 #include <Standard_CString.hxx>
  39 #endif
  40 #ifndef _MMgt_TShared_HeaderFile
  41 #include <MMgt_TShared.hxx>
  42 #endif
  43 #ifndef _Standard_Boolean_HeaderFile
  44 #include <Standard_Boolean.hxx>
  45 #endif
  46
  47 #include <string>
  48
  49 class SALOME_InteractiveObject : public MMgt_TShared {
  50
  51 public:
  52
  53     void* operator new(size_t,void* anAddress)
  54       {
  55         return anAddress;
  56       }
  57     void* operator new(size_t size)
  58       {
  59         return Standard::Allocate(size);
  60       }
  61     void  operator delete(void *anAddress)
  62       {
  63         if (anAddress) Standard::Free((Standard_Address&)anAddress);
  64       }
  65  // Methods PUBLIC
  66  //
  67 Standard_EXPORT   SALOME_InteractiveObject();
  68 Standard_EXPORT   SALOME_InteractiveObject(const char* anEntry,
  69                                            const char* aComponentDataType,
  70                                            const char* aName = "");
  71 Standard_EXPORT   void setEntry(const char* anEntry) ;
  72 Standard_EXPORT   const char* getEntry() ;
  73 Standard_EXPORT   void setName(const char* aName) ;
  74 Standard_EXPORT   const char* getName() ;
  75 Standard_EXPORT   Standard_Boolean hasEntry() ;
  76 Standard_EXPORT   virtual  Standard_Boolean isSame(const Handle(SALOME_InteractiveObject)& anIO) ;
  77
  78 Standard_EXPORT   Standard_Boolean hasReference() ;
  79 Standard_EXPORT   const char* getReference() ;
  80 Standard_EXPORT   void setReference(const char* aReference) ;
  81
  82 Standard_EXPORT   void setComponentDataType(const char* ComponentDataType) ;
  83 Standard_EXPORT   const char* getComponentDataType() ;
  84 Standard_EXPORT   Standard_Boolean isComponentType(const char* ComponentDataType) ;
  85   //Standard_EXPORT   Standard_Boolean isComponentType(std::string  ComponentDataType) ;
  86 Standard_EXPORT   virtual ~SALOME_InteractiveObject();
  87
  88 // Must be defined for using by NCollection for ceratin of data map
  89 friend Standard_Boolean IsEqual(const Handle(SALOME_InteractiveObject)& anIO1,
  90                                 const Handle(SALOME_InteractiveObject)& anIO2)
  91 { return anIO1->isSame( anIO2 ); }
  92
  93
  94
  95
  96
  97  // Type management
  98  //
  99  Standard_EXPORT friend Handle_Standard_Type& SALOME_InteractiveObject_Type_();
 100  Standard_EXPORT const Handle(Standard_Type)& DynamicType() const;
 101  Standard_EXPORT Standard_Boolean              IsKind(const Handle(Standard_Type)&) const;
 102
 103 protected:
 104
 105  // Methods PROTECTED
 106  //
 107
 108
 109  // Fields PROTECTED
 110  //
 111   std::string myReference;
 112   std::string myEntry;
 113   std::string myName;
 114   std::string myComponentDataType;
 115
 116 private:
 117
 118  // Methods PRIVATE
 119  //
 120
 121
 122  // Fields PRIVATE
 123  //
 124
 125
 126 };
 127
 128
 129
 130
 131
 132 // other Inline functions and methods (like "C++: function call" methods)
 133 //
 134
 135
 136 #endif