c3a76649dacc36c864b04be73d9f9747a28063f6
[occt.git] / src / IVtkOCC / IVtkOCC_Shape.hxx
1 // Created on: 2011-10-14 
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 __IVTKOCC_SHAPE_H__
17 #define __IVTKOCC_SHAPE_H__
18
19 #include <IVtk_IShape.hxx>
20 #include <TopoDS_Shape.hxx>
21 #include <TopTools_IndexedMapOfShape.hxx>
22 #include <SelectMgr_SelectableObject.hxx>
23
24 DEFINE_STANDARD_HANDLE( IVtkOCC_Shape, IVtk_IShape )
25
26 //! @class IVtkOCC_Shape
27 //! @brief OCC implementation of IShape interface.
28 class IVtkOCC_Shape : public IVtk_IShape
29 {
30 public:
31
32   typedef Handle(IVtkOCC_Shape) Handle;
33
34   //! Constructor for OCC IShape implementation
35   Standard_EXPORT IVtkOCC_Shape (const TopoDS_Shape& theShape);
36
37   //! Destructor
38   Standard_EXPORT virtual ~IVtkOCC_Shape();
39
40   IVtk_IdType GetSubShapeId (const IVtk_IShape::Handle&) const;
41
42   DEFINE_STANDARD_RTTI(IVtkOCC_Shape, IVtk_IShape)
43
44   //! Get the wrapped original OCCT shape
45   //! @return TopoDS_Shape the wrapped original OCCT shape
46   TopoDS_Shape GetShape() const
47   {
48     return myTopoDSShape;
49   }
50
51   //! @brief Get local ID of a sub-shape.
52   //!
53   //! Returns unique ID of the given sub-shape within the top-level shape.
54   //! Note that the sub-shape ID remains unchanged until the top-level is 
55   //! modified by some operation.
56   //! @param [in] subShape sub-shape whose ID is returned
57   //! @return local ID of the sub-shape.
58   IVtk_IdType GetSubShapeId (const TopoDS_Shape& theSubShape) const;
59
60   //! Get ids of sub-shapes composing a sub-shape with the given id
61   Standard_EXPORT IVtk_ShapeIdList GetSubIds (const IVtk_IdType) const;
62
63   //! @brief Get a sub-shape by its local ID.
64   //!
65   //! @param [in] id local ID of a sub-shape
66   //! @return TopoDS_Shape& a sub-shape
67   Standard_EXPORT const TopoDS_Shape& GetSubShape (const IVtk_IdType theId) const;
68
69   //! Stores a handle to selectable object used by OCCT selection algorithm
70   //! in a data field. This object internally caches selection data
71   //! so it should be stored until the shape is no longer selectable.
72   //! Note that the selectable object keeps a pointer to OccShape.
73   //! @param [in] selObj Handle to the selectable object
74   void SetSelectableObject (const Handle(SelectMgr_SelectableObject)& theSelObj)
75   {
76     mySelectable = theSelObj;
77   }
78
79   //! @return Handle to the selectable object for this shape.
80   Handle(SelectMgr_SelectableObject) GetSelectableObject() const
81   {
82     return mySelectable;
83   }
84
85 private:
86   //! @brief Build a map of sub-shapes by their IDs
87   //!
88   //! Private method, assigns IDs to all sub-shapes of the 
89   //! top-level shape.
90   //! @see IVtkOCC_Shape::GetSubShapeId
91   void        buildSubShapeIdMap();
92
93 private:
94   TopTools_IndexedMapOfShape         mySubShapeIds; //!< Map of sub-shapes by their IDs
95   TopoDS_Shape                       myTopoDSShape; //!< The wrapped main OCCT shape
96   Handle(SelectMgr_SelectableObject) mySelectable;  //!< Link to a holder of selection primitives
97 };
98
99 #endif // __IVTKOCC_SHAPE_H__