#include <vtkDataReader.h>
Inheritance diagram for vtkDataReader:
vtkDataReader is a helper superclass that reads the vtk data file header, dataset type, and attribute data (point and cell attributes such as scalars, vectors, normals, etc.) from a vtk data file. See text for the format of the various vtk file types.
Definition at line 46 of file vtkDataReader.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
Definition at line 50 of file vtkDataReader.h.
| vtkDataReader::vtkDataReader | ( | ) | [protected] |
Internal function to read in a value. Returns zero if there was an error.
| vtkDataReader::~vtkDataReader | ( | ) | [protected] |
Internal function to read in a value. Returns zero if there was an error.
| static vtkDataReader* vtkDataReader::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| virtual const char* vtkDataReader::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| static int vtkDataReader::IsTypeOf | ( | const char * | type | ) | [static] |
Return 1 if this class type 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.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| virtual int vtkDataReader::IsA | ( | const char * | type | ) | [virtual] |
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.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| static vtkDataReader* vtkDataReader::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| void vtkDataReader::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDataObjectReader, vtkDataSetReader, vtkGenericDataObjectReader, vtkGraphReader, vtkPolyDataReader, vtkRectilinearGridReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkTableReader, vtkTreeReader, and vtkUnstructuredGridReader.
| virtual void vtkDataReader::SetFileName | ( | const char * | ) | [virtual] |
Specify file name of vtk data file to read.
| virtual char* vtkDataReader::GetFileName | ( | ) | [virtual] |
Specify file name of vtk data file to read.
| int vtkDataReader::IsFileValid | ( | const char * | dstype | ) |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
| int vtkDataReader::IsFileStructuredPoints | ( | ) | [inline] |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
Definition at line 63 of file vtkDataReader.h.
| int vtkDataReader::IsFilePolyData | ( | ) | [inline] |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
Definition at line 65 of file vtkDataReader.h.
| int vtkDataReader::IsFileStructuredGrid | ( | ) | [inline] |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
Definition at line 67 of file vtkDataReader.h.
| int vtkDataReader::IsFileUnstructuredGrid | ( | ) | [inline] |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
Definition at line 69 of file vtkDataReader.h.
| int vtkDataReader::IsFileRectilinearGrid | ( | ) | [inline] |
Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.
Definition at line 71 of file vtkDataReader.h.
| void vtkDataReader::SetInputString | ( | const char * | in | ) |
Specify the InputString for use when reading from a character array. Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.
| virtual char* vtkDataReader::GetInputString | ( | ) | [virtual] |
Specify the InputString for use when reading from a character array. Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.
| void vtkDataReader::SetInputString | ( | const char * | in, | |
| int | len | |||
| ) |
Specify the InputString for use when reading from a character array. Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.
| virtual int vtkDataReader::GetInputStringLength | ( | ) | [virtual] |
Specify the InputString for use when reading from a character array. Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.
| void vtkDataReader::SetBinaryInputString | ( | const char * | , | |
| int | len | |||
| ) |
Specify the InputString for use when reading from a character array. Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.
| virtual void vtkDataReader::SetInputArray | ( | vtkCharArray * | ) | [virtual] |
Specify the vtkCharArray to be used when reading from a string. If set, this array has precendence over InputString. Use this instead of InputString to avoid the extra memory copy. It should be noted that if the underlying char* is owned by the user ( vtkCharArray::SetArray(array, 1); ) and is deleted before the reader, bad things will happen during a pipeline update.
| virtual vtkCharArray* vtkDataReader::GetInputArray | ( | ) | [virtual] |
Specify the vtkCharArray to be used when reading from a string. If set, this array has precendence over InputString. Use this instead of InputString to avoid the extra memory copy. It should be noted that if the underlying char* is owned by the user ( vtkCharArray::SetArray(array, 1); ) and is deleted before the reader, bad things will happen during a pipeline update.
| virtual char* vtkDataReader::GetHeader | ( | ) | [virtual] |
Get the header from the vtk data file.
| virtual void vtkDataReader::SetReadFromInputString | ( | int | ) | [virtual] |
Enable reading from an InputString or InputArray instead of the default, a file.
| virtual int vtkDataReader::GetReadFromInputString | ( | ) | [virtual] |
Enable reading from an InputString or InputArray instead of the default, a file.
| virtual void vtkDataReader::ReadFromInputStringOn | ( | ) | [virtual] |
Enable reading from an InputString or InputArray instead of the default, a file.
| virtual void vtkDataReader::ReadFromInputStringOff | ( | ) | [virtual] |
Enable reading from an InputString or InputArray instead of the default, a file.
| virtual int vtkDataReader::GetFileType | ( | ) | [virtual] |
Get the type of file (ASCII or BINARY). Returned value only valid after file has been read.
| int vtkDataReader::GetNumberOfScalarsInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 122 of file vtkDataReader.h.
| int vtkDataReader::GetNumberOfVectorsInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 124 of file vtkDataReader.h.
| int vtkDataReader::GetNumberOfTensorsInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 126 of file vtkDataReader.h.
| int vtkDataReader::GetNumberOfNormalsInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 128 of file vtkDataReader.h.
| int vtkDataReader::GetNumberOfTCoordsInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 130 of file vtkDataReader.h.
| int vtkDataReader::GetNumberOfFieldDataInFile | ( | ) | [inline] |
How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. (Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)
Definition at line 132 of file vtkDataReader.h.
| const char* vtkDataReader::GetScalarsNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| const char* vtkDataReader::GetVectorsNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| const char* vtkDataReader::GetTensorsNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| const char* vtkDataReader::GetNormalsNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| const char* vtkDataReader::GetTCoordsNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| const char* vtkDataReader::GetFieldDataNameInFile | ( | int | i | ) |
What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.
| virtual void vtkDataReader::SetScalarsName | ( | const char * | ) | [virtual] |
Set the name of the scalar data to extract. If not specified, first scalar data encountered is extracted.
| virtual char* vtkDataReader::GetScalarsName | ( | ) | [virtual] |
Set the name of the scalar data to extract. If not specified, first scalar data encountered is extracted.
| virtual void vtkDataReader::SetVectorsName | ( | const char * | ) | [virtual] |
Set the name of the vector data to extract. If not specified, first vector data encountered is extracted.
| virtual char* vtkDataReader::GetVectorsName | ( | ) | [virtual] |
Set the name of the vector data to extract. If not specified, first vector data encountered is extracted.
| virtual void vtkDataReader::SetTensorsName | ( | const char * | ) | [virtual] |
Set the name of the tensor data to extract. If not specified, first tensor data encountered is extracted.
| virtual char* vtkDataReader::GetTensorsName | ( | ) | [virtual] |
Set the name of the tensor data to extract. If not specified, first tensor data encountered is extracted.
| virtual void vtkDataReader::SetNormalsName | ( | const char * | ) | [virtual] |
Set the name of the normal data to extract. If not specified, first normal data encountered is extracted.
| virtual char* vtkDataReader::GetNormalsName | ( | ) | [virtual] |
Set the name of the normal data to extract. If not specified, first normal data encountered is extracted.
| virtual void vtkDataReader::SetTCoordsName | ( | const char * | ) | [virtual] |
Set the name of the texture coordinate data to extract. If not specified, first texture coordinate data encountered is extracted.
| virtual char* vtkDataReader::GetTCoordsName | ( | ) | [virtual] |
Set the name of the texture coordinate data to extract. If not specified, first texture coordinate data encountered is extracted.
| virtual void vtkDataReader::SetLookupTableName | ( | const char * | ) | [virtual] |
Set the name of the lookup table data to extract. If not specified, uses lookup table named by scalar. Otherwise, this specification supersedes.
| virtual char* vtkDataReader::GetLookupTableName | ( | ) | [virtual] |
Set the name of the lookup table data to extract. If not specified, uses lookup table named by scalar. Otherwise, this specification supersedes.
| virtual void vtkDataReader::SetFieldDataName | ( | const char * | ) | [virtual] |
Set the name of the field data to extract. If not specified, uses first field data encountered in file.
| virtual char* vtkDataReader::GetFieldDataName | ( | ) | [virtual] |
Set the name of the field data to extract. If not specified, uses first field data encountered in file.
| virtual void vtkDataReader::SetReadAllScalars | ( | int | ) | [virtual] |
Enable reading all scalars.
| virtual int vtkDataReader::GetReadAllScalars | ( | ) | [virtual] |
Enable reading all scalars.
| virtual void vtkDataReader::ReadAllScalarsOn | ( | ) | [virtual] |
Enable reading all scalars.
| virtual void vtkDataReader::ReadAllScalarsOff | ( | ) | [virtual] |
Enable reading all scalars.
| virtual void vtkDataReader::SetReadAllVectors | ( | int | ) | [virtual] |
Enable reading all vectors.
| virtual int vtkDataReader::GetReadAllVectors | ( | ) | [virtual] |
Enable reading all vectors.
| virtual void vtkDataReader::ReadAllVectorsOn | ( | ) | [virtual] |
Enable reading all vectors.
| virtual void vtkDataReader::ReadAllVectorsOff | ( | ) | [virtual] |
Enable reading all vectors.
| virtual void vtkDataReader::SetReadAllNormals | ( | int | ) | [virtual] |
Enable reading all normals.
| virtual int vtkDataReader::GetReadAllNormals | ( | ) | [virtual] |
Enable reading all normals.
| virtual void vtkDataReader::ReadAllNormalsOn | ( | ) | [virtual] |
Enable reading all normals.
| virtual void vtkDataReader::ReadAllNormalsOff | ( | ) | [virtual] |
Enable reading all normals.
| virtual void vtkDataReader::SetReadAllTensors | ( | int | ) | [virtual] |
Enable reading all tensors.
| virtual int vtkDataReader::GetReadAllTensors | ( | ) | [virtual] |
Enable reading all tensors.
| virtual void vtkDataReader::ReadAllTensorsOn | ( | ) | [virtual] |
Enable reading all tensors.
| virtual void vtkDataReader::ReadAllTensorsOff | ( | ) | [virtual] |
Enable reading all tensors.
| virtual void vtkDataReader::SetReadAllColorScalars | ( | int | ) | [virtual] |
Enable reading all color scalars.
| virtual int vtkDataReader::GetReadAllColorScalars | ( | ) | [virtual] |
Enable reading all color scalars.
| virtual void vtkDataReader::ReadAllColorScalarsOn | ( | ) | [virtual] |
Enable reading all color scalars.
| virtual void vtkDataReader::ReadAllColorScalarsOff | ( | ) | [virtual] |
Enable reading all color scalars.
| virtual void vtkDataReader::SetReadAllTCoords | ( | int | ) | [virtual] |
Enable reading all tcoords.
| virtual int vtkDataReader::GetReadAllTCoords | ( | ) | [virtual] |
Enable reading all tcoords.
| virtual void vtkDataReader::ReadAllTCoordsOn | ( | ) | [virtual] |
Enable reading all tcoords.
| virtual void vtkDataReader::ReadAllTCoordsOff | ( | ) | [virtual] |
Enable reading all tcoords.
| virtual void vtkDataReader::SetReadAllFields | ( | int | ) | [virtual] |
Enable reading all fields.
| virtual int vtkDataReader::GetReadAllFields | ( | ) | [virtual] |
Enable reading all fields.
| virtual void vtkDataReader::ReadAllFieldsOn | ( | ) | [virtual] |
Enable reading all fields.
| virtual void vtkDataReader::ReadAllFieldsOff | ( | ) | [virtual] |
Enable reading all fields.
| int vtkDataReader::OpenVTKFile | ( | ) |
Open a vtk data file. Returns zero if error.
| int vtkDataReader::ReadHeader | ( | ) |
Read the header of a vtk data file. Returns 0 if error.
| int vtkDataReader::ReadCellData | ( | vtkDataSet * | ds, | |
| int | numCells | |||
| ) |
Read the cell data of a vtk data file. The number of cells (from the dataset) must match the number of cells defined in cell attributes (unless no geometry was defined).
| int vtkDataReader::ReadPointData | ( | vtkDataSet * | ds, | |
| int | numPts | |||
| ) |
Read the point data of a vtk data file. The number of points (from the dataset) must match the number of points defined in point attributes (unless no geometry was defined).
| int vtkDataReader::ReadPoints | ( | vtkPointSet * | ps, | |
| int | numPts | |||
| ) |
Read point coordinates. Return 0 if error.
| int vtkDataReader::ReadPoints | ( | vtkGraph * | g, | |
| int | numPts | |||
| ) |
Read point coordinates. Return 0 if error.
| int vtkDataReader::ReadVertexData | ( | vtkGraph * | g, | |
| int | numVertices | |||
| ) |
Read the vertex data of a vtk data file. The number of vertices (from the graph) must match the number of vertices defined in vertex attributes (unless no geometry was defined).
| int vtkDataReader::ReadEdgeData | ( |