EIC code displayed by LXR master/​include/​opencascade/​OpenGl_SceneGeometry.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-16 09:18:16

 // Created on: 2013-08-27
 // Created by: Denis BOGOLEPOV
 // Copyright (c) 2013-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef OpenGl_SceneGeometry_HeaderFile
 #define OpenGl_SceneGeometry_HeaderFile
 
 #include <BVH_Geometry.hxx>
 #include <BVH_Triangulation.hxx>
 #include <BVH_BinnedBuilder.hxx>
 #include <NCollection_LinearVector.hxx>
 #include <OpenGl_Texture.hxx>
 #include <OpenGl_Sampler.hxx>
 
 class OpenGl_Element;
 struct OpenGl_ElementNode;
 class OpenGl_Group;
 
 namespace OpenGl_Raytrace
 {
 //! Checks to see if the group contains ray-trace geometry.
 Standard_EXPORT bool IsRaytracedGroup(const OpenGl_Group* theGroup);
 
 //! Checks to see if the element contains ray-trace geometry.
 Standard_EXPORT bool IsRaytracedElement(const OpenGl_ElementNode* theNode);
 
 //! Checks to see if the element contains ray-trace geometry.
 Standard_EXPORT bool IsRaytracedElement(const OpenGl_Element* theElement);
 } // namespace OpenGl_Raytrace
 
 //! Stores properties of surface material.
 struct OpenGl_RaytraceMaterial
 {
   BVH_Vec4f Ambient;          //!< Ambient reflection coefficient
   BVH_Vec4f Diffuse;          //!< Diffuse reflection coefficient
   BVH_Vec4f Specular;         //!< Glossy  reflection coefficient
   BVH_Vec4f Emission;         //!< Material emission
   BVH_Vec4f Reflection;       //!< Specular reflection coefficient
   BVH_Vec4f Refraction;       //!< Specular refraction coefficient
   BVH_Vec4f Transparency;     //!< Material transparency
   BVH_Mat4f TextureTransform; //!< Texture transformation matrix
 
   //! Physically-based material properties (used in path tracing engine).
   struct Physical
   {
     BVH_Vec4f Kc;          //!< Weight of coat specular/glossy BRDF
     BVH_Vec4f Kd;          //!< Weight of base diffuse BRDF
     BVH_Vec4f Ks;          //!< Weight of base specular/glossy BRDF
     BVH_Vec4f Kt;          //!< Weight of base specular/glossy BTDF
     BVH_Vec4f Le;          //!< Radiance emitted by the surface
     BVH_Vec4f FresnelCoat; //!< Fresnel coefficients of coat layer
     BVH_Vec4f FresnelBase; //!< Fresnel coefficients of base layer
     BVH_Vec4f Absorption;  //!< Absorption color/intensity
   } BSDF;
 
 public:
   //! Empty constructor.
   Standard_EXPORT OpenGl_RaytraceMaterial();
 
   //! Returns packed (serialized) representation of material.
   const float* Packed() { return reinterpret_cast<float*>(this); }
 };
 
 //! Stores properties of OpenGL light source.
 struct OpenGl_RaytraceLight
 {
 
   BVH_Vec4f Emission; //!< Diffuse intensity (in terms of OpenGL)
   BVH_Vec4f Position; //!< Position of light source (in terms of OpenGL)
 
 public:
   //! Creates new light source.
   OpenGl_RaytraceLight() = default;
 
   //! Creates new light source.
   Standard_EXPORT OpenGl_RaytraceLight(const BVH_Vec4f& theEmission, const BVH_Vec4f& thePosition);
 
   //! Returns packed (serialized) representation of light source.
   const float* Packed() { return reinterpret_cast<float*>(this); }
 };
 
 //! Shared pointer to quad BVH (QBVH) tree.
 typedef opencascade::handle<BVH_Tree<float, 3, BVH_QuadTree>> QuadBvhHandle;
 typedef BVH_Triangulation<float, 3>                           OpenGl_BVHTriangulation3f;
 
 //! Triangulation of single OpenGL primitive array.
 class OpenGl_TriangleSet : public OpenGl_BVHTriangulation3f
 {
   DEFINE_STANDARD_RTTIEXT(OpenGl_TriangleSet, OpenGl_BVHTriangulation3f)
 public:
   //! Value of invalid material index to return in case of errors.
   static const int INVALID_MATERIAL = -1;
 
 public:
   //! Creates new OpenGL element triangulation.
   Standard_EXPORT OpenGl_TriangleSet(const size_t                                      theArrayID,
                                      const opencascade::handle<BVH_Builder<float, 3>>& theBuilder);
 
   //! Returns ID of associated primitive array.
   size_t AssociatedPArrayID() const { return myArrayID; }
 
   //! Returns material index of triangle set.
   int MaterialIndex() const
   {
     if (Elements.IsEmpty())
     {
       return INVALID_MATERIAL;
     }
 
     return Elements.First().w();
   }
 
   //! Sets material index for entire triangle set.
   void SetMaterialIndex(int theMatID)
   {
     for (size_t anIdx = 0; anIdx < Elements.Size(); ++anIdx)
     {
       Elements[anIdx].w() = theMatID;
     }
   }
 
   //! Returns AABB of primitive set.
   BVH_BoxNt Box() const override;
 
   //! Returns AABB of the given object.
   using BVH_Triangulation<float, 3>::Box;
 
   //! Returns centroid position along the given axis.
   Standard_EXPORT float Center(const int theIndex, const int theAxis) const override;
 
   //! Returns quad BVH (QBVH) tree produced from binary BVH.
   Standard_EXPORT const QuadBvhHandle& QuadBVH();
 
 public:
   BVH_Array3f Normals; //!< Array of vertex normals.
   BVH_Array2f TexCrds; //!< Array of texture coords.
 
 private:
   size_t myArrayID; //!< ID of associated primitive array.
 
   QuadBvhHandle myQuadBVH; //!< QBVH produced from binary BVH tree.
 };
 
 //! Stores geometry of ray-tracing scene.
 class OpenGl_RaytraceGeometry : public BVH_Geometry<float, 3>
 {
 public:
   //! Value of invalid offset to return in case of errors.
   static const int INVALID_OFFSET = -1;
 
   //! Maximum number of textures used in ray-tracing shaders.
   //! This is not restriction of the solution implemented, but
   //! rather the reasonable limit of the number of textures in
   //! various applications (can be increased if needed).
   static const int MAX_TEX_NUMBER = 32;
 
 public:
   //! Array of properties of light sources.
   NCollection_LinearVector<OpenGl_RaytraceLight> Sources;
 
   //! Array of 'front' material properties.
   NCollection_LinearVector<OpenGl_RaytraceMaterial> Materials;
 
   //! Global ambient from all light sources.
   BVH_Vec4f Ambient;
 
 public:
   //! Creates uninitialized ray-tracing geometry.
   OpenGl_RaytraceGeometry()
       : myTopLevelTreeDepth(0),
         myBotLevelTreeDepth(0)
   {
     //
   }
 
   //! Releases resources of ray-tracing geometry.
   ~OpenGl_RaytraceGeometry() override
   {
     //
   }
 
   //! Clears only ray-tracing materials.
   void ClearMaterials()
   {
     Materials.Clear(true);
     myTextures.Clear();
   }
 
   //! Clears ray-tracing geometry.
   Standard_EXPORT void Clear() override;
 
 public: //! @name methods related to acceleration structure
   //! Performs post-processing of high-level scene BVH.
   Standard_EXPORT bool ProcessAcceleration();
 
   //! Returns offset of bottom-level BVH for given leaf node.
   //! If the node index is not valid the function returns -1.
   //! @note Can be used after processing acceleration structure.
   Standard_EXPORT int AccelerationOffset(int theNodeIdx);
 
   //! Returns offset of triangulation vertices for given leaf node.
   //! If the node index is not valid the function returns -1.
   //! @note Can be used after processing acceleration structure.
   Standard_EXPORT int VerticesOffset(int theNodeIdx);
 
   //! Returns offset of triangulation elements for given leaf node.
   //! If the node index is not valid the function returns -1.
   //! @note Can be used after processing acceleration structure.
   Standard_EXPORT int ElementsOffset(int theNodeIdx);
 
   //! Returns triangulation data for given leaf node.
   //! If the node index is not valid the function returns NULL.
   //! @note Can be used after processing acceleration structure.
   Standard_EXPORT OpenGl_TriangleSet* TriangleSet(int theNodeIdx);
 
   //! Returns quad BVH (QBVH) tree produced from binary BVH.
   Standard_EXPORT const QuadBvhHandle& QuadBVH();
 
 public: //! @name methods related to texture management
   //! Checks if scene contains textured objects.
   bool HasTextures() const { return !myTextures.IsEmpty(); }
 
   //! Adds new OpenGL texture to the scene and returns its index.
   Standard_EXPORT int AddTexture(const occ::handle<OpenGl_Texture>& theTexture);
 
   //! Updates unique 64-bit texture handles to use in shaders.
   Standard_EXPORT bool UpdateTextureHandles(const occ::handle<OpenGl_Context>& theContext);
 
   //! Makes the OpenGL texture handles resident (must be called before using).
   Standard_EXPORT bool AcquireTextures(const occ::handle<OpenGl_Context>& theContext);
 
   //! Makes the OpenGL texture handles non-resident (must be called after using).
   Standard_EXPORT bool ReleaseTextures(const occ::handle<OpenGl_Context>& theContext) const;
 
   //! Returns array of texture handles.
   const NCollection_LinearVector<GLuint64>& TextureHandles() const { return myTextureHandles; }
 
   //! Releases OpenGL resources.
   void ReleaseResources(const occ::handle<OpenGl_Context>&)
   {
     //
   }
 
 public: //! @name auxiliary methods
   //! Returns depth of top-level scene BVH from last build.
   int TopLevelTreeDepth() const { return myTopLevelTreeDepth; }
 
   //! Returns maximum depth of bottom-level scene BVHs from last build.
   int BotLevelTreeDepth() const { return myBotLevelTreeDepth; }
 
 protected:
   // clang-format off
   NCollection_DynamicArray<occ::handle<OpenGl_Texture>> myTextures;           //!< Array of texture maps shared between rendered objects
   NCollection_LinearVector<GLuint64>                    myTextureHandles;     //!< Array of unique 64-bit texture handles obtained from OpenGL
   int                           myTopLevelTreeDepth;  //!< Depth of high-level scene BVH from last build
   int                           myBotLevelTreeDepth;  //!< Maximum depth of bottom-level scene BVHs from last build
   // clang-format on
 
   QuadBvhHandle myQuadBVH; //!< QBVH produced from binary BVH tree.
 };
 
 #endif

This page was automatically generated by the 2.3.7 LXR engine. The LXR team