vtk
Class vtkDataWriter

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkProcessObject
              extended byvtk.vtkWriter
                  extended byvtk.vtkDataWriter
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
vtkDataSetWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter

public class vtkDataWriter
extends vtkWriter
implements java.io.Serializable

vtkDataWriter - helper class for objects that write vtk data files. vtkDataWriter is a helper class that opens and writes the vtk header and point data (e.g., scalars, vectors, normals, etc.) from a vtk data file. See text for various formats. JavaBean wrapper for vtkDataWriter object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
vtkDataSetWriter, vtkPolyDataWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkFieldDataWriter, Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkDataWriter()
           
protected vtkDataWriter(int dmy)
           
 
Method Summary
 java.lang.String getClassName()
          Return the class name as a string.
 java.lang.String getFieldDataName()
          Give a name to the field data.
 java.lang.String getFileName()
          Specify file name of vtk polygon data file to write.
 int getFileType()
          Specify file type (ASCII or BINARY) for vtk data file.
 int getFileTypeMaxValue()
          Specify file type (ASCII or BINARY) for vtk data file.
 int getFileTypeMinValue()
          Specify file type (ASCII or BINARY) for vtk data file.
 java.lang.String getHeader()
          Specify the header for the vtk data file.
 java.lang.String getLookupTableName()
          Give a name to the lookup table.
 java.lang.String getNormalsName()
          Give a name to the normals data.
 java.lang.String getOutputString()
          When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.
 int getOutputStringLength()
          When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.
 java.lang.String getScalarsName()
          Give a name to the scalar data.
 java.lang.String getTCoordsName()
          Give a name to the texture coordinates data.
 java.lang.String getTensorsName()
          Give a name to the tensors data.
 vtkDataWriter getThisDataWriter()
           
 java.lang.String getVectorsName()
          Give a name to the vector data.
 int getWriteToOutputString()
          Enable writing to an OutputString instead of the default, a file.
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 java.lang.String registerAndGetOutputString()
          This convenience method returns the string, sets the IVAR to NULL, so that the user is responsible for deleting the string.
 void setFieldDataName(java.lang.String id0)
          Give a name to the field data.
 void setFileName(java.lang.String id0)
          Specify file name of vtk polygon data file to write.
 void setFileType(int id0)
          Specify file type (ASCII or BINARY) for vtk data file.
 void setFileTypeToASCII()
          Specify file type (ASCII or BINARY) for vtk data file.
 void setFileTypeToBinary()
          Specify file type (ASCII or BINARY) for vtk data file.
 void setHeader(java.lang.String id0)
          Specify the header for the vtk data file.
 void setLookupTableName(java.lang.String id0)
          Give a name to the lookup table.
 void setNormalsName(java.lang.String id0)
          Give a name to the normals data.
 void setScalarsName(java.lang.String id0)
          Give a name to the scalar data.
 void setTCoordsName(java.lang.String id0)
          Give a name to the texture coordinates data.
 void setTensorsName(java.lang.String id0)
          Give a name to the tensors data.
 void setVectorsName(java.lang.String id0)
          Give a name to the vector data.
 void setWriteToOutputString(int id0)
          Enable writing to an OutputString instead of the default, a file.
protected  void VTKCastInit()
           
 void VTKInit()
           
 void writeToOutputStringOff()
          Enable writing to an OutputString instead of the default, a file.
 void writeToOutputStringOn()
          Enable writing to an OutputString instead of the default, a file.
 
Methods inherited from class vtk.vtkWriter
encodeArrayName, getThisWriter, update, write
 
Methods inherited from class vtk.vtkProcessObject
abortExecuteOff, abortExecuteOn, getAbortExecute, getErrorCode, getNumberOfInputs, getProgress, getProgressMaxValue, getProgressMinValue, getProgressText, getThisProcessObject, removeAllInputs, setAbortExecute, setProgress, setProgressText, squeezeInputArray, updateProgress
 
Methods inherited from class vtk.vtkObject
AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister
 
Methods inherited from class vtk.vtkObjectBase
addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

changes

protected java.beans.PropertyChangeSupport changes
Constructor Detail

vtkDataWriter

public vtkDataWriter()

vtkDataWriter

protected vtkDataWriter(int dmy)
Method Detail

getThisDataWriter

public vtkDataWriter getThisDataWriter()

getClassName

public java.lang.String getClassName()
Description copied from class: vtkObjectBase
Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
getClassName in class vtkWriter

isA

public int isA(java.lang.String id0)
Description copied from class: vtkObjectBase
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
isA in class vtkWriter

setFileName

public void setFileName(java.lang.String id0)
Specify file name of vtk polygon data file to write.


getFileName

public java.lang.String getFileName()
Specify file name of vtk polygon data file to write.


setWriteToOutputString

public void setWriteToOutputString(int id0)
Enable writing to an OutputString instead of the default, a file.


getWriteToOutputString

public int getWriteToOutputString()
Enable writing to an OutputString instead of the default, a file.


writeToOutputStringOn

public void writeToOutputStringOn()
Enable writing to an OutputString instead of the default, a file.


writeToOutputStringOff

public void writeToOutputStringOff()
Enable writing to an OutputString instead of the default, a file.


getOutputStringLength

public int getOutputStringLength()
When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. The string is deleted during the next call to write ...


getOutputString

public java.lang.String getOutputString()
When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. The string is deleted during the next call to write ...


registerAndGetOutputString

public java.lang.String registerAndGetOutputString()
This convenience method returns the string, sets the IVAR to NULL, so that the user is responsible for deleting the string. I am not sure what the name should be, so it may change in the future.


setHeader

public void setHeader(java.lang.String id0)
Specify the header for the vtk data file.


getHeader

public java.lang.String getHeader()
Specify the header for the vtk data file.


setFileType

public void setFileType(int id0)
Specify file type (ASCII or BINARY) for vtk data file.


getFileTypeMinValue

public int getFileTypeMinValue()
Specify file type (ASCII or BINARY) for vtk data file.


getFileTypeMaxValue

public int getFileTypeMaxValue()
Specify file type (ASCII or BINARY) for vtk data file.


getFileType

public int getFileType()
Specify file type (ASCII or BINARY) for vtk data file.


setFileTypeToASCII

public void setFileTypeToASCII()
Specify file type (ASCII or BINARY) for vtk data file.


setFileTypeToBinary

public void setFileTypeToBinary()
Specify file type (ASCII or BINARY) for vtk data file.


setScalarsName

public void setScalarsName(java.lang.String id0)
Give a name to the scalar data. If not specified, uses default name "scalars".


getScalarsName

public java.lang.String getScalarsName()
Give a name to the scalar data. If not specified, uses default name "scalars".


setVectorsName

public void setVectorsName(java.lang.String id0)
Give a name to the vector data. If not specified, uses default name "vectors".


getVectorsName

public java.lang.String getVectorsName()
Give a name to the vector data. If not specified, uses default name "vectors".


setTensorsName

public void setTensorsName(java.lang.String id0)
Give a name to the tensors data. If not specified, uses default name "tensors".


getTensorsName

public java.lang.String getTensorsName()
Give a name to the tensors data. If not specified, uses default name "tensors".


setNormalsName

public void setNormalsName(java.lang.String id0)
Give a name to the normals data. If not specified, uses default name "normals".


getNormalsName

public java.lang.String getNormalsName()
Give a name to the normals data. If not specified, uses default name "normals".


setTCoordsName

public void setTCoordsName(java.lang.String id0)
Give a name to the texture coordinates data. If not specified, uses default name "textureCoords".


getTCoordsName

public java.lang.String getTCoordsName()
Give a name to the texture coordinates data. If not specified, uses default name "textureCoords".


setLookupTableName

public void setLookupTableName(java.lang.String id0)
Give a name to the lookup table. If not specified, uses default name "lookupTable".


getLookupTableName

public java.lang.String getLookupTableName()
Give a name to the lookup table. If not specified, uses default name "lookupTable".


setFieldDataName

public void setFieldDataName(java.lang.String id0)
Give a name to the field data. If not specified, uses default name "field".


getFieldDataName

public java.lang.String getFieldDataName()
Give a name to the field data. If not specified, uses default name "field".


VTKInit

public void VTKInit()
Overrides:
VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()
Overrides:
VTKCastInit in class vtkWriter


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.