summaryrefslogtreecommitdiff
path: root/inc/VrmlData_WorldInfo.hxx
blob: 0d51b54bbc9db65b8f52e9faecb77dcff63fc226 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// File:      VrmlData_WorldInfo.hxx
// Created:   01.08.07 07:24
// Author:    Alexander GRIGORIEV
// Copyright: Open Cascade 2007


#ifndef VrmlData_WorldInfo_HeaderFile
#define VrmlData_WorldInfo_HeaderFile

#include <VrmlData_Node.hxx>

/**
 * Data type for WorldInfo node
 */

class VrmlData_WorldInfo : public VrmlData_Node
{
 public:
  // ---------- PUBLIC METHODS ----------

  /**
   * Empty Constructor.
   */
  inline VrmlData_WorldInfo () : myTitle (0L) {}

  /**
   * Constructor.
   */
  Standard_EXPORT VrmlData_WorldInfo (const VrmlData_Scene&  theScene,
                                      const char             * theName = 0L,
                                      const char             * theTitle = 0L);

  /**
   * Set or modify the title.
   */
  Standard_EXPORT void SetTitle (const char * theString);

  /**
   * Add a string to the list of info strings.
   */
  Standard_EXPORT void  AddInfo (const char * theString);

  /**
   * Query the title string.
   */
  inline const char *   Title   () const
  { return myTitle; }

  /**
   * Return the iterator of Info strings.
   */
  inline NCollection_List <const char *>::Iterator
                        InfoIterator () const
  { return myInfo; }

  /**
   * Create a copy of this node.
   * If the parameter is null, a new copied node is created. Otherwise new node
   * is not created, but rather the given one is modified.
   */
  Standard_EXPORT virtual Handle(VrmlData_Node)
                        Clone   (const Handle(VrmlData_Node)& theOther) const;

  /**
   * Read the Node from input stream.
   */
  Standard_EXPORT virtual VrmlData_ErrorStatus
                        Read    (VrmlData_InBuffer& theBuffer);

  /**
   * Write the Node to the Scene output.
   */
  Standard_EXPORT virtual VrmlData_ErrorStatus
                        Write   (const char * thePrefix) const;

  /**
   * Returns True if the node is default, then it would not be written.
   */
  Standard_EXPORT virtual Standard_Boolean
                        IsDefault() const;

 private:
  // ---------- PRIVATE FIELDS ----------

  const char                    * myTitle;
  NCollection_List <const char *> myInfo;

 public:
// Declaration of CASCADE RTTI
DEFINE_STANDARD_RTTI (VrmlData_WorldInfo)
};

// Definition of HANDLE object using Standard_DefineHandle.hxx
DEFINE_STANDARD_HANDLE (VrmlData_WorldInfo, VrmlData_Node)


#endif