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

write polygonal data as a CGM file More...

#include <vtkCGMWriter.h>

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

Public Types

typedef vtkPolyDataWriter Superclass
 
- Public Types inherited from vtkPolyDataWriter
typedef vtkDataWriter Superclass
 
- Public Types inherited from vtkDataWriter
enum  VTKFileVersion { VTK_LEGACY_READER_VERSION_4_2 = 42 , VTK_LEGACY_READER_VERSION_5_1 = 51 }
 
typedef vtkWriter Superclass
 Standard methods for type information and printing. More...
 
- 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)
 Standard methods for type information and printing. More...
 
vtkCGMWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetViewport (vtkViewport *)
 Specify a vtkViewport object to be used to transform the vtkPolyData points into 2D coordinates. More...
 
virtual vtkViewportGetViewport ()
 Specify a vtkViewport object to be used to transform the vtkPolyData points into 2D coordinates. More...
 
virtual void SetSort (int)
 Turn on/off the sorting of the cells via depth. More...
 
virtual int GetSort ()
 Turn on/off the sorting of the cells via depth. More...
 
virtual void SetResolution (int)
 Specify the resolution of the CGM file. More...
 
virtual int GetResolution ()
 Specify the resolution of the CGM file. More...
 
virtual void SetColorMode (int)
 Control how output polydata is colored. More...
 
virtual int GetColorMode ()
 Control how output polydata is colored. More...
 
void SetColorModeToDefault ()
 Control how output polydata is colored. More...
 
void SetColorModeToSpecifiedColor ()
 Control how output polydata is colored. More...
 
void SetColorModeToRandomColors ()
 Control how output polydata is colored. More...
 
virtual void SetSpecifiedColor (float, float, float)
 Set/Get the specified color to color the polydata cells. More...
 
virtual void SetSpecifiedColor (float[3])
 Set/Get the specified color to color the polydata cells. More...
 
virtual float * GetSpecifiedColor ()
 Set/Get the specified color to color the polydata cells. More...
 
virtual void GetSpecifiedColor (float data[3])
 Set/Get the specified color to color the polydata cells. More...
 
- Public Member Functions inherited from vtkPolyDataWriter
virtual vtkTypeBool IsA (const char *type)
 Standard methods for type information and printing. More...
 
vtkPolyDataWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for type information and printing. More...
 
vtkPolyDataGetInput ()
 Get the input to this writer. More...
 
vtkPolyDataGetInput (int port)
 Get the input to this writer. More...
 
- Public Member Functions inherited from vtkDataWriter
vtkStdString GetOutputStdString ()
 When WriteToOutputString is on, this method returns a copy of the output string in a vtkStdString. More...
 
char * RegisterAndGetOutputString ()
 This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string. More...
 
virtual ostream * OpenVTKFile ()
 Open a vtk data file. More...
 
int WriteHeader (ostream *fp)
 Write the header of a vtk data file. More...
 
int WritePoints (ostream *fp, vtkPoints *p)
 Write out the points of the data set. More...
 
int WriteCoordinates (ostream *fp, vtkDataArray *coords, int axes)
 Write out coordinates for rectilinear grids. More...
 
int WriteCells (ostream *fp, vtkCellArray *cells, const char *label)
 Write out the cells of the data set. More...
 
int WriteCellsLegacy (ostream *fp, vtkCellArray *cells, const char *label)
 Write out the cells of the data set. More...
 
int WriteCellData (ostream *fp, vtkDataSet *ds)
 Write the cell data (e.g., scalars, vectors, ...) of a vtk dataset. More...
 
int WritePointData (ostream *fp, vtkDataSet *ds)
 Write the point data (e.g., scalars, vectors, ...) of a vtk dataset. More...
 
int WriteEdgeData (ostream *fp, vtkGraph *g)
 Write the edge data (e.g., scalars, vectors, ...) of a vtk graph. More...
 
int WriteVertexData (ostream *fp, vtkGraph *g)
 Write the vertex data (e.g., scalars, vectors, ...) of a vtk graph. More...
 
int WriteRowData (ostream *fp, vtkTable *g)
 Write the row data (e.g., scalars, vectors, ...) of a vtk table. More...
 
int WriteFieldData (ostream *fp, vtkFieldData *f)
 Write out the field data. More...
 
int WriteDataSetData (ostream *fp, vtkDataSet *ds)
 Write out the data associated with the dataset (i.e. More...
 
void CloseVTKFile (ostream *fp)
 Close a vtk file. More...
 
 vtkSetFilePathMacro (FileName)
 Specify the file name of VTK data file to write. More...
 
 vtkGetFilePathMacro (FileName)
 Specify the file name of VTK data file to write. More...
 
void SetFileVersion (int)
 Specify the VTK file version to write. More...
 
virtual int GetFileVersion ()
 Specify the VTK file version to write. More...
 
virtual int GetFileMajorVersion ()
 Specify the VTK file version to write. More...
 
virtual int GetFileMinorVersion ()
 Specify the VTK file version to write. More...
 
virtual void SetWriteToOutputString (vtkTypeBool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual vtkTypeBool GetWriteToOutputString ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual void WriteToOutputStringOn ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual void WriteToOutputStringOff ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual vtkIdType GetOutputStringLength ()
 When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...
 
virtual char * GetOutputString ()
 When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...
 
unsigned char * GetBinaryOutputString ()
 When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...
 
virtual void SetHeader (const char *)
 Specify the header for the VTK data file. More...
 
virtual char * GetHeader ()
 Specify the header for the VTK data file. More...
 
virtual void SetWriteArrayMetaData (bool)
 If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...
 
virtual bool GetWriteArrayMetaData ()
 If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...
 
virtual void WriteArrayMetaDataOn ()
 If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...
 
virtual void WriteArrayMetaDataOff ()
 If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...
 
virtual void SetFileType (int)
 Specify the file type (ASCII or BINARY) of the VTK data file. More...
 
virtual int GetFileType ()
 Specify the file type (ASCII or BINARY) of the VTK data file. More...
 
void SetFileTypeToASCII ()
 Specify the file type (ASCII or BINARY) of the VTK data file. More...
 
void SetFileTypeToBinary ()
 Specify the file type (ASCII or BINARY) of the VTK data file. More...
 
virtual void SetScalarsName (const char *)
 Give a name to the scalar data. More...
 
virtual char * GetScalarsName ()
 Give a name to the scalar data. More...
 
virtual void SetVectorsName (const char *)
 Give a name to the vector data. More...
 
virtual char * GetVectorsName ()
 Give a name to the vector data. More...
 
virtual void SetTensorsName (const char *)
 Give a name to the tensors data. More...
 
virtual char * GetTensorsName ()
 Give a name to the tensors data. More...
 
virtual void SetNormalsName (const char *)
 Give a name to the normals data. More...
 
virtual char * GetNormalsName ()
 Give a name to the normals data. More...
 
virtual void SetTCoordsName (const char *)
 Give a name to the texture coordinates data. More...
 
virtual char * GetTCoordsName ()
 Give a name to the texture coordinates data. More...
 
virtual void SetGlobalIdsName (const char *)
 Give a name to the global ids data. More...
 
virtual char * GetGlobalIdsName ()
 Give a name to the global ids data. More...
 
virtual void SetPedigreeIdsName (const char *)
 Give a name to the pedigree ids data. More...
 
virtual char * GetPedigreeIdsName ()
 Give a name to the pedigree ids data. More...
 
virtual void SetEdgeFlagsName (const char *)
 Give a name to the edge flags data. More...
 
virtual char * GetEdgeFlagsName ()
 Give a name to the edge flags data. More...
 
virtual void SetLookupTableName (const char *)
 Give a name to the lookup table. More...
 
virtual char * GetLookupTableName ()
 Give a name to the lookup table. More...
 
virtual void SetFieldDataName (const char *)
 Give a name to the field data. More...
 
virtual char * GetFieldDataName ()
 Give a name to the field data. More...
 
vtkDataWriterNewInstance () const
 Standard methods for type information and printing. More...
 
- Public Member Functions inherited from vtkWriter
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
void SetInputData (vtkDataObject *input)
 Set/get the input to this writer. More...
 
void SetInputData (int index, vtkDataObject *input)
 Set/get the input to this writer. More...
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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...
 
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 SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
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 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 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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a 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 ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
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)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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)
 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 * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkCGMWriterNew ()
 Instantiate with no viewport defined and sorting on. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCGMWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataWriter
static vtkPolyDataWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataWriter
static vtkDataWriterNew ()
 Create object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for type information and printing. More...
 
static vtkDataWriterSafeDownCast (vtkObjectBase *o)
 Standard methods for type information and printing. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for type information and printing. More...
 
 vtkCGMWriter ()
 
 ~vtkCGMWriter () override
 
void WriteData ()
 
- Protected Member Functions inherited from vtkPolyDataWriter
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for type information and printing. More...
 
 vtkPolyDataWriter ()=default
 
 ~vtkPolyDataWriter () override=default
 
void WriteData () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkDataWriter
 vtkDataWriter ()
 
 ~vtkDataWriter () override
 
void WriteData () override
 
int WriteArray (ostream *fp, int dataType, vtkAbstractArray *data, const char *format, vtkIdType num, vtkIdType numComp)
 
int WriteScalarData (ostream *fp, vtkDataArray *s, vtkIdType num)
 
int WriteVectorData (ostream *fp, vtkDataArray *v, vtkIdType num)
 
int WriteNormalData (ostream *fp, vtkDataArray *n, vtkIdType num)
 
int WriteTCoordData (ostream *fp, vtkDataArray *tc, vtkIdType num)
 
int WriteTensorData (ostream *fp, vtkDataArray *t, vtkIdType num)
 
int WriteGlobalIdData (ostream *fp, vtkDataArray *g, vtkIdType num)
 
int WritePedigreeIdData (ostream *fp, vtkAbstractArray *p, vtkIdType num)
 
int WriteEdgeFlagsData (ostream *fp, vtkDataArray *edgeFlags, vtkIdType num)
 
bool CanWriteInformationKey (vtkInformation *info, vtkInformationKey *key)
 
int WriteInformation (ostream *fp, vtkInformation *info)
 Format is detailed here. More...
 
- Protected Member Functions inherited from vtkWriter
virtual vtkObjectBaseNewInstanceInternal () const
 
 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)
 
virtual void WriteData ()=0
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
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...
 
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...
 
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)
 
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)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkViewportViewport
 
int ColorMode
 
float SpecifiedColor [3]
 
int Resolution
 
int Sort
 
- Protected Attributes inherited from vtkDataWriter
vtkTypeBool WriteToOutputString
 
char * OutputString
 
vtkIdType OutputStringLength
 
char * FileName
 
int FileVersion
 
int FileMajorVersion
 
int FileMinorVersion
 
char * Header
 
int FileType
 
bool WriteArrayMetaData
 
char * ScalarsName
 
char * VectorsName
 
char * TensorsName
 
char * TCoordsName
 
char * NormalsName
 
char * LookupTableName
 
char * FieldDataName
 
char * GlobalIdsName
 
char * PedigreeIdsName
 
char * EdgeFlagsName
 
std::locale CurrentLocale
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

write polygonal data as a CGM file

vtkCGMWriter writes CGM (Computer Graphics Metafile) output. CGM is a 2D graphics vector format typically used by large plotters. This writer can handle vertices, lines, polygons, and triangle strips in any combination. Colors are specified either 1) from cell scalars (assumed to be RGB or RGBA color specification), 2) from a specified color; or 3) randomly assigned colors.

Note: During output of the polygonal data, triangle strips are converted to triangles, and polylines to lines. Also, due to limitations in the CGM color model, only 256 colors are available to the color palette.

Warning
The class vtkImageToPolyDataFilter is convenient for converting a raster image into polygons (and color map) suitable for plotting with CGM.
See also
vtkPolyDataWriter vtkPointDataToCellData

Definition at line 50 of file vtkCGMWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkCGMWriter.h.

Constructor & Destructor Documentation

◆ vtkCGMWriter()

vtkCGMWriter::vtkCGMWriter ( )
protected

◆ ~vtkCGMWriter()

vtkCGMWriter::~vtkCGMWriter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCGMWriter * vtkCGMWriter::New ( )
static

Instantiate with no viewport defined and sorting on.

The default resolution is 10,000, and the color mode is set to default.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCGMWriter::IsA ( const char *  type)
virtual

Standard methods for type information and printing.

Reimplemented from vtkPolyDataWriter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCGMWriter::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkPolyDataWriter.

◆ NewInstance()

vtkCGMWriter * vtkCGMWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkCGMWriter::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 vtkWriter.

◆ SetViewport()

virtual void vtkCGMWriter::SetViewport ( vtkViewport )
virtual

Specify a vtkViewport object to be used to transform the vtkPolyData points into 2D coordinates.

By default (no vtkViewport specified), the point coordinates are generated by ignoring the z values. If a viewport is defined, then the points are transformed into viewport coordinates.

◆ GetViewport()

virtual vtkViewport * vtkCGMWriter::GetViewport ( )
virtual

Specify a vtkViewport object to be used to transform the vtkPolyData points into 2D coordinates.

By default (no vtkViewport specified), the point coordinates are generated by ignoring the z values. If a viewport is defined, then the points are transformed into viewport coordinates.

◆ SetSort()

virtual void vtkCGMWriter::SetSort ( int  )
virtual

Turn on/off the sorting of the cells via depth.

If enabled, polygonal cells will be sorted from back to front, i.e., a Painter's algorithm sort.

◆ GetSort()

virtual int vtkCGMWriter::GetSort ( )
virtual

Turn on/off the sorting of the cells via depth.

If enabled, polygonal cells will be sorted from back to front, i.e., a Painter's algorithm sort.

◆ SetResolution()

virtual void vtkCGMWriter::SetResolution ( int  )
virtual

Specify the resolution of the CGM file.

This number is used to integerize the maximum coordinate range of the plot file.

◆ GetResolution()

virtual int vtkCGMWriter::GetResolution ( )
virtual

Specify the resolution of the CGM file.

This number is used to integerize the maximum coordinate range of the plot file.

◆ SetColorMode()

virtual void vtkCGMWriter::SetColorMode ( int  )
virtual

Control how output polydata is colored.

By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.

◆ GetColorMode()

virtual int vtkCGMWriter::GetColorMode ( )
virtual

Control how output polydata is colored.

By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.

◆ SetColorModeToDefault()

void vtkCGMWriter::SetColorModeToDefault ( )
inline

Control how output polydata is colored.

By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.

Definition at line 105 of file vtkCGMWriter.h.

◆ SetColorModeToSpecifiedColor()

void vtkCGMWriter::SetColorModeToSpecifiedColor ( )
inline

Control how output polydata is colored.

By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.

Definition at line 106 of file vtkCGMWriter.h.

◆ SetColorModeToRandomColors()

void vtkCGMWriter::SetColorModeToRandomColors ( )
inline

Control how output polydata is colored.

By default (ColorModeToDefault), if per cell colors are defined (unsigned chars of 1-4 components), then the cells are colored with these values. (If point colors are defined and cell colors are not, you can use vtkPointDataToCellData to convert the point colors to cell colors.) Otherwise, by default, the cells are set to the specified color. If ColorModeToSpecifiedColor is set, then the primitives will all be set to this color. If ColorModeToRandomColors is set, each cell will be randomly assigned a color.

Definition at line 107 of file vtkCGMWriter.h.

◆ SetSpecifiedColor() [1/2]

virtual void vtkCGMWriter::SetSpecifiedColor ( float  ,
float  ,
float   
)
virtual

Set/Get the specified color to color the polydata cells.

This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note: CGM will map this color to the closest color it supports.)

◆ SetSpecifiedColor() [2/2]

virtual void vtkCGMWriter::SetSpecifiedColor ( float  [3])
virtual

Set/Get the specified color to color the polydata cells.

This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note: CGM will map this color to the closest color it supports.)

◆ GetSpecifiedColor() [1/2]

virtual float * vtkCGMWriter::GetSpecifiedColor ( )
virtual

Set/Get the specified color to color the polydata cells.

This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note: CGM will map this color to the closest color it supports.)

◆ GetSpecifiedColor() [2/2]

virtual void vtkCGMWriter::GetSpecifiedColor ( float  data[3])
virtual

Set/Get the specified color to color the polydata cells.

This color is only used when the color mode is set to ColorModeToSpecifiedColor, or ColorModeToDefault is set and no cell colors are specified. The specified color is specified as RGB values ranging from (0,1). (Note: CGM will map this color to the closest color it supports.)

◆ WriteData()

void vtkCGMWriter::WriteData ( )
protectedvirtual

Implements vtkWriter.

Member Data Documentation

◆ Viewport

vtkViewport* vtkCGMWriter::Viewport
protected

Definition at line 128 of file vtkCGMWriter.h.

◆ ColorMode

int vtkCGMWriter::ColorMode
protected

Definition at line 129 of file vtkCGMWriter.h.

◆ SpecifiedColor

float vtkCGMWriter::SpecifiedColor[3]
protected

Definition at line 130 of file vtkCGMWriter.h.

◆ Resolution

int vtkCGMWriter::Resolution
protected

Definition at line 131 of file vtkCGMWriter.h.

◆ Sort

int vtkCGMWriter::Sort
protected

Definition at line 132 of file vtkCGMWriter.h.


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