#include <Base/QTCore/qSlicerVTKFileWriter.h>

Inheritance diagram for qSlicerVTKFileWriter:

[legend]

Collaboration diagram for qSlicerVTKFileWriter:

[legend]

Public Types
typedef qSlicerFileWriter	Superclass

Public Types inherited from qSlicerIO
typedef QString	IOFileType

typedef QVariantMap	IOProperties

typedef QObject	Superclass

Public Member Functions
bool	canWriteObject (vtkObject *object) const override

double	canWriteObjectConfidence (vtkObject *object) const override

QString	description () const override
	Unique name of the reader/writer.

QStringList	extensions (vtkObject *object) const override

IOFileType	fileType () const override
	Multiple readers can share the same file type.

Q_INVOKABLE vtkMRMLFileWriter *	fileWriter () const
	VTK-based writer that performs all the tasks of this class.

vtkMRMLFileIOHandler *	ioHandler () const override
	Returns the VTK-based writer (same as fileWriter()).

	qSlicerVTKFileWriter (vtkMRMLFileWriter writer, QObject parent=nullptr)

void	setMRMLScene (vtkMRMLScene *scene) override
	Set the scene of this object and of the VTK-based writer.

vtkMRMLMessageCollection *	userMessages () const override
	Additional warning or error messages occurred during IO operation.

bool	write (const qSlicerIO::IOProperties &properties) override

QStringList	writtenNodes () const override

	~qSlicerVTKFileWriter () override

Public Member Functions inherited from qSlicerFileWriter
	qSlicerFileWriter (QObject *parent=nullptr)

	~qSlicerFileWriter () override

Public Member Functions inherited from qSlicerIO
virtual Q_INVOKABLE qSlicerIOOptions *	options () const

	qSlicerIO (QObject *parent=nullptr)

	~qSlicerIO () override

Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.

	qSlicerObject ()

virtual	~qSlicerObject ()

Protected Member Functions
void	setFileWriter (vtkMRMLFileWriter *writer)

void	setWrittenNodes (const QStringList &nodes) override

Protected Attributes
QScopedPointer< qSlicerVTKFileWriterPrivate >	d_ptr

Protected Attributes inherited from qSlicerFileWriter
QScopedPointer< qSlicerFileWriterPrivate >	d_ptr

Protected Attributes inherited from qSlicerIO
QScopedPointer< qSlicerIOPrivate >	d_ptr

Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Additional Inherited Members
Static Public Member Functions inherited from qSlicerIO
static IOProperties	fromVTKProperties (vtkMRMLIOProperties *vtkProperties)

static bool	qImageToVTKImageData (const QImage &image, vtkImageData *imageData)
	Convert Qt image to VTK image (RGBA, unsigned char).

static void	toVTKProperties (const IOProperties &properties, vtkMRMLIOProperties *vtkProperties)

static QImage	vtkImageDataToQImage (vtkImageData *imageData)
	Convert VTK image (unsigned char, 1, 3, or 4 components) to Qt image.

Detailed Description

Qt interface of a VTK-based file writer: all methods are delegated to the VTK-based writer (see fileWriter()). Subclasses may override methods (for example, canWriteObject() or write()).

See https://slicer.readthedocs.io/en/latest/developer_guide/mrml_overview.html#qt-interface

Definition at line 32 of file qSlicerVTKFileWriter.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerFileWriter qSlicerVTKFileWriter::Superclass

Definition at line 36 of file qSlicerVTKFileWriter.h.

Constructor & Destructor Documentation

◆ qSlicerVTKFileWriter()

qSlicerVTKFileWriter::qSlicerVTKFileWriter	(	vtkMRMLFileWriter *	writer,
		QObject *	parent = nullptr )

explicit

◆ ~qSlicerVTKFileWriter()

qSlicerVTKFileWriter::~qSlicerVTKFileWriter ( )

override

Member Function Documentation

◆ canWriteObject()

bool qSlicerVTKFileWriter::canWriteObject ( vtkObject * object ) const

overridevirtual

Return true if the object is handled by the writer. This method is kept for backward compatibility, writers should override canWriteObjectConfidence method instead of this method to indicate if they can write the object.

Reimplemented from qSlicerFileWriter.

◆ canWriteObjectConfidence()

double qSlicerVTKFileWriter::canWriteObjectConfidence ( vtkObject * object ) const

overridevirtual

Returns the confidence of the VTK-based writer. If a subclass overrides canWriteObject() then the confidence is computed from canWriteObject() instead, to respect the override.

Reimplemented from qSlicerFileWriter.

◆ description()

QString qSlicerVTKFileWriter::description ( ) const

overridevirtual

Unique name of the reader/writer.

Implements qSlicerIO.

◆ extensions()

QStringList qSlicerVTKFileWriter::extensions ( vtkObject * object ) const

overridevirtual

Return a list of the supported extensions for a particular object. Please read QFileDialog::nameFilters for the allowed formats Example: "Image (*.jpg *.png *.tiff)", "Model (*.vtk)"

Implements qSlicerFileWriter.

◆ fileType()

IOFileType qSlicerVTKFileWriter::fileType ( ) const

overridevirtual

Multiple readers can share the same file type.

Implements qSlicerIO.

◆ fileWriter()

Q_INVOKABLE vtkMRMLFileWriter * qSlicerVTKFileWriter::fileWriter ( ) const

VTK-based writer that performs all the tasks of this class.

◆ ioHandler()

vtkMRMLFileIOHandler * qSlicerVTKFileWriter::ioHandler ( ) const

overridevirtual

Returns the VTK-based writer (same as fileWriter()).

Reimplemented from qSlicerIO.

◆ setFileWriter()

void qSlicerVTKFileWriter::setFileWriter ( vtkMRMLFileWriter * writer )

protected

Set the VTK-based writer that performs all the tasks of this class. The current scene is set in the writer. It must be called from the constructor of the class that delegates all tasks to the VTK-based writer (the class of the object is recorded to detect subclasses that may override methods).

◆ setMRMLScene()

void qSlicerVTKFileWriter::setMRMLScene ( vtkMRMLScene * scene )

overridevirtual

Set the scene of this object and of the VTK-based writer.

Reimplemented from qSlicerIO.

◆ setWrittenNodes()

void qSlicerVTKFileWriter::setWrittenNodes ( const QStringList & nodes )

overrideprotectedvirtual

Reimplemented from qSlicerFileWriter.

◆ userMessages()

vtkMRMLMessageCollection * qSlicerVTKFileWriter::userMessages ( ) const

overridevirtual

Additional warning or error messages occurred during IO operation.

Reimplemented from qSlicerIO.

◆ write()

bool qSlicerVTKFileWriter::write ( const qSlicerIO::IOProperties & properties )

overridevirtual

Write the node identified by nodeID into the fileName file. Returns true on success Properties available:

QString nodeID
QString fileName
QString fileFormat
bool compressed ...

Reimplemented from qSlicerFileWriter.

◆ writtenNodes()

QStringList qSlicerVTKFileWriter::writtenNodes ( ) const

overridevirtual

Return the list of saved nodes from writing the file(s) in write(). Empty list if write() failed

See also: setWrittenNodes(), write()

Reimplemented from qSlicerFileWriter.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerVTKFileWriterPrivate> qSlicerVTKFileWriter::d_ptr

protected

Definition at line 74 of file qSlicerVTKFileWriter.h.

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

Base/QTCore/qSlicerVTKFileWriter.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerVTKFileWriter()

◆ ~qSlicerVTKFileWriter()

Member Function Documentation

◆ canWriteObject()

◆ canWriteObjectConfidence()

◆ description()

◆ extensions()

◆ fileType()

◆ fileWriter()

◆ ioHandler()

◆ setFileWriter()

◆ setMRMLScene()

◆ setWrittenNodes()

◆ userMessages()

◆ write()

◆ writtenNodes()

Member Data Documentation

◆ d_ptr