include/opencascade/Vrml_Switch.hxx

0001 // Created on: 1997-02-12
0002 // Created by: Alexander BRIVIN
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_Switch_HeaderFile
0018 #define _Vrml_Switch_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_OStream.hxx>
0025
0026 //! defines a Switch node of VRML specifying group properties.
0027 //! This  group  node  traverses  one,  none,  or  all  of  its  children.
0028 //! One  can  use  this  node  to  switch  on  and  off  the  effects  of  some
0029 //! properties  or  to  switch  between  different  properties.
0030 //! The  whichChild  field  specifies  the  index  of  the  child  to  traverse,
0031 //! where  the  first  child  has  index  0.
0032 //! A  value  of  -1  (the  default)  means  do  not  traverse  any  children.
0033 //! A  value  of  -3  traverses  all  children,  making  the  switch  behave  exactly
0034 //! like  a  regular  Group.
0035 class Vrml_Switch
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   Standard_EXPORT Vrml_Switch(const Standard_Integer aWhichChild = -1);
0041
0042   Standard_EXPORT void SetWhichChild(const Standard_Integer aWhichChild);
0043
0044   Standard_EXPORT Standard_Integer WhichChild() const;
0045
0046   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0047
0048 protected:
0049 private:
0050   Standard_Integer myWhichChild;
0051 };
0052
0053 #endif // _Vrml_Switch_HeaderFile