include/opencascade/VrmlData_WorldInfo.hxx

0001 // Created on: 2007-08-01
0002 // Created by: Alexander GRIGORIEV
0003 // Copyright (c) 2007-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef VrmlData_WorldInfo_HeaderFile
0017 #define VrmlData_WorldInfo_HeaderFile
0018
0019 #include <VrmlData_Node.hxx>
0020
0021 /**
0022  * Data type for WorldInfo node
0023  */
0024
0025 class VrmlData_WorldInfo : public VrmlData_Node
0026 {
0027  public:
0028   // ---------- PUBLIC METHODS ----------
0029
0030   /**
0031    * Empty Constructor.
0032    */
0033   inline VrmlData_WorldInfo () : myTitle (0L) {}
0034
0035   /**
0036    * Constructor.
0037    */
0038   Standard_EXPORT VrmlData_WorldInfo (const VrmlData_Scene&  theScene,
0039                                       const char             * theName = 0L,
0040                                       const char             * theTitle = 0L);
0041
0042   /**
0043    * Set or modify the title.
0044    */
0045   Standard_EXPORT void SetTitle (const char * theString);
0046
0047   /**
0048    * Add a string to the list of info strings.
0049    */
0050   Standard_EXPORT void  AddInfo (const char * theString);
0051
0052   /**
0053    * Query the title string.
0054    */
0055   inline const char *   Title   () const
0056   { return myTitle; }
0057
0058   /**
0059    * Return the iterator of Info strings.
0060    */
0061   inline NCollection_List <const char *>::Iterator
0062                         InfoIterator () const
0063   { return myInfo; }
0064
0065   /**
0066    * Create a copy of this node.
0067    * If the parameter is null, a new copied node is created. Otherwise new node
0068    * is not created, but rather the given one is modified.
0069    */
0070   Standard_EXPORT virtual Handle(VrmlData_Node)
0071                         Clone   (const Handle(VrmlData_Node)& theOther) const Standard_OVERRIDE;
0072
0073   /**
0074    * Read the Node from input stream.
0075    */
0076   Standard_EXPORT virtual VrmlData_ErrorStatus
0077                         Read    (VrmlData_InBuffer& theBuffer) Standard_OVERRIDE;
0078
0079   /**
0080    * Write the Node to the Scene output.
0081    */
0082   Standard_EXPORT virtual VrmlData_ErrorStatus
0083                         Write   (const char * thePrefix) const Standard_OVERRIDE;
0084
0085   /**
0086    * Returns True if the node is default, then it would not be written.
0087    */
0088   Standard_EXPORT virtual Standard_Boolean
0089                         IsDefault() const Standard_OVERRIDE;
0090
0091  private:
0092   // ---------- PRIVATE FIELDS ----------
0093
0094   const char                    * myTitle;
0095   NCollection_List <const char *> myInfo;
0096
0097  public:
0098 // Declaration of CASCADE RTTI
0099 DEFINE_STANDARD_RTTIEXT(VrmlData_WorldInfo,VrmlData_Node)
0100 };
0101
0102 // Definition of HANDLE object using Standard_DefineHandle.hxx
0103 DEFINE_STANDARD_HANDLE (VrmlData_WorldInfo, VrmlData_Node)
0104
0105
0106 #endif