ImFusion::StereoImageImFusionFilePlugin Class Reference

#include <ImFusion/Vision/StereoImageImFusionFilePlugin.h>

Loading and saving of the ImFusion stereo image format. More...

Inheritance diagram for ImFusion::StereoImageImFusionFilePlugin:

Detailed Description

Loading and saving of the ImFusion stereo image format.

Public Member Functions
	StereoImageImFusionFilePlugin ()
	Constructor with filename to load or save.
	~StereoImageImFusionFilePlugin () override
	Deletes all auxiliary storage however not any loaded data.
Data *	loadInstance (unsigned int type, unsigned int headerSize) override
	Create specialized instance for a given data type or return null if not supported.
unsigned int	saveType (const Data *data) override
	Return type for saving a given data instance or null if not supported.
bool	load (unsigned int type, Data *data, std::istream &file, Progress *p=0) override
	Load specified data type into given class instance from file, return true upon success.
bool	save (Data *data, std::ostream &file, Progress *p=0) override
	Save a data instance to file, return true if successful.
std::unique_ptr< Properties >	customPropertiesToSave (Data *data) override
	Lets plugin save custom properties as part of the global file metadata.
bool	loadCustomProperties (Data *data, Properties *prop) override
	Load custom properties as returned previously by customPropertiesToSave().
Public Member Functions inherited from ImFusion::ImFusionFilePlugin
virtual	~ImFusionFilePlugin ()=default
	Destructor.
virtual void	applyFlipToEnsureConsistency (Data *)
	Is called after the image content had to be flipped to ensure a consistent coordinate system.
virtual bool	beginBlockWrite (std::iostream &)
	Initialize plugin with current file pointer.
virtual unsigned long long	endBlockWrite ()
	Indicate to plugin that the block it is writing needs to be finished.
virtual bool	beginBlockRead (std::iostream &, unsigned long long)
	Initialize plugin with current file pointer.
virtual bool	endBlockRead ()
	Indicate to plugin that it will lose read access to the file pointer after this call.
virtual void	setBlockType (unsigned int type)
	Set the type of current data block which is being loaded/saved.

Additional Inherited Members
Protected Attributes inherited from ImFusion::ImFusionFilePlugin
unsigned int	m_blockType = 0
	Keeps the type of currently saving/loading data block.

Member Function Documentation

loadInstance()

Data * ImFusion::StereoImageImFusionFilePlugin::loadInstance ( unsigned int type, unsigned int headerSize )

overridevirtual

Create specialized instance for a given data type or return null if not supported.

Implements ImFusion::ImFusionFilePlugin.

saveType()

unsigned int ImFusion::StereoImageImFusionFilePlugin::saveType ( const Data * data )

overridevirtual

Return type for saving a given data instance or null if not supported.

Implements ImFusion::ImFusionFilePlugin.

load()

bool ImFusion::StereoImageImFusionFilePlugin::load ( unsigned int type, Data * data, std::istream & file, Progress * p = 0 )

overridevirtual

Load specified data type into given class instance from file, return true upon success.

Reimplemented from ImFusion::ImFusionFilePlugin.

save()

bool ImFusion::StereoImageImFusionFilePlugin::save ( Data * data, std::ostream & file, Progress * p = 0 )

overridevirtual

Save a data instance to file, return true if successful.

Reimplemented from ImFusion::ImFusionFilePlugin.

customPropertiesToSave()

std::unique_ptr< Properties > ImFusion::StereoImageImFusionFilePlugin::customPropertiesToSave ( Data * )

overridevirtual

Lets plugin save custom properties as part of the global file metadata.

Reimplemented from ImFusion::ImFusionFilePlugin.

loadCustomProperties()

bool ImFusion::StereoImageImFusionFilePlugin::loadCustomProperties ( Data * , Properties *  )

overridevirtual

Load custom properties as returned previously by customPropertiesToSave().

Returns

true if successful, false otherwise

Reimplemented from ImFusion::ImFusionFilePlugin.

---

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

• ImFusion/Vision/StereoImageImFusionFilePlugin.h