src/Vrml/Vrml_Separator.hxx

   1 // Created on: 1997-03-27
   2 // Created by: Alexander BRIVIN and Dmitry TARASOV
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Vrml_Separator_HeaderFile
  18 #define _Vrml_Separator_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Vrml_SeparatorRenderCulling.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Standard_OStream.hxx>
  27
  28
  29 //! defines a Separator node of VRML specifying group properties.
  30 //! This group node performs a push (save) of the traversal state before traversing its children
  31 //! and a pop (restore) after traversing them. This isolates the separator's children from the
  32 //! rest of the scene graph. A separator can include lights, cameras, coordinates, normals,
  33 //! bindings, and all other properties.
  34 //! Separators can also perform render culling. Render culling skips over traversal of the
  35 //! separator's children if they are not going to be rendered, based on the comparison of the
  36 //! separator's bounding box with the current view volume. Culling is controlled by the
  37 //! renderCulling field. These are set to AUTO by default, allowing the implementation to
  38 //! decide whether or not to cull.
  39 class Vrml_Separator
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   Standard_EXPORT Vrml_Separator(const Vrml_SeparatorRenderCulling aRenderCulling);
  47
  48   Standard_EXPORT Vrml_Separator();
  49
  50   Standard_EXPORT void SetRenderCulling (const Vrml_SeparatorRenderCulling aRenderCulling);
  51
  52   Standard_EXPORT Vrml_SeparatorRenderCulling RenderCulling() const;
  53
  54   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream);
  55
  56
  57
  58
  59 protected:
  60
  61
  62
  63
  64
  65 private:
  66
  67
  68
  69   Vrml_SeparatorRenderCulling myRenderCulling;
  70   Standard_Boolean myFlagPrint;
  71
  72
  73 };
  74
  75
  76
  77
  78
  79
  80
  81 #endif // _Vrml_Separator_HeaderFile