<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VTK: dox/Hybrid/vtkX3DExporterWriter.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>dox/Hybrid/vtkX3DExporterWriter.h</h1><a href="a02866.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span> <a name="l00002"></a>00002 <span class="comment"></span> <a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span> <a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkX3DExporterWriter.h,v $</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span> <a name="l00007"></a>00007 <span class="comment"> All rights reserved.</span> <a name="l00008"></a>00008 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span> <a name="l00011"></a>00011 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span> <a name="l00012"></a>00012 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span> <a name="l00015"></a>00015 <span class="preprocessor">#ifndef __vtkX3DExporterWriter_h</span> <a name="l00016"></a>00016 <span class="preprocessor"></span><span class="preprocessor">#define __vtkX3DExporterWriter_h</span> <a name="l00017"></a>00017 <span class="preprocessor"></span> <a name="l00018"></a>00018 <span class="preprocessor">#include <<a class="code" href="a02079.html">vtkObject.h</a>></span> <a name="l00019"></a>00019 <span class="preprocessor">#include <vtkstd/vector></span> <span class="comment">// Needed as function parameter </span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="comment">// Forward declarations</span> <a name="l00022"></a>00022 <span class="keyword">class </span><a class="code" href="a00356.html" title="abstract superclass for arrays of numeric data">vtkDataArray</a>; <a name="l00023"></a>00023 <span class="keyword">class </span><a class="code" href="a01784.html" title="dynamic, self-adjusting array of unsigned char">vtkUnsignedCharArray</a>; <a name="l00024"></a>00024 <span class="keyword">class </span><a class="code" href="a00242.html" title="object to represent cell connectivity">vtkCellArray</a>; <a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="comment">// Description:</span> <a name="l00027"></a>00027 <span class="comment">// vtkX3DExporterWriter is the definition for</span> <a name="l00028"></a>00028 <span class="comment">// classes that implement a encoding for the</span> <a name="l00029"></a>00029 <span class="comment">// X3D exporter</span> <a name="l00030"></a><a class="code" href="a01897.html">00030</a> <span class="keyword">class </span><a class="code" href="a02170.html#9e9a05a8377523b4f8d707441f65786d">VTK_HYBRID_EXPORT</a> <a class="code" href="a01897.html">vtkX3DExporterWriter</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> <a name="l00031"></a>00031 { <a name="l00032"></a>00032 <span class="keyword">public</span>: <a name="l00033"></a><a class="code" href="a01897.html#634ef9f62f0f7ba39f6e6bc8c1b628d9">00033</a> vtkTypeRevisionMacro(<a class="code" href="a01897.html">vtkX3DExporterWriter</a>, <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>); <a name="l00034"></a>00034 <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent); <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="comment">// Description:</span> <a name="l00037"></a>00037 <span class="comment">// Opens the file specified with file</span> <a name="l00038"></a>00038 <span class="comment">// returns 1 if sucessfull otherwise 0</span> <a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">int</span> OpenFile(<span class="keyword">const</span> <span class="keywordtype">char</span>* file) = 0; <a name="l00040"></a>00040 <span class="comment">// Closes the file if open</span> <a name="l00041"></a>00041 <span class="keyword">virtual</span> <span class="keywordtype">void</span> CloseFile() = 0; <a name="l00042"></a>00042 <span class="comment">// Flush can be called optionally after some operations to</span> <a name="l00043"></a>00043 <span class="comment">// flush the buffer to the filestream. A writer not necessarily </span> <a name="l00044"></a>00044 <span class="comment">// implements this function</span> <a name="l00045"></a><a class="code" href="a01897.html#ed1e8798cf346f09359f631785022578">00045</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Flush() {}; <a name="l00046"></a>00046 <a name="l00047"></a>00047 <span class="comment">// Description:</span> <a name="l00048"></a>00048 <span class="comment">// Starts a document and sets all necessary informations, </span> <a name="l00049"></a>00049 <span class="comment">// i.e. the header of the implemented encoding</span> <a name="l00050"></a>00050 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartDocument() = 0; <a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="comment">// Description:</span> <a name="l00053"></a>00053 <span class="comment">// Ends a document and sets all necessary informations</span> <a name="l00054"></a>00054 <span class="comment">// or necessary bytes to finish the encoding correctly</span> <a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">void</span> EndDocument() = 0; <a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="comment">// Description:</span> <a name="l00058"></a>00058 <span class="comment">// Starts/ends a new X3D node specified via nodeID. The list of</span> <a name="l00059"></a>00059 <span class="comment">// nodeIds can be found in vtkX3DExportWriterSymbols.h. The EndNode</span> <a name="l00060"></a>00060 <span class="comment">// function closes the last open node. So there must be</span> <a name="l00061"></a>00061 <span class="comment">// corresponding Start/EndNode() calls for every node</span> <a name="l00062"></a>00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartNode(<span class="keywordtype">int</span> nodeID) = 0; <a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> EndNode() = 0; <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="comment">// Description:</span> <a name="l00066"></a>00066 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00067"></a>00067 <span class="comment">// of the active node to the given value.</span> <a name="l00068"></a>00068 <span class="comment">// The type of the field is SFString and MFString</span> <a name="l00069"></a>00069 <span class="comment">//virtual void SetField(int attributeID, const vtkstd::string &value) = 0;</span> <a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>, <span class="keywordtype">bool</span> mfstring = <span class="keyword">false</span>) = 0; <a name="l00071"></a>00071 <a name="l00072"></a>00072 <span class="comment">// Description:</span> <a name="l00073"></a>00073 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00074"></a>00074 <span class="comment">// of the active node to the given value.</span> <a name="l00075"></a>00075 <span class="comment">// The type of the field is SFInt32 </span> <a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">int</span>) = 0; <a name="l00077"></a>00077 <a name="l00078"></a>00078 <span class="comment">// Description:</span> <a name="l00079"></a>00079 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00080"></a>00080 <span class="comment">// of the active node to the given value.</span> <a name="l00081"></a>00081 <span class="comment">// The type of the field is SFFloat</span> <a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">float</span>) = 0; <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="comment">// Description:</span> <a name="l00085"></a>00085 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00086"></a>00086 <span class="comment">// of the active node to the given value.</span> <a name="l00087"></a>00087 <span class="comment">// The type of the field is SFDouble </span> <a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">double</span>) = 0; <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="comment">// Description:</span> <a name="l00091"></a>00091 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00092"></a>00092 <span class="comment">// of the active node to the given value.</span> <a name="l00093"></a>00093 <span class="comment">// The type of the field is SFBool </span> <a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">bool</span>) = 0; <a name="l00095"></a>00095 <a name="l00096"></a>00096 <span class="comment">// Description:</span> <a name="l00097"></a>00097 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00098"></a>00098 <span class="comment">// of the active node to the given value.</span> <a name="l00099"></a>00099 <span class="comment">// The type of the field is specified with type</span> <a name="l00100"></a>00100 <span class="comment">// Supported types: SFVEC3F, SFCOLOR, SFROTATION</span> <a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2108e7f81709ed57920a45c02a954726847">type</a>, <span class="keyword">const</span> <span class="keywordtype">double</span>* a) = 0; <a name="l00102"></a>00102 <a name="l00103"></a>00103 <span class="comment">// Description:</span> <a name="l00104"></a>00104 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00105"></a>00105 <span class="comment">// of the active node to the given value.</span> <a name="l00106"></a>00106 <span class="comment">// The type of the field is specified with type</span> <a name="l00107"></a>00107 <span class="comment">// Supported types: MFVEC3F, MFVEC2F</span> <a name="l00108"></a>00108 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2108e7f81709ed57920a45c02a954726847">type</a>, <a class="code" href="a00356.html" title="abstract superclass for arrays of numeric data">vtkDataArray</a>* a) = 0; <a name="l00109"></a>00109 <a name="l00110"></a>00110 <span class="comment">// Description:</span> <a name="l00111"></a>00111 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00112"></a>00112 <span class="comment">// of the active node to the given value.</span> <a name="l00113"></a>00113 <span class="comment">// The type of the field is specified with type</span> <a name="l00114"></a>00114 <span class="comment">// Supported types: MFCOLOR</span> <a name="l00115"></a>00115 <span class="comment">//virtual void SetField(int attributeID, int type, const vtkstd::vector<double> &values) = 0;</span> <a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keyword">const</span> <span class="keywordtype">double</span>* values, <span class="keywordtype">size_t</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e3d5e7c015dff08d8daf72a0102e1444">size</a>) = 0; <a name="l00117"></a>00117 <a name="l00118"></a>00118 <span class="comment">// Description:</span> <a name="l00119"></a>00119 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00120"></a>00120 <span class="comment">// of the active node to the given value.</span> <a name="l00121"></a>00121 <span class="comment">// The type of the field is specified with type</span> <a name="l00122"></a>00122 <span class="comment">// It is possible to specify that the field is an</span> <a name="l00123"></a>00123 <span class="comment">// image for optimized formating or compression</span> <a name="l00124"></a>00124 <span class="comment">// Supported types: MFINT32, SFIMAGE</span> <a name="l00125"></a>00125 <span class="comment">//virtual void SetField(int attributeID, const vtkstd::vector<int> &values, bool image = false) = 0;</span> <a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetField(<span class="keywordtype">int</span> attributeID, <span class="keyword">const</span> <span class="keywordtype">int</span>* values, <span class="keywordtype">size_t</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e3d5e7c015dff08d8daf72a0102e1444">size</a>, <span class="keywordtype">bool</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210cf2918d8c9015394a60a23572e257359">image</a> = <span class="keyword">false</span>) = 0; <a name="l00127"></a>00127 <a name="l00128"></a>00128 <span class="comment">// Description:</span> <a name="l00129"></a>00129 <span class="comment">// Sets the field specified with attributeID</span> <a name="l00130"></a>00130 <span class="comment">// of the active node to the given value.</span> <a name="l00131"></a>00131 <span class="comment">// The type of the field is specified with type</span> <a name="l00132"></a>00132 <span class="comment">// Supported types: MFString</span> <a name="l00133"></a>00133 <span class="comment">//virtual void SetField(int attributeID, int type, vtkstd::string) = 0;</span> <a name="l00134"></a>00134 <span class="keyword">protected</span>: <a name="l00135"></a>00135 <a class="code" href="a01897.html">vtkX3DExporterWriter</a>(); <a name="l00136"></a>00136 ~<a class="code" href="a01897.html">vtkX3DExporterWriter</a>(); <a name="l00137"></a>00137 <a name="l00138"></a>00138 <span class="keyword">private</span>: <a name="l00139"></a>00139 <a class="code" href="a01897.html">vtkX3DExporterWriter</a>(<span class="keyword">const</span> <a class="code" href="a01897.html">vtkX3DExporterWriter</a>&); <span class="comment">// Not implemented.</span> <a name="l00140"></a>00140 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01897.html">vtkX3DExporterWriter</a>&); <span class="comment">// Not implemented.</span> <a name="l00141"></a>00141 }; <a name="l00142"></a>00142 <span class="preprocessor">#endif</span> <a name="l00143"></a>00143 <span class="preprocessor"></span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:33 2009 for VTK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>