0029729: Visualization, Graphic3d_ClipPlane - add support of clipping plane chains
[occt.git] / src / Graphic3d / Graphic3d_ClipPlane.hxx
1 // Created on: 2013-07-12
2 // Created by: Anton POLETAEV
3 // Copyright (c) 2013-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 _Graphic3d_ClipPlane_HeaderFile
17 #define _Graphic3d_ClipPlane_HeaderFile
18
19 #include <Aspect_HatchStyle.hxx>
20 #include <gp_Pln.hxx>
21 #include <Graphic3d_AspectFillArea3d.hxx>
22 #include <Graphic3d_BndBox3d.hxx>
23 #include <Graphic3d_CappingFlags.hxx>
24 #include <Graphic3d_TextureMap.hxx>
25 #include <NCollection_Vec4.hxx>
26 #include <Standard_Macro.hxx>
27 #include <Standard_TypeDef.hxx>
28 #include <Standard_Transient.hxx>
29
30 //! Clipping state.
31 enum Graphic3d_ClipState
32 {
33   Graphic3d_ClipState_Out, //!< fully outside (clipped) - should be discarded
34   Graphic3d_ClipState_In,  //!< fully inside  (NOT clipped) - should NOT be discarded
35   Graphic3d_ClipState_On,  //!< on (not clipped / partially clipped) - should NOT be discarded
36 };
37
38 //! Container for properties describing either a Clipping halfspace (single Clipping Plane),
39 //! or a chain of Clipping Planes defining logical AND (conjunction) operation.
40 //! The plane equation is specified in "world" coordinate system.
41 class Graphic3d_ClipPlane : public Standard_Transient
42 {
43   DEFINE_STANDARD_RTTIEXT(Graphic3d_ClipPlane,Standard_Transient)
44 public:
45
46   //! Type defining XYZW (ABCD) plane equation - left for compatibility with old code using Graphic3d_ClipPlane::Equation type.
47   typedef Graphic3d_Vec4d Equation;
48
49 public:
50
51   //! Default constructor.
52   //! Initializes clip plane container with the following properties:
53   //! - Equation (0.0, 0.0, 1.0, 0)
54   //! - IsOn (True),
55   //! - IsCapping (False),
56   //! - Material (Graphic3d_NOM_DEFAULT),
57   //! - Texture (NULL),
58   //! - HatchStyle (Aspect_HS_HORIZONTAL),
59   //! - IsHatchOn (False)
60   Standard_EXPORT Graphic3d_ClipPlane();
61
62   //! Copy constructor.
63   //! @param theOther [in] the copied plane.
64   Standard_EXPORT Graphic3d_ClipPlane(const Graphic3d_ClipPlane& theOther);
65
66   //! Construct clip plane for the passed equation.
67   //! By default the plane is on, capping is turned off.
68   //! @param theEquation [in] the plane equation.
69   Standard_EXPORT Graphic3d_ClipPlane (const Graphic3d_Vec4d& theEquation);
70
71   //! Construct clip plane from the passed geometrical definition.
72   //! By default the plane is on, capping is turned off.
73   //! @param thePlane [in] the plane.
74   Standard_EXPORT Graphic3d_ClipPlane (const gp_Pln& thePlane);
75
76   //! Set plane equation by its geometrical definition.
77   //! The equation is specified in "world" coordinate system.
78   //! @param thePlane [in] the plane.
79   Standard_EXPORT void SetEquation (const gp_Pln& thePlane);
80
81   //! Set 4-component equation vector for clipping plane.
82   //! The equation is specified in "world" coordinate system.
83   //! @param theEquation [in] the XYZW (or "ABCD") equation vector.
84   Standard_EXPORT void SetEquation (const Graphic3d_Vec4d& theEquation);
85
86   //! Get 4-component equation vector for clipping plane.
87   //! @return clipping plane equation vector.
88   const Graphic3d_Vec4d& GetEquation() const { return myEquation; }
89
90   //! Get 4-component equation vector for clipping plane.
91   //! @return clipping plane equation vector.
92   const Graphic3d_Vec4d& ReversedEquation() const { return myEquationRev; }
93
94   //! Check that the clipping plane is turned on.
95   //! @return boolean flag indicating whether the plane is in on or off state.
96   Standard_Boolean IsOn() const
97   {
98     return myIsOn;
99   }
100
101   //! Change state of the clipping plane.
102   //! @param theIsOn [in] the flag specifying whether the graphic driver
103   //! clipping by this plane should be turned on or off.
104   Standard_EXPORT void SetOn(const Standard_Boolean theIsOn);
105
106   //! Change state of capping surface rendering.
107   //! @param theIsOn [in] the flag specifying whether the graphic driver should
108   //! perform rendering of capping surface produced by this plane. The graphic
109   //! driver produces this surface for convex graphics by means of stencil-test
110   //! and multi-pass rendering.
111   Standard_EXPORT void SetCapping(const Standard_Boolean theIsOn);
112
113   //! Check state of capping surface rendering.
114   //! @return true (turned on) or false depending on the state.
115   Standard_Boolean IsCapping() const
116   {
117     return myIsCapping;
118   }
119
120   //! Get geometrical definition.
121   //! @return geometrical definition of clipping plane
122   const gp_Pln& ToPlane() const { return myPlane; }
123
124   //! Clone plane. Virtual method to simplify copying procedure if plane
125   //! class is redefined at application level to add specific fields to it
126   //! e.g. id, name, etc.
127   //! @return new instance of clipping plane with same properties and attributes.
128   Standard_EXPORT virtual Handle(Graphic3d_ClipPlane) Clone() const;
129
130 public:
131
132   //! Return TRUE if this item defines a conjunction (logical AND) between a set of Planes.
133   //! Graphic3d_ClipPlane item defines either a Clipping halfspace (single Clipping Plane)
134   //! or a Clipping volume defined by a logical AND (conjunction) operation between a set of Planes defined as a Chain
135   //! (so that the volume cuts a space only in case if check fails for ALL Planes in the Chain).
136   //!
137   //! Note that Graphic3d_ClipPlane item cannot:
138   //! - Define a Chain with logical OR (disjunction) operation;
139   //!   this should be done through Graphic3d_SequenceOfHClipPlane.
140   //! - Define nested Chains.
141   //! - Disable Chain items; only entire Chain can be disabled (by disabled a head of Chain).
142   //!
143   //! The head of a Chain defines all visual properties of the Chain,
144   //! so that Graphic3d_ClipPlane of next items in a Chain merely defines only geometrical definition of the plane.
145   Standard_Boolean IsChain() const { return !myNextInChain.IsNull(); }
146
147   //! Return the previous plane in a Chain of Planes defining logical AND operation,
148   //! or NULL if there is no Chain or it is a first element in Chain.
149   //! When clipping is defined by a Chain of Planes,
150   //! it cuts a space only in case if check fails for all Planes in Chain.
151   Handle(Graphic3d_ClipPlane) ChainPreviousPlane() const { return myPrevInChain; }
152
153   //! Return the next plane in a Chain of Planes defining logical AND operation,
154   //! or NULL if there is no chain or it is a last element in chain.
155
156   const Handle(Graphic3d_ClipPlane)& ChainNextPlane() const { return myNextInChain; }
157
158   //! Return the number of chains in forward direction (including this item, so it is always >= 1).
159   //! For a head of Chain - returns the length of entire Chain.
160   Standard_Integer NbChainNextPlanes() const { return myChainLenFwd; }
161
162   //! Set the next plane in a Chain of Planes.
163   //! This operation also updates relationship between chains (Previous/Next items),
164   //! so that the previously set Next plane is cut off.
165   Standard_EXPORT void SetChainNextPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
166
167 public: // @name user-defined graphical attributes
168
169   //! Set material for rendering capping surface.
170   //! @param theMat [in] the material.
171   Standard_EXPORT void SetCappingMaterial (const Graphic3d_MaterialAspect& theMat);
172
173   //! @return capping material.
174   const Graphic3d_MaterialAspect& CappingMaterial() const { return myAspect->FrontMaterial(); }
175
176   //! Set texture to be applied on capping surface.
177   //! @param theTexture [in] the texture.
178   Standard_EXPORT void SetCappingTexture (const Handle(Graphic3d_TextureMap)& theTexture);
179
180   //! @return capping texture map.
181   Handle(Graphic3d_TextureMap) CappingTexture() const { return !myAspect->TextureSet().IsNull() && !myAspect->TextureSet()->IsEmpty()
182                                                               ? myAspect->TextureSet()->First()
183                                                               : Handle(Graphic3d_TextureMap)(); }
184
185   //! Set hatch style (stipple) and turn hatching on.
186   //! @param theStyle [in] the hatch style.
187   Standard_EXPORT void SetCappingHatch (const Aspect_HatchStyle theStyle);
188
189   //! @return hatching style.
190   Aspect_HatchStyle CappingHatch() const { return (Aspect_HatchStyle)myAspect->HatchStyle()->HatchType(); }
191
192   //! Set custom hatch style (stipple) and turn hatching on.
193   //! @param theStyle [in] the hatch pattern.
194   Standard_EXPORT void SetCappingCustomHatch (const Handle(Graphic3d_HatchStyle)& theStyle);
195
196   //! @return hatching style.
197   const Handle(Graphic3d_HatchStyle)& CappingCustomHatch() const { return myAspect->HatchStyle(); }
198
199   //! Turn on hatching.
200   Standard_EXPORT void SetCappingHatchOn();
201
202   //! Turn off hatching.
203   Standard_EXPORT void SetCappingHatchOff();
204
205   //! @return True if hatching mask is turned on.
206   Standard_Boolean IsHatchOn() const { return myAspect->InteriorStyle() == Aspect_IS_HATCH; }
207
208   //! This ID is used for managing associated resources in graphical driver.
209   //! The clip plane can be assigned within a range of IO which can be
210   //! displayed in separate OpenGl contexts. For each of the context an associated
211   //! OpenGl resource for graphical aspects should be created and kept.
212   //! The resources are stored in graphical driver for each of individual groups
213   //! of shared context under the clip plane identifier.
214   //! @return clip plane resource identifier string.
215   const TCollection_AsciiString& GetId() const
216   {
217     return myId;
218   }
219
220 public:
221
222   //! Return capping aspect.
223   //! @return capping surface rendering aspect.
224   const Handle(Graphic3d_AspectFillArea3d)& CappingAspect() const { return myAspect; }
225
226   //! Assign capping aspect.
227   Standard_EXPORT void SetCappingAspect (const Handle(Graphic3d_AspectFillArea3d)& theAspect);
228
229   //! Flag indicating whether material for capping plane should be taken from object.
230   //! Default value: FALSE (use dedicated capping plane material).
231   bool ToUseObjectMaterial() const { return (myFlags & Graphic3d_CappingFlags_ObjectMaterial) != 0; }
232
233   //! Set flag for controlling the source of capping plane material.
234   void SetUseObjectMaterial (bool theToUse) { setCappingFlag (theToUse, Graphic3d_CappingFlags_ObjectMaterial); }
235
236   //! Flag indicating whether texture for capping plane should be taken from object.
237   //! Default value: FALSE.
238   bool ToUseObjectTexture() const { return (myFlags & Graphic3d_CappingFlags_ObjectTexture) != 0; }
239
240   //! Set flag for controlling the source of capping plane texture.
241   void SetUseObjectTexture (bool theToUse) { setCappingFlag (theToUse, Graphic3d_CappingFlags_ObjectTexture); }
242
243   //! Flag indicating whether shader program for capping plane should be taken from object.
244   //! Default value: FALSE.
245   bool ToUseObjectShader() const { return (myFlags & Graphic3d_CappingFlags_ObjectShader) != 0; }
246
247   //! Set flag for controlling the source of capping plane shader program.
248   void SetUseObjectShader(bool theToUse) { setCappingFlag (theToUse, Graphic3d_CappingFlags_ObjectShader); }
249
250   //! Return true if some fill area aspect properties should be taken from object.
251   bool ToUseObjectProperties() const { return myFlags != Graphic3d_CappingFlags_None; }
252
253 public:
254
255   //! Check if the given point is outside / inside / on section.
256   Graphic3d_ClipState ProbePoint (const Graphic3d_Vec4d& thePoint) const
257   {
258     for (const Graphic3d_ClipPlane* aPlaneIter = this; aPlaneIter != NULL; aPlaneIter = aPlaneIter->myNextInChain.get())
259     {
260       Graphic3d_ClipState aPlnState = aPlaneIter->ProbePointHalfspace (thePoint);
261       if (aPlnState == Graphic3d_ClipState_On)
262       {
263         return Graphic3d_ClipState_On;
264       }
265       else if (aPlnState == Graphic3d_ClipState_Out
266             && aPlaneIter->myNextInChain.IsNull())
267       {
268         return Graphic3d_ClipState_Out;
269       }
270     }
271     return Graphic3d_ClipState_In;
272   }
273
274   //! Check if the given bounding box is fully outside / fully inside.
275   Graphic3d_ClipState ProbeBox (const Graphic3d_BndBox3d& theBox) const
276   {
277     Graphic3d_ClipState aPrevState = Graphic3d_ClipState_On;
278     for (const Graphic3d_ClipPlane* aPlaneIter = this; aPlaneIter != NULL; aPlaneIter = aPlaneIter->myNextInChain.get())
279     {
280       if (aPlaneIter->IsBoxFullOutHalfspace (theBox))
281       {
282         if (aPlaneIter->myNextInChain.IsNull())
283         {
284           return Graphic3d_ClipState_Out;
285         }
286         else if (aPrevState == Graphic3d_ClipState_In)
287         {
288           return Graphic3d_ClipState_On;
289         }
290         aPrevState = Graphic3d_ClipState_Out;
291       }
292       else if (aPlaneIter->IsBoxFullInHalfspace (theBox))
293       {
294         if (aPlaneIter->myNextInChain.IsNull())
295         {
296           return Graphic3d_ClipState_In;
297         }
298         else if (aPrevState == Graphic3d_ClipState_Out)
299         {
300           return Graphic3d_ClipState_On;
301         }
302         aPrevState = Graphic3d_ClipState_In;
303       }
304       else
305       {
306         return Graphic3d_ClipState_On;
307       }
308     }
309     return Graphic3d_ClipState_On;
310   }
311
312 public:
313
314   //! Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).
315   Graphic3d_ClipState ProbePointHalfspace (const Graphic3d_Vec4d& thePoint) const
316   {
317     const Standard_Real aVal = myEquation.Dot (thePoint);
318     return aVal < 0.0
319          ? Graphic3d_ClipState_Out
320          : (aVal == 0.0
321           ? Graphic3d_ClipState_On
322           : Graphic3d_ClipState_In);
323   }
324
325   //! Check if the given bounding box is fully outside / fully inside the half-space.
326   Graphic3d_ClipState ProbeBoxHalfspace (const Graphic3d_BndBox3d& theBox) const
327   {
328     if (IsBoxFullOutHalfspace (theBox))
329     {
330       return Graphic3d_ClipState_Out;
331     }
332     return IsBoxFullInHalfspace (theBox)
333          ? Graphic3d_ClipState_In
334          : Graphic3d_ClipState_On;
335   }
336
337   //! Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).
338   bool IsPointOutHalfspace (const Graphic3d_Vec4d& thePoint) const { return ProbePointHalfspace (thePoint) == Graphic3d_ClipState_Out; }
339
340   //! Check if the given bounding box is fully outside of the half-space (e.g. should be discarded by clipping plane).
341   bool IsBoxFullOutHalfspace (const Graphic3d_BndBox3d& theBox) const
342   {
343     const Graphic3d_Vec4d aMaxPnt (myEquation.x() > 0.0 ? theBox.CornerMax().x() : theBox.CornerMin().x(),
344                                    myEquation.y() > 0.0 ? theBox.CornerMax().y() : theBox.CornerMin().y(),
345                                    myEquation.z() > 0.0 ? theBox.CornerMax().z() : theBox.CornerMin().z(),
346                                    1.0);
347     return IsPointOutHalfspace (aMaxPnt);
348   }
349
350   //! Check if the given bounding box is fully inside (or touches from inside) the half-space (e.g. NOT discarded by clipping plane).
351   bool IsBoxFullInHalfspace (const Graphic3d_BndBox3d& theBox) const
352   {
353     const Graphic3d_Vec4d aMinPnt (myEquation.x() > 0.0 ? theBox.CornerMin().x() : theBox.CornerMax().x(),
354                                    myEquation.y() > 0.0 ? theBox.CornerMin().y() : theBox.CornerMax().y(),
355                                    myEquation.z() > 0.0 ? theBox.CornerMin().z() : theBox.CornerMax().z(),
356                                    1.0);
357     return !IsPointOutHalfspace (aMinPnt);
358   }
359
360 public: // @name modification counters
361
362   //! @return modification counter for equation.
363   unsigned int MCountEquation() const
364   {
365     return myEquationMod;
366   }
367
368   //! @return modification counter for aspect.
369   unsigned int MCountAspect() const
370   {
371     return myAspectMod;
372   }
373
374 private:
375
376   //! Generate unique object id for OpenGL graphic resource manager.
377   void makeId();
378
379   //! Set capping flag.
380   Standard_EXPORT void setCappingFlag (bool theToUse, int theFlag);
381
382   //! Update chain length in backward direction.
383   void updateChainLen();
384
385   //! Update inversed plane definition from main plane.
386   void updateInversedPlane()
387   {
388     gp_Pln aPlane = myPlane;
389     aPlane.SetAxis (aPlane.Axis().Reversed());
390     aPlane.Coefficients (myEquationRev[0], myEquationRev[1], myEquationRev[2], myEquationRev[3]);
391   }
392
393 private:
394
395   Handle(Graphic3d_AspectFillArea3d) myAspect;    //!< fill area aspect
396   Handle(Graphic3d_ClipPlane)   myNextInChain;    //!< next     plane in a chain of planes defining logical AND operation
397   Graphic3d_ClipPlane*          myPrevInChain;    //!< previous plane in a chain of planes defining logical AND operation
398   TCollection_AsciiString myId;                   //!< resource id
399   gp_Pln                  myPlane;                //!< plane definition
400   Graphic3d_Vec4d         myEquation;             //!< plane equation vector
401   Graphic3d_Vec4d         myEquationRev;          //!< reversed plane equation
402   Standard_Integer        myChainLenFwd;          //!< chain length in forward direction (including this item)
403   unsigned int            myFlags;                //!< capping flags
404   unsigned int            myEquationMod;          //!< modification counter for equation
405   unsigned int            myAspectMod;            //!< modification counter of aspect
406   Standard_Boolean        myIsOn;                 //!< state of the clipping plane
407   Standard_Boolean        myIsCapping;            //!< state of graphic driver capping
408
409 };
410
411 DEFINE_STANDARD_HANDLE (Graphic3d_ClipPlane, Standard_Transient)
412
413 #endif