0024023: Revamp the OCCT Handle -- automatic
[occt.git] / src / OpenGl / OpenGl_CappingPlaneResource.hxx
CommitLineData
4269bd1b 1// Created on: 2013-08-15
2// Created by: Anton POLETAEV
d5f74e42 3// Copyright (c) 2013-2014 OPEN CASCADE SAS
4269bd1b 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
4269bd1b 6//
d5f74e42 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
973c2be1 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.
4269bd1b 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
4269bd1b 15
16#ifndef _OpenGl_CappingPlaneResource_H__
17#define _OpenGl_CappingPlaneResource_H__
18
e1c659da 19#include <OpenGl_PrimitiveArray.hxx>
4269bd1b 20#include <OpenGl_Resource.hxx>
21#include <OpenGl_AspectFace.hxx>
22#include <OpenGl_Matrix.hxx>
23#include <Graphic3d_ClipPlane.hxx>
24
4269bd1b 25
26DEFINE_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).
35class OpenGl_CappingPlaneResource : public OpenGl_Resource
36{
37public:
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.
e1c659da 53 Standard_EXPORT virtual void Release (OpenGl_Context* theContext) Standard_OVERRIDE;
4269bd1b 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
e1c659da 61 //! @return primitive array of vertices to render infinite plane.
62 inline const OpenGl_PrimitiveArray& Primitives() const { return myPrimitives; }
63
4269bd1b 64private:
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
73private:
74
e1c659da 75 OpenGl_PrimitiveArray myPrimitives; //!< vertices and texture coordinates for rendering
4269bd1b 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
82public:
83
ec357c5c 84 DEFINE_STANDARD_RTTI(OpenGl_CappingPlaneResource, OpenGl_Resource) // Type definition
4269bd1b 85
86};
87
88#endif