VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPLYWriter Class Reference

write Stanford PLY file format More...

#include <vtkPLYWriter.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetDataByteOrder (int)
 
virtual int GetDataByteOrder ()
 
void SetDataByteOrderToBigEndian ()
 
void SetDataByteOrderToLittleEndian ()
 
virtual void SetColorMode (int)
 
virtual int GetColorMode ()
 
void SetColorModeToDefault ()
 
void SetColorModeToUniformCellColor ()
 
void SetColorModeToUniformPointColor ()
 
void SetColorModeToUniformColor ()
 
void SetColorModeToOff ()
 
virtual void SetArrayName (const char *)
 
virtual char * GetArrayName ()
 
virtual void SetComponent (int)
 
virtual int GetComponent ()
 
virtual void SetLookupTable (vtkScalarsToColors *)
 
virtual vtkScalarsToColorsGetLookupTable ()
 
virtual void SetColor (unsigned char, unsigned char, unsigned char)
 
virtual void SetColor (unsigned char[3])
 
virtual unsigned char * GetColor ()
 
virtual void GetColor (unsigned char &, unsigned char &, unsigned char &)
 
virtual void GetColor (unsigned char[3])
 
- Public Member Functions inherited from vtkPolyDataWriter
void PrintSelf (ostream &os, vtkIndent indent)
 
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
void PrintSelf (ostream &os, vtkIndent indent)
 
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)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
- 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 vtkPLYWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPLYWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPolyDataWriter
static vtkPolyDataWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkDataWriter
static int IsTypeOf (const char *type)
 
static vtkDataWriterSafeDownCast (vtkObject *o)
 
static vtkDataWriterNew ()
 
- Static Public Member Functions inherited from vtkWriter
static int IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPLYWriter ()
 
 ~vtkPLYWriter ()
 
void WriteData ()
 
unsigned char * GetColors (vtkIdType num, vtkDataSetAttributes *dsa)
 
- Protected Member Functions inherited from vtkPolyDataWriter
 vtkPolyDataWriter ()
 
 ~vtkPolyDataWriter ()
 
void WriteData ()
 
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

int DataByteOrder
 
char * ArrayName
 
int Component
 
int ColorMode
 
vtkScalarsToColorsLookupTable
 
unsigned char Color [3]
 
- Protected Attributes inherited from vtkDataWriter
int WriteToOutputString
 
char * OutputString
 
int OutputStringLength
 
char * FileName
 
char * Header
 
int FileType
 
char * ScalarsName
 
char * VectorsName
 
char * TensorsName
 
char * TCoordsName
 
char * NormalsName
 
char * LookupTableName
 
char * FieldDataName
 
char * GlobalIdsName
 
char * PedigreeIdsName
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

write Stanford PLY file format

vtkPLYWriter writes polygonal data in Stanford University PLY format (see http://graphics.stanford.edu/data/3Dscanrep/). The data can be written in either binary (little or big endian) or ASCII representation. As for PointData and CellData, vtkPLYWriter cannot handle normals or vectors. It only handles RGB PointData and CellData. You need to set the name of the array (using SetName for the array and SetArrayName for the writer). If the array is not a vtkUnsignedCharArray with 3 components, you need to specify a vtkLookupTable to map the scalars to RGB.

Warning
PLY does not handle big endian versus little endian correctly.
See also
vtkPLYReader
Tests:
vtkPLYWriter (Tests)

Definition at line 55 of file vtkPLYWriter.h.

Member Typedef Documentation

Definition at line 59 of file vtkPLYWriter.h.

Constructor & Destructor Documentation

vtkPLYWriter::vtkPLYWriter ( )
protected
vtkPLYWriter::~vtkPLYWriter ( )
protected

Member Function Documentation

static vtkPLYWriter* vtkPLYWriter::New ( )
static
virtual const char* vtkPLYWriter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataWriter.

static int vtkPLYWriter::IsTypeOf ( const char *  type)
static
virtual int vtkPLYWriter::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 vtkPLYWriter* vtkPLYWriter::SafeDownCast ( vtkObject o)
static
void vtkPLYWriter::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 vtkDataWriter.

virtual void vtkPLYWriter::SetDataByteOrder ( int  )
virtual

If the file type is binary, then the user can specify which byte order to use (little versus big endian).

virtual int vtkPLYWriter::GetDataByteOrder ( )
virtual

If the file type is binary, then the user can specify which byte order to use (little versus big endian).

void vtkPLYWriter::SetDataByteOrderToBigEndian ( )
inline

If the file type is binary, then the user can specify which byte order to use (little versus big endian).

Definition at line 67 of file vtkPLYWriter.h.

void vtkPLYWriter::SetDataByteOrderToLittleEndian ( )
inline

If the file type is binary, then the user can specify which byte order to use (little versus big endian).

Definition at line 69 of file vtkPLYWriter.h.

virtual void vtkPLYWriter::SetColorMode ( int  )
virtual

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

virtual int vtkPLYWriter::GetColorMode ( )
virtual

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

void vtkPLYWriter::SetColorModeToDefault ( )
inline

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

Definition at line 89 of file vtkPLYWriter.h.

void vtkPLYWriter::SetColorModeToUniformCellColor ( )
inline

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

Definition at line 91 of file vtkPLYWriter.h.

void vtkPLYWriter::SetColorModeToUniformPointColor ( )
inline

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

Definition at line 93 of file vtkPLYWriter.h.

void vtkPLYWriter::SetColorModeToUniformColor ( )
inline

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

Definition at line 95 of file vtkPLYWriter.h.

void vtkPLYWriter::SetColorModeToOff ( )
inline

These methods enable the user to control how to add color into the PLY output file. The default behavior is as follows. The user provides the name of an array and a component number. If the type of the array is three components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties. If the type is not unsigned char, and a lookup table is provided, then the array/component are mapped through the table to generate three separate "red", "green" and "blue" properties in the PLY file. The user can also set the ColorMode to specify a uniform color for the whole part (on a vertex colors, face colors, or both. (Note: vertex colors or cell colors may be written, depending on where the named array is found. If points and cells have the arrays with the same name, then both colors will be written.)

Definition at line 97 of file vtkPLYWriter.h.

virtual void vtkPLYWriter::SetArrayName ( const char *  )
virtual

Specify the array name to use to color the data.

virtual char* vtkPLYWriter::GetArrayName ( )
virtual

Specify the array name to use to color the data.

virtual void vtkPLYWriter::SetComponent ( int  )
virtual

Specify the array component to use to color the data.

virtual int vtkPLYWriter::GetComponent ( )
virtual

Specify the array component to use to color the data.

virtual void vtkPLYWriter::SetLookupTable ( vtkScalarsToColors )
virtual

A lookup table can be specified in order to convert data arrays to RGBA colors.

virtual vtkScalarsToColors* vtkPLYWriter::GetLookupTable ( )
virtual

A lookup table can be specified in order to convert data arrays to RGBA colors.

virtual void vtkPLYWriter::SetColor ( unsigned  char,
unsigned  char,
unsigned  char 
)
virtual

Set the color to use when using a uniform color (either point or cells, or both). The color is specified as a triplet of three unsigned chars between (0,255). This only takes effect when the ColorMode is set to uniform point, uniform cell, or uniform color.

virtual void vtkPLYWriter::SetColor ( unsigned  char[3])
virtual

Set the color to use when using a uniform color (either point or cells, or both). The color is specified as a triplet of three unsigned chars between (0,255). This only takes effect when the ColorMode is set to uniform point, uniform cell, or uniform color.

virtual unsigned char* vtkPLYWriter::GetColor ( )
virtual

Set the color to use when using a uniform color (either point or cells, or both). The color is specified as a triplet of three unsigned chars between (0,255). This only takes effect when the ColorMode is set to uniform point, uniform cell, or uniform color.

virtual void vtkPLYWriter::GetColor ( unsigned char &  ,
unsigned char &  ,
unsigned char &   
)
virtual

Set the color to use when using a uniform color (either point or cells, or both). The color is specified as a triplet of three unsigned chars between (0,255). This only takes effect when the ColorMode is set to uniform point, uniform cell, or uniform color.

virtual void vtkPLYWriter::GetColor ( unsigned  char[3])
virtual

Set the color to use when using a uniform color (either point or cells, or both). The color is specified as a triplet of three unsigned chars between (0,255). This only takes effect when the ColorMode is set to uniform point, uniform cell, or uniform color.

void vtkPLYWriter::WriteData ( )
protectedvirtual

Reimplemented from vtkDataWriter.

unsigned char* vtkPLYWriter::GetColors ( vtkIdType  num,
vtkDataSetAttributes dsa 
)
protected

Member Data Documentation

int vtkPLYWriter::DataByteOrder
protected

Definition at line 136 of file vtkPLYWriter.h.

char* vtkPLYWriter::ArrayName
protected

Definition at line 137 of file vtkPLYWriter.h.

int vtkPLYWriter::Component
protected

Definition at line 138 of file vtkPLYWriter.h.

int vtkPLYWriter::ColorMode
protected

Definition at line 139 of file vtkPLYWriter.h.

vtkScalarsToColors* vtkPLYWriter::LookupTable
protected

Definition at line 140 of file vtkPLYWriter.h.

unsigned char vtkPLYWriter::Color[3]
protected

Definition at line 141 of file vtkPLYWriter.h.


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