Reads a MITK scene from an XML document and populates a DataStorage. More...

#include <mitkSceneReader.h>

Inheritance diagram for mitk::SceneReader:

Collaboration diagram for mitk::SceneReader:

Public Member Functions
	mitkClassMacroItkParent (SceneReader, itk::Object)

Pointer	Clone () const

virtual bool	LoadScene (tinyxml2::XMLDocument &document, const std::string &workingDirectory, DataStorage *storage)
	Loads a scene from a parsed XML document into the given DataStorage. More...

Static Public Member Functions
static Pointer	New ()

Detailed Description

Reads a MITK scene from an XML document and populates a DataStorage.

SceneReader is the dispatcher for versioned scene file reading. It reads the version information from the XML document and delegates the actual loading to a version-specific reader (e.g., SceneReaderV1) discovered via the ITK object factory. This allows transparent handling of different scene file format versions.

See also: SceneIO, SceneReaderV1

Definition at line 40 of file mitkSceneReader.h.

Member Function Documentation

◆ Clone()

Pointer mitk::SceneReader::Clone ( ) const

◆ LoadScene()

virtual bool mitk::SceneReader::LoadScene	(	tinyxml2::XMLDocument &	document,
		const std::string &	workingDirectory,
		DataStorage *	storage
	)

virtual

Loads a scene from a parsed XML document into the given DataStorage.

Reads the file version from the XML document, instantiates the appropriate versioned scene reader (e.g., SceneReaderV1), and delegates the loading to it.

Parameters

[in]	document	The parsed XML document (index.xml content).
[in]	workingDirectory	The directory containing the serialized data files referenced by the XML document.
[in]	storage	The DataStorage to populate with loaded DataNodes.

Returns: True if the scene was loaded successfully, false if errors occurred (e.g., no reader found for the file version, or the reader reported errors).

Precondition: storage must not be null.

Reimplemented in mitk::SceneReaderV1.

◆ mitkClassMacroItkParent()

mitk::SceneReader::mitkClassMacroItkParent	(	SceneReader	,
		itk::Object
	)

◆ New()

static Pointer mitk::SceneReader::New ( )

static

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

mitkSceneReader.h