include/opencascade/Vrml_Separator.hxx

0001 // Created on: 1997-03-27
0002 // Created by: Alexander BRIVIN and Dmitry TARASOV
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Vrml_Separator_HeaderFile
0018 #define _Vrml_Separator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Vrml_SeparatorRenderCulling.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028 //! defines a Separator node of VRML specifying group properties.
0029 //! This group node performs a push (save) of the traversal state before traversing its children
0030 //! and a pop (restore) after traversing them. This isolates the separator's children from the
0031 //! rest of the scene graph. A separator can include lights, cameras, coordinates, normals,
0032 //! bindings, and all other properties.
0033 //! Separators can also perform render culling. Render culling skips over traversal of the
0034 //! separator's children if they are not going to be rendered, based on the comparison of the
0035 //! separator's bounding box with the current view volume. Culling is controlled by the
0036 //! renderCulling field. These are set to AUTO by default, allowing the implementation to
0037 //! decide whether or not to cull.
0038 class Vrml_Separator
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   Standard_EXPORT Vrml_Separator(const Vrml_SeparatorRenderCulling aRenderCulling);
0044
0045   Standard_EXPORT Vrml_Separator();
0046
0047   Standard_EXPORT void SetRenderCulling(const Vrml_SeparatorRenderCulling aRenderCulling);
0048
0049   Standard_EXPORT Vrml_SeparatorRenderCulling RenderCulling() const;
0050
0051   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream);
0052
0053 private:
0054   Vrml_SeparatorRenderCulling myRenderCulling;
0055   bool                        myFlagPrint;
0056 };
0057
0058 #endif // _Vrml_Separator_HeaderFile