42cf5bc1 |
1 | // Created on: 2003-10-10 |
2 | // Created by: Alexander SOLOVYOV |
3 | // Copyright (c) 2003-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 _MeshVS_DataSource_HeaderFile |
17 | #define _MeshVS_DataSource_HeaderFile |
18 | |
19 | #include <Standard.hxx> |
20 | #include <Standard_Type.hxx> |
21 | |
25e59720 |
22 | #include <Standard_Transient.hxx> |
42cf5bc1 |
23 | #include <Standard_Integer.hxx> |
42cf5bc1 |
24 | #include <MeshVS_EntityType.hxx> |
25 | #include <MeshVS_HArray1OfSequenceOfInteger.hxx> |
42cf5bc1 |
26 | #include <TColStd_Array1OfInteger.hxx> |
27 | #include <TColStd_PackedMapOfInteger.hxx> |
42cf5bc1 |
28 | #include <TColStd_HArray1OfReal.hxx> |
29 | #include <TColgp_Array1OfPnt2d.hxx> |
30 | class Bnd_Box; |
31 | class MeshVS_Mesh; |
32 | class TColStd_HPackedMapOfInteger; |
33 | class Bnd_Box2d; |
34 | |
35 | |
36 | class MeshVS_DataSource; |
25e59720 |
37 | DEFINE_STANDARD_HANDLE(MeshVS_DataSource, Standard_Transient) |
42cf5bc1 |
38 | |
39 | //! The deferred class using for the following tasks: |
40 | //! 1) Receiving geometry data about single element of node by its number; |
41 | //! 2) Receiving type of element or node by its number; |
42 | //! 3) Receiving topological information about links between element and nodes it consist of; |
43 | //! 4) Receiving information about what element cover this node; |
44 | //! 5) Receiving information about all nodes and elements the object consist of |
45 | //! 6) Activation of advanced mesh selection. In the advanced mesh selection mode there is created: |
46 | //! - one owner for the whole mesh and for all selection modes |
47 | //! - one sensitive entity for the whole mesh and for each selection mode |
48 | //! Receiving of IDs of detected entities (nodes and elements) in a viewer is achieved by |
49 | //! implementation of a group of methods GetDetectedEntities. |
25e59720 |
50 | class MeshVS_DataSource : public Standard_Transient |
42cf5bc1 |
51 | { |
52 | |
53 | public: |
54 | |
55 | |
56 | //! Returns geometry information about node or element |
57 | //! ID is the numerical identificator of node or element |
58 | //! IsElement indicates this ID describe node ( if Standard_False ) or element ( if Standard_True ) |
5e6e5914 |
59 | //! Coords is an array of coordinates of node(s). |
42cf5bc1 |
60 | //! For node it is only 3 numbers: X, Y, Z in the strict order |
61 | //! For element it is 3*n numbers, where n is number of this element vertices |
5e6e5914 |
62 | //! The order is strict also: X1, Y1, Z1, X2,...., where Xi, Yi, Zi are coordinates of vertices |
42cf5bc1 |
63 | //! NbNodes is number of nodes. It is recommended this parameter to be set to 1 for node. |
64 | //! Type is type of node or element (from enumeration). It is recommended this parameter to be set to |
65 | //! MeshVS_ET_Node for node. |
66 | Standard_EXPORT virtual Standard_Boolean GetGeom (const Standard_Integer ID, const Standard_Boolean IsElement, TColStd_Array1OfReal& Coords, Standard_Integer& NbNodes, MeshVS_EntityType& Type) const = 0; |
67 | |
68 | //! This method is similar to GetGeom, but returns only element or node type. |
69 | Standard_EXPORT virtual Standard_Boolean GetGeomType (const Standard_Integer ID, const Standard_Boolean IsElement, MeshVS_EntityType& Type) const = 0; |
70 | |
71 | //! This method returns topology information about 3D-element |
72 | //! Returns false if element with ID isn't 3D or because other troubles |
73 | Standard_EXPORT virtual Standard_Boolean Get3DGeom (const Standard_Integer ID, Standard_Integer& NbNodes, Handle(MeshVS_HArray1OfSequenceOfInteger)& Data) const; |
74 | |
75 | //! This method returns pointer which represents element or node data structure. |
76 | //! This address will be saved in MeshVS_MeshEntityOwner, so that you can access to data structure fast |
77 | //! by the method Owner(). In the redefined method you can return NULL. |
78 | //! ID is the numerical identificator of node or element |
79 | //! IsElement indicates this ID describe node ( if Standard_False ) or element ( if Standard_True ) |
80 | Standard_EXPORT virtual Standard_Address GetAddr (const Standard_Integer ID, const Standard_Boolean IsElement) const = 0; |
81 | |
82 | //! This method returns information about nodes this element consist of. |
83 | //! ID is the numerical identificator of element. |
84 | //! NodeIDs is the output array of nodes IDs in correct order, |
85 | //! the same as coordinates returned by GetGeom(). |
86 | //! NbNodes is number of nodes (number of items set in NodeIDs). |
87 | //! Returns False if element does not exist |
88 | Standard_EXPORT virtual Standard_Boolean GetNodesByElement (const Standard_Integer ID, TColStd_Array1OfInteger& NodeIDs, Standard_Integer& NbNodes) const = 0; |
89 | |
90 | //! This method returns map of all nodes the object consist of. |
91 | Standard_EXPORT virtual const TColStd_PackedMapOfInteger& GetAllNodes() const = 0; |
92 | |
93 | //! This method returns map of all elements the object consist of. |
94 | Standard_EXPORT virtual const TColStd_PackedMapOfInteger& GetAllElements() const = 0; |
95 | |
96 | //! This method calculates normal of face, which is using for correct reflection presentation. |
97 | //! There is default method, for advance reflection this method can be redefined. |
98 | //! Id is the numerical identificator of only element! |
99 | //! Max is maximal number of nodes an element can consist of |
5e6e5914 |
100 | //! nx, ny, nz are values whose represent coordinates of normal (will be returned) |
42cf5bc1 |
101 | //! In the redefined method you can return normal with length more then 1, but in this case |
102 | //! the appearance of element will be more bright than usual. For ordinary brightness you must return |
103 | //! normal with length 1 |
104 | Standard_EXPORT virtual Standard_Boolean GetNormal (const Standard_Integer Id, const Standard_Integer Max, Standard_Real& nx, Standard_Real& ny, Standard_Real& nz) const; |
105 | |
106 | //! This method return normal of node ranknode of face Id, |
107 | //! which is using for smooth shading presentation. |
108 | //! Returns false if normal isn't defined. |
109 | Standard_EXPORT virtual Standard_Boolean GetNodeNormal (const Standard_Integer ranknode, const Standard_Integer ElementId, Standard_Real& nx, Standard_Real& ny, Standard_Real& nz) const; |
110 | |
111 | //! This method puts components of normal vectors at each node of a mesh face (at each face of a mesh volume) |
112 | //! into the output array. |
113 | //! Returns false if some problem was detected during calculation of normals. |
114 | //! Id is an identifier of the mesh element. |
115 | //! IsNodal, when true, means that normals at mesh element nodes are needed. If nodal normals |
116 | //! are not available, or IsNodal is false, or the mesh element is a volume, then the output array contents |
117 | //! depend on the element type: |
118 | //! face: a normal calculated by GetNormal() is duplicated for each node of the face; |
119 | //! volume: normals to all faces of the volume are computed (not for each node!). |
120 | //! MaxNodes is maximal number of nodes an element can consist of. |
121 | //! Normals contains the result. |
122 | Standard_EXPORT virtual Standard_Boolean GetNormalsByElement (const Standard_Integer Id, const Standard_Boolean IsNodal, const Standard_Integer MaxNodes, Handle(TColStd_HArray1OfReal)& Normals) const; |
123 | |
124 | //! This method returns map of all groups the object contains. |
125 | Standard_EXPORT virtual void GetAllGroups (TColStd_PackedMapOfInteger& Ids) const; |
126 | |
127 | //! This method returns map of all group elements. |
128 | Standard_EXPORT virtual Standard_Boolean GetGroup (const Standard_Integer Id, MeshVS_EntityType& Type, TColStd_PackedMapOfInteger& Ids) const; |
129 | |
130 | //! This method returns pointer which represents group data structure. |
131 | //! This address will be saved in MeshVS_MeshOwner, so that you can access to data structure fast |
132 | //! by the method Owner(). In the redefined method you can return NULL. |
133 | //! ID is the numerical identificator of group |
134 | Standard_EXPORT virtual Standard_Address GetGroupAddr (const Standard_Integer ID) const; |
135 | |
136 | //! Returns True if advanced mesh selection is enabled. |
137 | //! Default implementation returns False. |
138 | //! It should be redefined to return True for advanced |
139 | //! mesh selection activation. |
140 | Standard_EXPORT virtual Standard_Boolean IsAdvancedSelectionEnabled() const; |
141 | |
142 | //! Returns the bounding box of the whole mesh. |
143 | //! It is used in advanced selection mode to define roughly |
144 | //! the sensitive area of the mesh. |
145 | //! It can be redefined to get access to a box computed in advance. |
146 | Standard_EXPORT virtual Bnd_Box GetBoundingBox() const; |
147 | |
148 | //! Returns maps of entities (nodes and elements) detected |
149 | //! by mouse click at the point (X,Y) on the current view plane, |
150 | //! with the tolerance aTol. |
151 | //! DMin - is out argument should return actual detection tolerance. |
152 | //! Returns True if something is detected. |
153 | //! It should be redefined if the advanced mesh selection is |
154 | //! activated. Default implementation returns False. |
155 | Standard_EXPORT virtual Standard_Boolean GetDetectedEntities (const Handle(MeshVS_Mesh)& Prs, const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Handle(TColStd_HPackedMapOfInteger)& Nodes, Handle(TColStd_HPackedMapOfInteger)& Elements, Standard_Real& DMin); |
156 | |
157 | //! Returns maps of entities (nodes and elements) detected |
158 | //! by mouse selection with rectangular box (XMin, YMin, XMax, YMax) |
5e6e5914 |
159 | //! on the current view plane, with the tolerance aTol. |
42cf5bc1 |
160 | //! Returns True if something is detected. |
161 | //! It should be redefined if the advanced mesh selection is |
162 | //! activated. Default implementation returns False. |
163 | Standard_EXPORT virtual Standard_Boolean GetDetectedEntities (const Handle(MeshVS_Mesh)& Prs, const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol, Handle(TColStd_HPackedMapOfInteger)& Nodes, Handle(TColStd_HPackedMapOfInteger)& Elements); |
164 | |
165 | //! Returns maps of entities (nodes and elements) detected |
166 | //! by mouse selection with the polyline <Polyline> |
5e6e5914 |
167 | //! on the current view plane, with the tolerance aTol. |
42cf5bc1 |
168 | //! Returns True if something is detected. |
169 | //! It should be redefined if the advanced mesh selection is |
170 | //! activated. Default implementation returns False. |
171 | Standard_EXPORT virtual Standard_Boolean GetDetectedEntities (const Handle(MeshVS_Mesh)& Prs, const TColgp_Array1OfPnt2d& Polyline, const Bnd_Box2d& aBox, const Standard_Real aTol, Handle(TColStd_HPackedMapOfInteger)& Nodes, Handle(TColStd_HPackedMapOfInteger)& Elements); |
172 | |
173 | //! Filter out the maps of mesh entities so as to keep |
174 | //! only the entities that are allowed to be selected |
175 | //! according to the current context. |
176 | //! Returns True if any of the maps has been changed. |
177 | //! It should be redefined if the advanced mesh selection is |
178 | //! activated. Default implementation returns False. |
179 | Standard_EXPORT virtual Standard_Boolean GetDetectedEntities (const Handle(MeshVS_Mesh)& Prs, Handle(TColStd_HPackedMapOfInteger)& Nodes, Handle(TColStd_HPackedMapOfInteger)& Elements); |
180 | |
25e59720 |
181 | DEFINE_STANDARD_RTTIEXT(MeshVS_DataSource,Standard_Transient) |
42cf5bc1 |
182 | |
42cf5bc1 |
183 | }; |
184 | |
42cf5bc1 |
185 | #endif // _MeshVS_DataSource_HeaderFile |