include/opencascade/Vrml_WWWAnchor.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_WWWAnchor_HeaderFile
0018 #define _Vrml_WWWAnchor_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TCollection_AsciiString.hxx>
0025 #include <Vrml_WWWAnchorMap.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028
0029 //! defines a WWWAnchor node of VRML specifying group properties.
0030 //! The  WWWAnchor  group  node  loads  a  new  scene  into  a  VRML  browser
0031 //! when  one  of  its  children  is  closen.  Exactly  how  a  user  "chooses"
0032 //! a  child  of  the  WWWAnchor  is  up  to  the  VRML browser.
0033 //! WWWAnchor  with  an  empty  ("")  name  does  nothing  when  its
0034 //! children  are  chosen.
0035 //! WWWAnchor  behaves  like  a  Separator,  pushing  the  traversal  state
0036 //! before  traversing  its  children  and  popping  it  afterwards.
0037 class Vrml_WWWAnchor
0038 {
0039 public:
0040
0041   DEFINE_STANDARD_ALLOC
0042
0043
0044   Standard_EXPORT Vrml_WWWAnchor(const TCollection_AsciiString& aName = "", const TCollection_AsciiString& aDescription = "", const Vrml_WWWAnchorMap aMap = Vrml_MAP_NONE);
0045
0046   Standard_EXPORT void SetName (const TCollection_AsciiString& aName);
0047
0048   Standard_EXPORT TCollection_AsciiString Name() const;
0049
0050   Standard_EXPORT void SetDescription (const TCollection_AsciiString& aDescription);
0051
0052   Standard_EXPORT TCollection_AsciiString Description() const;
0053
0054   Standard_EXPORT void SetMap (const Vrml_WWWAnchorMap aMap);
0055
0056   Standard_EXPORT Vrml_WWWAnchorMap Map() const;
0057
0058   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
0059
0060
0061
0062
0063 protected:
0064
0065
0066
0067
0068
0069 private:
0070
0071
0072
0073   TCollection_AsciiString myName;
0074   TCollection_AsciiString myDescription;
0075   Vrml_WWWAnchorMap myMap;
0076
0077
0078 };
0079
0080
0081
0082
0083
0084
0085
0086 #endif // _Vrml_WWWAnchor_HeaderFile