0024023: Revamp the OCCT Handle -- general
[occt.git] / src / IVtk / IVtk_IShape.hxx
1 // Created on: 2011-10-11
2 // Created by: Roman KOZLOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS 
4 // 
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef __IVTK_ISHAPE_H__
17 #define __IVTK_ISHAPE_H__
18
19 #include <IVtk_Interface.hxx>
20 #include <IVtk_Types.hxx>
21
22 class IVtk_IShape;
23 DEFINE_STANDARD_HANDLE( IVtk_IShape, IVtk_Interface )
24
25 //! @class IVtk_IShape 
26 //! @brief Interface for working with a shape and its sub-shapes ids.
27 class IVtk_IShape : public IVtk_Interface 
28 {
29 public:
30   typedef Handle(IVtk_IShape) Handle;
31
32   virtual ~IVtk_IShape() { }
33
34   IVtk_IdType GetId() const { return myId; }
35
36   void SetId (const IVtk_IdType theId) { myId = theId; }
37
38   //! Get ids of sub-shapes composing a sub-shape with the given id
39   virtual IVtk_ShapeIdList GetSubIds (const IVtk_IdType theId) const = 0;
40
41   DEFINE_STANDARD_RTTI(IVtk_IShape, IVtk_Interface)
42
43 private:
44   IVtk_IdType myId;
45 };
46
47 typedef NCollection_List< IVtk_IShape::Handle > IVtk_ShapePtrList;
48
49 #endif // __IVTK_ISHAPE_H__