Reader for MITK JSON scene files (.mitkscene.json). More...

#include <mitkSceneJsonReader.h>

Inheritance diagram for mitk::SceneJsonReader:

Collaboration diagram for mitk::SceneJsonReader:

Public Member Functions
	mitkClassMacro (SceneJsonReader, AbstractSceneReader)

Pointer	Clone () const

bool	LoadScene (const std::string &sceneSourcePath, DataStorage *storage, bool clearStorageFirst=false) override
	Load a JSON scene file. More...

Public Member Functions inherited from mitk::AbstractSceneReader
	mitkClassMacroItkParent (AbstractSceneReader, itk::Object)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	SceneJsonReader ()

	~SceneJsonReader () override

Protected Member Functions inherited from mitk::AbstractSceneReader
	AbstractSceneReader ()

	~AbstractSceneReader () override

Detailed Description

Reader for MITK JSON scene files (.mitkscene.json).

Loads scenes described in the JSON scene format (root object { "type": "org.mitk.scene", "version": 1, "nodes": [...] }) into a DataStorage. See the format specification page for the full schema.

The reader supports two load styles per property map:

modify (default): mapper-assigned defaults are kept; only listed properties override them.
replace: the target property list is cleared unconditionally (plain PropertyList::Clear()) before the listed properties are applied. This intentionally differs from the legacy XML reader, which preserved a small set of mapper-assigned defaults; JSON authors that need those properties must list them explicitly.

The reader is invoked either via SceneIO (for .mitk archives containing an index.json, or for standalone .mitkscene.json files) or directly.

Definition at line 42 of file mitkSceneJsonReader.h.

Constructor & Destructor Documentation

◆ SceneJsonReader()

mitk::SceneJsonReader::SceneJsonReader ( )

protected

◆ ~SceneJsonReader()

mitk::SceneJsonReader::~SceneJsonReader ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::SceneJsonReader::Clone ( ) const

◆ LoadScene()

bool mitk::SceneJsonReader::LoadScene	(	const std::string &	sceneSourcePath,
		DataStorage *	storage,
		bool	clearStorageFirst = `false`
	)

overridevirtual

Load a JSON scene file.

Parameters

sceneSourcePath	Absolute path of the `.mitkscene.json` / `index.json` file. Its parent directory is the base path for resolving relative `_file` references.
storage	Target DataStorage. Must not be null.
clearStorageFirst	If true, `storage` is cleared after the scene root header (`type`, `version`) has been parsed and validated, but before any node is added. A malformed or unreadable file leaves the existing storage contents untouched.

Returns: True on success; false if non-fatal errors occurred.

Exceptions

mitk::Exception on fatal errors.

Implements mitk::AbstractSceneReader.

◆ mitkClassMacro()

mitk::SceneJsonReader::mitkClassMacro	(	SceneJsonReader	,
		AbstractSceneReader
	)

◆ New()

static Pointer mitk::SceneJsonReader::New ( )

static

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

mitkSceneJsonReader.h

Public Member Functions

Static Public Member Functions

Protected Member Functions