File: iicm.vrml.pw.VRMLparser.html

package info (click to toggle)
vrwave 0.9-4
  • links: PTS
  • area: non-free
  • in suites: slink
  • size: 5,032 kB
  • ctags: 7,153
  • sloc: java: 15,050; ansic: 8,219; sh: 458; makefile: 181
file content (178 lines) | stat: -rw-r--r-- 6,446 bytes parent folder | download | duplicates (3)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Thu Sep 25 20:23:36 MET DST 1997 -->
<a name="_top_"></a>
<title>
  Class iicm.vrml.pw.VRMLparser
</title>
</head>
<body background="vrwavebg.gif">
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-iicm.vrml.pw.html">This Package</a>  <a href="iicm.vrml.pw.Traverser.html#_top_">Previous</a>  <a href="iicm.vrml.pw.Viewpoint.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
<hr>
<h1>
  Class iicm.vrml.pw.VRMLparser
</h1>
<pre>
<a href="java.lang.Object.html#_top_">java.lang.Object</a>
   |
   +----iicm.vrml.pw.VRMLparser
</pre>
<hr>
<dl>
  <dt> public class <b>VRMLparser</b>
  <dt> extends <a href="java.lang.Object.html#_top_">Object</a>
</dl>
VRMLparser - VRML parser class
Copyright (c) 1996,97 IICM
<hr>
<a name="index"></a>
<h2>
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
</h2>
<dl>
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#VRMLparser(java.io.InputStream)"><b>VRMLparser</b></a>(InputStream)
  <dd> create VRMLparser for specific input stream to read from.
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#VRMLparser(java.io.InputStream, iicm.vrml.pw.ParserOutput)"><b>VRMLparser</b></a>(InputStream, ParserOutput)
  <dd> VRMLparser constructor with message callbacks

</dl>
<h2>
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getNodeNames()"><b>getNodeNames</b></a>()
  <dd> 
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getVersion()"><b>getVersion</b></a>()
  <dd> get VRML version; only valid after checkHeader or setVersion

  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#isMovingWorlds()"><b>isMovingWorlds</b></a>()
  <dd> this parser is currently designed for VRML 2.0 only; this method
could be used to distinguish Moving World Scenes from VRML 1.0

  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#readBody()"><b>readBody</b></a>()
  <dd> read VRML body
should not be called before readHeader or setVersion

  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#readHeader()"><b>readHeader</b></a>()
  <dd> check header of VRML data stream

  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#readStream()"><b>readStream</b></a>()
  <dd> parse complete VRML stream (header + body)

  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setVersion(float)"><b>setVersion</b></a>(float)
  <dd> set VRML version for headerless VRML stream

</dl>
<a name="constructors"></a>
<h2>
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
</h2>
<a name="VRMLparser"></a>
<a name="VRMLparser(java.io.InputStream)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>VRMLparser</b>
<pre>
  public VRMLparser(<a href="java.io.InputStream.html#_top_">InputStream</a> input)
</pre>
<dl>
  <dd> create VRMLparser for specific input stream to read from.
(underlying parser buffers input stream itself.)
Note: will not return before 1st byte of InputStream is read (blocks)
</dl>
<a name="VRMLparser(java.io.InputStream, iicm.vrml.pw.ParserOutput)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>VRMLparser</b>
<pre>
  public VRMLparser(<a href="java.io.InputStream.html#_top_">InputStream</a> input,
                    <a href="iicm.vrml.pw.ParserOutput.html#_top_">ParserOutput</a> po)
</pre>
<dl>
  <dd> VRMLparser constructor with message callbacks
</dl>
<a name="methods"></a>
<h2>
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="setVersion(float)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setVersion"><b>setVersion</b></a>
<pre>
  public void setVersion(float ver)
</pre>
<dl>
  <dd> set VRML version for headerless VRML stream
</dl>
<a name="getVersion()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getVersion"><b>getVersion</b></a>
<pre>
  public float getVersion()
</pre>
<dl>
  <dd> get VRML version; only valid after checkHeader or setVersion
</dl>
<a name="isMovingWorlds()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="isMovingWorlds"><b>isMovingWorlds</b></a>
<pre>
  public boolean isMovingWorlds()
</pre>
<dl>
  <dd> this parser is currently designed for VRML 2.0 only; this method
could be used to distinguish Moving World Scenes from VRML 1.0
  <dl>
    <dt> <b>Returns:</b>
    <dd> flag, whether data is in Moving Worlds (VRML 2.0) format
  </dl>
</dl>
<a name="readStream()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="readStream"><b>readStream</b></a>
<pre>
  public <a href="iicm.vrml.pw.GroupNode.html#_top_">GroupNode</a> readStream()
</pre>
<dl>
  <dd> parse complete VRML stream (header + body)
  <dl>
    <dt> <b>Returns:</b>
    <dd> root node
    <dt> <b>See Also:</b>
    <dd> <a href="readHeader, readBody.html#_top_">readHeader, readBody</a>
  </dl>
</dl>
<a name="readHeader()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="readHeader"><b>readHeader</b></a>
<pre>
  public float readHeader()
</pre>
<dl>
  <dd> check header of VRML data stream
  <dl>
    <dt> <b>Returns:</b>
    <dd> VRML version identifier or 0 on failure
  </dl>
</dl>
<a name="readBody()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="readBody"><b>readBody</b></a>
<pre>
  public <a href="iicm.vrml.pw.GroupNode.html#_top_">GroupNode</a> readBody()
</pre>
<dl>
  <dd> read VRML body
should not be called before readHeader or setVersion
</dl>
<a name="getNodeNames()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getNodeNames"><b>getNodeNames</b></a>
<pre>
  public <a href="java.util.Hashtable.html#_top_">Hashtable</a> getNodeNames()
</pre>
<hr>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-iicm.vrml.pw.html">This Package</a>  <a href="iicm.vrml.pw.Traverser.html#_top_">Previous</a>  <a href="iicm.vrml.pw.Viewpoint.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
</body>
</html>