VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMNIObjectWriter Class Reference

A writer for MNI surface mesh files. More...

#include <vtkMNIObjectWriter.h>

Inheritance diagram for vtkMNIObjectWriter:
[legend]
Collaboration diagram for vtkMNIObjectWriter:
[legend]

List of all members.

Public Types

typedef vtkPolyDataWriter Superclass
- Public Types inherited from vtkPolyDataWriter
- Public Types inherited from vtkDataWriter
- Public Types inherited from vtkWriter
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetFileExtensions ()
virtual const char * GetDescriptiveName ()
virtual void SetProperty (vtkProperty *property)
virtual vtkPropertyGetProperty ()
virtual void SetMapper (vtkMapper *mapper)
virtual vtkMapperGetMapper ()
virtual void SetLookupTable (vtkLookupTable *table)
virtual vtkLookupTableGetLookupTable ()
- Public Member Functions inherited from vtkPolyDataWriter
vtkPolyDataGetInput ()
vtkPolyDataGetInput (int port)
- Public Member Functions inherited from vtkDataWriter
char * RegisterAndGetOutputString ()
virtual ostream * OpenVTKFile ()
int WriteHeader (ostream *fp)
int WritePoints (ostream *fp, vtkPoints *p)
int WriteCoordinates (ostream *fp, vtkDataArray *coords, int axes)
int WriteCells (ostream *fp, vtkCellArray *cells, const char *label)
int WriteCellData (ostream *fp, vtkDataSet *ds)
int WritePointData (ostream *fp, vtkDataSet *ds)
int WriteEdgeData (ostream *fp, vtkGraph *g)
int WriteVertexData (ostream *fp, vtkGraph *g)
int WriteRowData (ostream *fp, vtkTable *g)
int WriteFieldData (ostream *fp, vtkFieldData *f)
int WriteDataSetData (ostream *fp, vtkDataSet *ds)
void CloseVTKFile (ostream *fp)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetWriteToOutputString (int)
virtual int GetWriteToOutputString ()
virtual void WriteToOutputStringOn ()
virtual void WriteToOutputStringOff ()
virtual int GetOutputStringLength ()
virtual char * GetOutputString ()
unsigned char * GetBinaryOutputString ()
virtual void SetHeader (const char *)
virtual char * GetHeader ()
virtual void SetFileType (int)
virtual int GetFileType ()
void SetFileTypeToASCII ()
void SetFileTypeToBinary ()
virtual void SetScalarsName (const char *)
virtual char * GetScalarsName ()
virtual void SetVectorsName (const char *)
virtual char * GetVectorsName ()
virtual void SetTensorsName (const char *)
virtual char * GetTensorsName ()
virtual void SetNormalsName (const char *)
virtual char * GetNormalsName ()
virtual void SetTCoordsName (const char *)
virtual char * GetTCoordsName ()
virtual void SetGlobalIdsName (const char *)
virtual char * GetGlobalIdsName ()
virtual void SetPedigreeIdsName (const char *)
virtual char * GetPedigreeIdsName ()
virtual void SetLookupTableName (const char *)
virtual char * GetLookupTableName ()
virtual void SetFieldDataName (const char *)
virtual char * GetFieldDataName ()
- Public Member Functions inherited from vtkWriter
virtual int Write ()
void EncodeString (char *resname, const char *name, bool doublePercent)
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void SetInput (vtkDataObject *input)
void SetInput (int index, vtkDataObject *input)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMNIObjectWriterSafeDownCast (vtkObject *o)
static vtkMNIObjectWriterNew ()

Protected Member Functions

 vtkMNIObjectWriter ()
 ~vtkMNIObjectWriter ()
int WriteObjectType (int objType)
int WriteValues (vtkDataArray *array)
int WriteIdValue (vtkIdType value)
int WriteNewline ()
int WriteProperty (vtkProperty *property)
int WriteLineThickness (vtkProperty *property)
int WritePoints (vtkPolyData *polyData)
int WriteNormals (vtkPolyData *polyData)
int WriteColors (vtkProperty *property, vtkMapper *mapper, vtkPolyData *data)
int WriteCells (vtkPolyData *data, int cellType)
int WritePolygonObject (vtkPolyData *output)
int WriteLineObject (vtkPolyData *output)
void WriteData ()
- Protected Member Functions inherited from vtkPolyDataWriter
 vtkPolyDataWriter ()
 ~vtkPolyDataWriter ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkDataWriter
 vtkDataWriter ()
 ~vtkDataWriter ()
int WriteArray (ostream *fp, int dataType, vtkAbstractArray *data, const char *format, int num, int numComp)
int WriteScalarData (ostream *fp, vtkDataArray *s, int num)
int WriteVectorData (ostream *fp, vtkDataArray *v, int num)
int WriteNormalData (ostream *fp, vtkDataArray *n, int num)
int WriteTCoordData (ostream *fp, vtkDataArray *tc, int num)
int WriteTensorData (ostream *fp, vtkDataArray *t, int num)
int WriteGlobalIdData (ostream *fp, vtkDataArray *g, int num)
int WritePedigreeIdData (ostream *fp, vtkAbstractArray *p, int num)
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 ~vtkWriter ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkPropertyProperty
vtkMapperMapper
vtkLookupTableLookupTable
ostream * OutputStream

Detailed Description

A writer for MNI surface mesh files.

The MNI .obj file format is used to store geometrical data. This file format was developed at the McConnell Brain Imaging Centre at the Montreal Neurological Institute and is used by their software. Only polygon and line files are supported by this writer. For these formats, all data elements are written including normals, colors, and surface properties. ASCII and binary file types are supported.

See also:
vtkMINCImageReader vtkMNIObjectReader vtkMNITransformReader
Thanks:
Thanks to David Gobbi for writing this class and Atamai Inc. for contributing it to VTK.
Tests:
vtkMNIObjectWriter (Tests)

Definition at line 80 of file vtkMNIObjectWriter.h.


Member Typedef Documentation

Reimplemented from vtkPolyDataWriter.

Definition at line 83 of file vtkMNIObjectWriter.h.


Constructor & Destructor Documentation

vtkMNIObjectWriter::vtkMNIObjectWriter ( )
protected
vtkMNIObjectWriter::~vtkMNIObjectWriter ( )
protected

Member Function Documentation

virtual const char* vtkMNIObjectWriter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataWriter.

static int vtkMNIObjectWriter::IsTypeOf ( const char *  name)
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataWriter.

virtual int vtkMNIObjectWriter::IsA ( const char *  name)
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataWriter.

static vtkMNIObjectWriter* vtkMNIObjectWriter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkPolyDataWriter.

static vtkMNIObjectWriter* vtkMNIObjectWriter::New ( )
static

Created object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates.

Reimplemented from vtkPolyDataWriter.

virtual void vtkMNIObjectWriter::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 vtkPolyDataWriter.

virtual const char* vtkMNIObjectWriter::GetFileExtensions ( )
inlinevirtual

Get the entension for this file format.

Definition at line 90 of file vtkMNIObjectWriter.h.

virtual const char* vtkMNIObjectWriter::GetDescriptiveName ( )
inlinevirtual

Get the name of this file format.

Definition at line 96 of file vtkMNIObjectWriter.h.

virtual void vtkMNIObjectWriter::SetProperty ( vtkProperty property)
virtual

Set the property associated with the object. Optional. This is useful for exporting an actor.

virtual vtkProperty* vtkMNIObjectWriter::GetProperty ( )
inlinevirtual

Set the property associated with the object. Optional. This is useful for exporting an actor.

Definition at line 104 of file vtkMNIObjectWriter.h.

virtual void vtkMNIObjectWriter::SetMapper ( vtkMapper mapper)
virtual

Set the mapper associated with the object. Optional. This is useful for exporting an actor with the same colors that are used to display the actor within VTK.

virtual vtkMapper* vtkMNIObjectWriter::GetMapper ( )
inlinevirtual

Set the mapper associated with the object. Optional. This is useful for exporting an actor with the same colors that are used to display the actor within VTK.

Definition at line 112 of file vtkMNIObjectWriter.h.

virtual void vtkMNIObjectWriter::SetLookupTable ( vtkLookupTable table)
virtual

Set the lookup table associated with the object. This will be used to convert scalar values to colors, if a mapper is not set.

virtual vtkLookupTable* vtkMNIObjectWriter::GetLookupTable ( )
inlinevirtual

Set the lookup table associated with the object. This will be used to convert scalar values to colors, if a mapper is not set.

Definition at line 119 of file vtkMNIObjectWriter.h.

int vtkMNIObjectWriter::WriteObjectType ( int  objType)
protected
int vtkMNIObjectWriter::WriteValues ( vtkDataArray array)
protected
int vtkMNIObjectWriter::WriteIdValue ( vtkIdType  value)
protected
int vtkMNIObjectWriter::WriteNewline ( )
protected
int vtkMNIObjectWriter::WriteProperty ( vtkProperty property)
protected
int vtkMNIObjectWriter::WriteLineThickness ( vtkProperty property)
protected
int vtkMNIObjectWriter::WritePoints ( vtkPolyData polyData)
protected
int vtkMNIObjectWriter::WriteNormals ( vtkPolyData polyData)
protected
int vtkMNIObjectWriter::WriteColors ( vtkProperty property,
vtkMapper mapper,
vtkPolyData data 
)
protected
int vtkMNIObjectWriter::WriteCells ( vtkPolyData data,
int  cellType 
)
protected
int vtkMNIObjectWriter::WritePolygonObject ( vtkPolyData output)
protected
int vtkMNIObjectWriter::WriteLineObject ( vtkPolyData output)
protected
void vtkMNIObjectWriter::WriteData ( )
protectedvirtual

Reimplemented from vtkPolyDataWriter.


Member Data Documentation

vtkProperty* vtkMNIObjectWriter::Property
protected

Definition at line 126 of file vtkMNIObjectWriter.h.

vtkMapper* vtkMNIObjectWriter::Mapper
protected

Definition at line 127 of file vtkMNIObjectWriter.h.

vtkLookupTable* vtkMNIObjectWriter::LookupTable
protected

Definition at line 128 of file vtkMNIObjectWriter.h.

ostream* vtkMNIObjectWriter::OutputStream
protected

Definition at line 130 of file vtkMNIObjectWriter.h.


The documentation for this class was generated from the following file: