0024023: Revamp the OCCT Handle -- general
[occt.git] / src / OpenGl / OpenGl_CappingPlaneResource.hxx
1 // Created on: 2013-08-15
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 _OpenGl_CappingPlaneResource_H__
17 #define _OpenGl_CappingPlaneResource_H__
18
19 #include <OpenGl_PrimitiveArray.hxx>
20 #include <OpenGl_Resource.hxx>
21 #include <OpenGl_AspectFace.hxx>
22 #include <OpenGl_Matrix.hxx>
23 #include <Graphic3d_ClipPlane.hxx>
24
25 class OpenGl_CappingPlaneResource;
26 DEFINE_STANDARD_HANDLE (OpenGl_CappingPlaneResource, OpenGl_Resource)
27
28 //! Container of graphical resources for rendering capping plane
29 //! associated to graphical clipping plane.
30 //! This resource holds data necessary for OpenGl_CappingAlgo.
31 //! This object is implemented as OpenGl resource for the following reasons:
32 //! - one instance should be shared between contexts.
33 //! - instance associated to Graphic3d_ClipPlane data by id.
34 //! - should created and released within context (owns OpenGl elements and resources).
35 class OpenGl_CappingPlaneResource : public OpenGl_Resource
36 {
37 public:
38
39   //! Constructor.
40   //! Create capping plane presentation associated to clipping plane data.
41   //! @param thePlane [in] the plane data.
42   Standard_EXPORT OpenGl_CappingPlaneResource (const Handle(Graphic3d_ClipPlane)& thePlane);
43
44   //! Destroy object.
45   Standard_EXPORT virtual ~OpenGl_CappingPlaneResource();
46
47   //! Update resource data in the passed context.
48   //! @param theContext [in] the context.
49   Standard_EXPORT void Update (const Handle(OpenGl_Context)& theContext);
50
51   //! Release associated OpenGl resources.
52   //! @param theContext [in] the resource context.
53   Standard_EXPORT virtual void Release (OpenGl_Context* theContext) Standard_OVERRIDE;
54
55   //! @return aspect face for rendering capping surface.
56   inline const OpenGl_AspectFace* AspectFace() const { return myAspect; }
57
58   //! @return evaluated orientation matrix to transform infinite plane.
59   inline const OpenGl_Matrix* Orientation() const { return &myOrientation; }
60
61   //! @return primitive array of vertices to render infinite plane.
62   inline const OpenGl_PrimitiveArray& Primitives() const { return myPrimitives; }
63
64 private:
65
66   //! Update precomputed plane orientation matrix.
67   void UpdateTransform();
68
69   //! Update resources.
70   //! @param theContext [in] the context.
71   void UpdateAspect (const Handle(OpenGl_Context)& theContext);
72
73 private:
74
75   OpenGl_PrimitiveArray       myPrimitives;    //!< vertices and texture coordinates for rendering
76   OpenGl_Matrix               myOrientation;   //!< plane transformation matrix.
77   OpenGl_AspectFace*          myAspect;        //!< capping face aspect.
78   Handle(Graphic3d_ClipPlane) myPlaneRoot;     //!< parent clipping plane structure.
79   unsigned int                myEquationMod;   //!< modification counter for plane equation.
80   unsigned int                myAspectMod;     //!< modification counter for aspect.
81
82 public:
83
84   DEFINE_STANDARD_RTTI(OpenGl_CappingPlaneResource, OpenGl_Resource) // Type definition
85
86 };
87
88 #endif