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 vtkWriter Superclass
 
- Public Types inherited from vtkWriter
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPLYWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetDataByteOrder (int)
 If the file type is binary, then the user can specify which byte order to use (little versus big endian). More...
 
virtual int GetDataByteOrder ()
 
void SetDataByteOrderToBigEndian ()
 
void SetDataByteOrderToLittleEndian ()
 
virtual void SetWriteToOutputString (bool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual bool GetWriteToOutputString ()
 
virtual void WriteToOutputStringOn ()
 
virtual void WriteToOutputStringOff ()
 
const std::string & GetOutputString () const
 
virtual void SetColorMode (int)
 These methods enable the user to control how to add color into the PLY output file. More...
 
virtual int GetColorMode ()
 
void SetColorModeToDefault ()
 
void SetColorModeToUniformCellColor ()
 
void SetColorModeToUniformPointColor ()
 
void SetColorModeToUniformColor ()
 
void SetColorModeToOff ()
 
virtual void SetEnableAlpha (bool)
 Enable alpha output. More...
 
virtual bool GetEnableAlpha ()
 
virtual void EnableAlphaOn ()
 
virtual void EnableAlphaOff ()
 
virtual void SetArrayName (const char *)
 Specify the array name to use to color the data. More...
 
virtual char * GetArrayName ()
 
virtual void SetComponent (int)
 Specify the array component to use to color the data. More...
 
virtual int GetComponent ()
 
virtual void SetLookupTable (vtkScalarsToColors *)
 A lookup table can be specified in order to convert data arrays to RGBA colors. More...
 
virtual vtkScalarsToColorsGetLookupTable ()
 
virtual void SetColor (unsigned char, unsigned char, unsigned char)
 Set the color to use when using a uniform color (either point or cells, or both). More...
 
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])
 
virtual void SetAlpha (unsigned char)
 Set the alpha to use when using a uniform color (effect point or cells, or both) and EnableAlpha is ON. More...
 
virtual unsigned char GetAlpha ()
 
vtkPolyDataGetInput ()
 Get the input to this writer. More...
 
vtkPolyDataGetInput (int port)
 
virtual void SetFileName (const char *)
 Specify file name of vtk polygon data file to write. More...
 
virtual char * GetFileName ()
 
virtual void SetFileType (int)
 Specify file type (ASCII or BINARY) for vtk data file. More...
 
virtual int GetFileType ()
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetTextureCoordinatesName (int)
 Choose the name used for the texture coordinates. More...
 
virtual int GetTextureCoordinatesName ()
 
void SetTextureCoordinatesNameToUV ()
 
void SetTextureCoordinatesNameToTextureUV ()
 
void AddComment (const std::string &comment)
 Add a comment in the header part. More...
 
- Public Member Functions inherited from vtkWriter
vtkWriterNewInstance () const
 
virtual int Write ()
 Write data to output. More...
 
void EncodeString (char *resname, const char *name, bool doublePercent)
 Encode the string so that the reader will not have problems. More...
 
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
 Encode the string so that the reader will not have problems. More...
 
void SetInputData (vtkDataObject *input)
 Set/get the input to this writer. More...
 
void SetInputData (int index, vtkDataObject *input)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkPLYWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPLYWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWriter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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 vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPLYWriter ()
 
 ~vtkPLYWriter () override
 
void WriteData () override
 
vtkSmartPointer< vtkUnsignedCharArrayGetColors (vtkIdType num, vtkDataSetAttributes *dsa)
 
const floatGetTextureCoordinates (vtkIdType num, vtkDataSetAttributes *dsa)
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 
 ~vtkWriter () override
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int DataByteOrder
 
char * ArrayName
 
int Component
 
int ColorMode
 
vtkScalarsToColorsLookupTable
 
unsigned char Color [3]
 
bool EnableAlpha
 
unsigned char Alpha
 
char * FileName
 
int FileType
 
int TextureCoordinatesName
 
vtkSmartPointer< vtkStringArrayHeaderComments
 
bool WriteToOutputString
 
std::string OutputString
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool 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 or 4 components, you need to specify a vtkLookupTable to map the scalars to RGB.

To enable saving out alpha (opacity) values, you must enable alpha using vtkPLYWriter::SetEnableAlpha().

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

Definition at line 68 of file vtkPLYWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 72 of file vtkPLYWriter.h.

Constructor & Destructor Documentation

◆ vtkPLYWriter()

vtkPLYWriter::vtkPLYWriter ( )
protected

◆ ~vtkPLYWriter()

vtkPLYWriter::~vtkPLYWriter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPLYWriter* vtkPLYWriter::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkPLYWriter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkWriter.

◆ SafeDownCast()

static vtkPLYWriter* vtkPLYWriter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPLYWriter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWriter.

◆ NewInstance()

vtkPLYWriter* vtkPLYWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkPLYWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkWriter.

◆ SetDataByteOrder()

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).

◆ GetDataByteOrder()

virtual int vtkPLYWriter::GetDataByteOrder ( )
virtual

◆ SetDataByteOrderToBigEndian()

void vtkPLYWriter::SetDataByteOrderToBigEndian ( )
inline

Definition at line 82 of file vtkPLYWriter.h.

◆ SetDataByteOrderToLittleEndian()

void vtkPLYWriter::SetDataByteOrderToLittleEndian ( )
inline

Definition at line 84 of file vtkPLYWriter.h.

◆ SetWriteToOutputString()

virtual void vtkPLYWriter::SetWriteToOutputString ( bool  )
virtual

Enable writing to an OutputString instead of the default, a file.

Note that writing to an output stream would be more flexible (enabling other kind of streams) and possibly more efficient because we don't need to write the whole stream to a string. However a stream interface does not translate well to python and the string interface satisfies our current needs. So we leave the stream interface for future work.

◆ GetWriteToOutputString()

virtual bool vtkPLYWriter::GetWriteToOutputString ( )
virtual

◆ WriteToOutputStringOn()

virtual void vtkPLYWriter::WriteToOutputStringOn ( )
virtual

◆ WriteToOutputStringOff()

virtual void vtkPLYWriter::WriteToOutputStringOff ( )
virtual

◆ GetOutputString()

const std::string& vtkPLYWriter::GetOutputString ( ) const
inline

Definition at line 100 of file vtkPLYWriter.h.

◆ SetColorMode()

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 of the array is four components, unsigned char, then the data is written as three separate "red", "green" and "blue" properties, dropping the "alpha". 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.)

◆ GetColorMode()

virtual int vtkPLYWriter::GetColorMode ( )
virtual

◆ SetColorModeToDefault()

void vtkPLYWriter::SetColorModeToDefault ( )
inline

Definition at line 127 of file vtkPLYWriter.h.

◆ SetColorModeToUniformCellColor()

void vtkPLYWriter::SetColorModeToUniformCellColor ( )
inline

Definition at line 129 of file vtkPLYWriter.h.

◆ SetColorModeToUniformPointColor()

void vtkPLYWriter::SetColorModeToUniformPointColor ( )
inline

Definition at line 131 of file vtkPLYWriter.h.

◆ SetColorModeToUniformColor()

void vtkPLYWriter::SetColorModeToUniformColor ( )
inline

Definition at line 133 of file vtkPLYWriter.h.

◆ SetColorModeToOff()

void vtkPLYWriter::SetColorModeToOff ( )
inline

Definition at line 135 of file vtkPLYWriter.h.

◆ SetEnableAlpha()

virtual void vtkPLYWriter::SetEnableAlpha ( bool  )
virtual

Enable alpha output.

Default is off, i.e. only color values will be saved based on ColorMode.

◆ GetEnableAlpha()

virtual bool vtkPLYWriter::GetEnableAlpha ( )
virtual

◆ EnableAlphaOn()

virtual void vtkPLYWriter::EnableAlphaOn ( )
virtual

◆ EnableAlphaOff()

virtual void vtkPLYWriter::EnableAlphaOff ( )
virtual

◆ SetArrayName()

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

Specify the array name to use to color the data.

◆ GetArrayName()

virtual char* vtkPLYWriter::GetArrayName ( )
virtual

◆ SetComponent()

virtual void vtkPLYWriter::SetComponent ( int  )
virtual

Specify the array component to use to color the data.

◆ GetComponent()

virtual int vtkPLYWriter::GetComponent ( )
virtual

◆ SetLookupTable()

virtual void vtkPLYWriter::SetLookupTable ( vtkScalarsToColors )
virtual

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

◆ GetLookupTable()

virtual vtkScalarsToColors* vtkPLYWriter::GetLookupTable ( )
virtual

◆ SetColor() [1/2]

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.

◆ SetColor() [2/2]

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

◆ GetColor() [1/3]

virtual unsigned char* vtkPLYWriter::GetColor ( )
virtual

◆ GetColor() [2/3]

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

◆ GetColor() [3/3]

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

◆ SetAlpha()

virtual void vtkPLYWriter::SetAlpha ( unsigned char  )
virtual

Set the alpha to use when using a uniform color (effect point or cells, or both) and EnableAlpha is ON.

◆ GetAlpha()

virtual unsigned char vtkPLYWriter::GetAlpha ( )
virtual

◆ GetInput() [1/2]

vtkPolyData* vtkPLYWriter::GetInput ( )

Get the input to this writer.

◆ GetInput() [2/2]

vtkPolyData* vtkPLYWriter::GetInput ( int  port)

◆ SetFileName()

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

Specify file name of vtk polygon data file to write.

◆ GetFileName()

virtual char* vtkPLYWriter::GetFileName ( )
virtual

◆ SetFileType()

virtual void vtkPLYWriter::SetFileType ( int  )
virtual

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

◆ GetFileType()

virtual int vtkPLYWriter::GetFileType ( )
virtual

◆ SetFileTypeToASCII()

void vtkPLYWriter::SetFileTypeToASCII ( )
inline

Definition at line 215 of file vtkPLYWriter.h.

◆ SetFileTypeToBinary()

void vtkPLYWriter::SetFileTypeToBinary ( )
inline

Definition at line 216 of file vtkPLYWriter.h.

◆ SetTextureCoordinatesName()

virtual void vtkPLYWriter::SetTextureCoordinatesName ( int  )
virtual

Choose the name used for the texture coordinates.

(u, v) or (texture_u, texture_v)

◆ GetTextureCoordinatesName()

virtual int vtkPLYWriter::GetTextureCoordinatesName ( )
virtual

◆ SetTextureCoordinatesNameToUV()

void vtkPLYWriter::SetTextureCoordinatesNameToUV ( )
inline

Definition at line 227 of file vtkPLYWriter.h.

◆ SetTextureCoordinatesNameToTextureUV()

void vtkPLYWriter::SetTextureCoordinatesNameToTextureUV ( )
inline

Definition at line 228 of file vtkPLYWriter.h.

◆ AddComment()

void vtkPLYWriter::AddComment ( const std::string &  comment)

Add a comment in the header part.

◆ WriteData()

void vtkPLYWriter::WriteData ( )
overrideprotectedvirtual

Implements vtkWriter.

◆ GetColors()

vtkSmartPointer<vtkUnsignedCharArray> vtkPLYWriter::GetColors ( vtkIdType  num,
vtkDataSetAttributes dsa 
)
protected

◆ GetTextureCoordinates()

const float* vtkPLYWriter::GetTextureCoordinates ( vtkIdType  num,
vtkDataSetAttributes dsa 
)
protected

◆ FillInputPortInformation()

int vtkPLYWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

◆ DataByteOrder

int vtkPLYWriter::DataByteOrder
protected

Definition at line 245 of file vtkPLYWriter.h.

◆ ArrayName

char* vtkPLYWriter::ArrayName
protected

Definition at line 246 of file vtkPLYWriter.h.

◆ Component

int vtkPLYWriter::Component
protected

Definition at line 247 of file vtkPLYWriter.h.

◆ ColorMode

int vtkPLYWriter::ColorMode
protected

Definition at line 248 of file vtkPLYWriter.h.

◆ LookupTable

vtkScalarsToColors* vtkPLYWriter::LookupTable
protected

Definition at line 249 of file vtkPLYWriter.h.

◆ Color

unsigned char vtkPLYWriter::Color[3]
protected

Definition at line 250 of file vtkPLYWriter.h.

◆ EnableAlpha

bool vtkPLYWriter::EnableAlpha
protected

Definition at line 252 of file vtkPLYWriter.h.

◆ Alpha

unsigned char vtkPLYWriter::Alpha
protected

Definition at line 253 of file vtkPLYWriter.h.

◆ FileName

char* vtkPLYWriter::FileName
protected

Definition at line 255 of file vtkPLYWriter.h.

◆ FileType

int vtkPLYWriter::FileType
protected

Definition at line 257 of file vtkPLYWriter.h.

◆ TextureCoordinatesName

int vtkPLYWriter::TextureCoordinatesName
protected

Definition at line 258 of file vtkPLYWriter.h.

◆ HeaderComments

vtkSmartPointer<vtkStringArray> vtkPLYWriter::HeaderComments
protected

Definition at line 260 of file vtkPLYWriter.h.

◆ WriteToOutputString

bool vtkPLYWriter::WriteToOutputString
protected

Definition at line 264 of file vtkPLYWriter.h.

◆ OutputString

std::string vtkPLYWriter::OutputString
protected

Definition at line 267 of file vtkPLYWriter.h.


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