CLOUDVIEWER dedicated binary point cloud I/O filter. More...

#include <BinFilter.h>

Inheritance diagram for BinFilter:

Collaboration diagram for BinFilter:

Public Member Functions
	BinFilter ()

virtual CC_FILE_ERROR	loadFile (const QString &filename, ccHObject &container, LoadParameters &parameters) override
	Loads one or more entities from a file. More...

virtual bool	canSave (CV_CLASS_ENUM type, bool &multiple, bool &exclusive) const override
	Returns whether this I/O filter can save the specified type of entity. More...

virtual CC_FILE_ERROR	saveToFile (ccHObject *entity, const QString &filename, const SaveParameters &parameters) override
	Saves an entity (or a group of) to a file. More...

Public Member Functions inherited from FileIOFilter
virtual	~FileIOFilter ()=default

bool	importSupported () const
	Returns whether this I/O filter can import files. More...

bool	exportSupported () const
	Returns whether this I/O filter can export files. More...

const QStringList &	getFileFilters (bool onImport) const
	Returns the file filter(s) for this I/O filter. More...

QString	getDefaultExtension () const
	Returns the default file extension. More...

virtual void	unregister ()
	Called when the filter is unregistered. More...

Static Public Member Functions
static QString	GetFileFilter ()

static QString	GetDefaultExtension ()

static short	GetLastSavedFileVersion ()
	Returns the last saved file version. More...

static CC_FILE_ERROR	LoadFileV1 (QFile &in, ccHObject &container, unsigned nbScansTotal, const LoadParameters &parameters)
	old style BIN loading More...

static CC_FILE_ERROR	LoadFileV2 (QFile &in, ccHObject &container, int flags, bool parallel, QWidget *parentWidget=nullptr)
	new style BIN loading More...

static CC_FILE_ERROR	SaveFileV2 (QFile &out, ccHObject *object)
	new style BIN saving More...

Static Public Member Functions inherited from FileIOFilter
static QStringList	ImportFilterList ()

static ccHObject *	LoadFromFile (const QString &filename, LoadParameters &parameters, Shared filter, CC_FILE_ERROR &result)
	Loads one or more entities from a file with a known filter. More...

static ccHObject *	LoadFromFile (const QString &filename, LoadParameters &parameters, CC_FILE_ERROR &result, const QString &fileFilter=QString())
	Loads one or more entities from a file with known type. More...

static CC_FILE_ERROR	SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, Shared filter)

static CC_FILE_ERROR	SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, const QString &fileFilter)

static bool	HandleGlobalShift (const CCVector3d &P, CCVector3d &Pshift, bool &preserveCoordinateShift, LoadParameters &loadParameters, bool useInputCoordinatesShiftIfPossible=false)
	Shortcut to the ecvGlobalShiftManager mechanism specific for files. More...

static void	DisplayErrorMessage (CC_FILE_ERROR err, const QString &action, const QString &filename)
	Displays (to console) the message corresponding to a given error code. More...

static bool	CheckForSpecialChars (const QString &filename)
	Returns whether special characters are present in the input string. More...

static void	ResetSesionCounter ()

static unsigned	IncreaseSesionCounter ()

static void	Register (Shared filter)
	Registers a new filter. More...

static Shared	GetFilter (const QString &fileFilter, bool onImport)
	Returns the filter corresponding to the given 'file filter'. More...

static Shared	FindBestFilterForExtension (const QString &ext)
	Returns the best filter (presumably) to open a given file extension. More...

static const FilterContainer &	GetFilters ()
	Returns the set of all registered filters. More...

static void	UnregisterAll ()
	Unregisters all filters. More...

Additional Inherited Members
Public Types inherited from FileIOFilter
enum	FilterFeature { NoFeatures = 0x0000 , Import = 0x00001 , Export = 0x0002 , BuiltIn = 0x0004 , DynamicInfo = 0x0008 }

using	Shared = QSharedPointer< FileIOFilter >
	Shared type. More...

using	FilterContainer = std::vector< FileIOFilter::Shared >
	Type of a I/O filters container. More...

Protected Member Functions inherited from FileIOFilter
	FileIOFilter (const FilterInfo &info)

void	setImportExtensions (const QStringList &extensions)

void	setImportFileFilterStrings (const QStringList &filterStrings)

void	setExportFileFilterStrings (const QStringList &filterStrings)

Static Protected Attributes inherited from FileIOFilter
static constexpr float	DEFAULT_PRIORITY = 25.0f

Detailed Description

CLOUDVIEWER dedicated binary point cloud I/O filter.

Definition at line 15 of file BinFilter.h.

Constructor & Destructor Documentation

◆ BinFilter()

BinFilter::BinFilter ( )

Member Function Documentation

◆ canSave()

virtual bool BinFilter::canSave	(	CV_CLASS_ENUM	type,
		bool &	multiple,
		bool &	exclusive
	)		const

overridevirtual

Returns whether this I/O filter can save the specified type of entity.

Parameters

type	entity type
multiple	whether the filter can save multiple instances of this entity at once
exclusive	whether the filter can only save this type of entity if selected or if it can be mixed with other types

Returns: whether the entity type can be saved

Reimplemented from FileIOFilter.

◆ GetDefaultExtension()

static QString BinFilter::GetDefaultExtension ( )

inlinestatic

Definition at line 23 of file BinFilter.h.

◆ GetFileFilter()

static QString BinFilter::GetFileFilter ( )

inlinestatic

Definition at line 20 of file BinFilter.h.

Referenced by ccCommandLineParser::exportEntity(), and PovFilter::saveToFile().

◆ GetLastSavedFileVersion()

static short BinFilter::GetLastSavedFileVersion ( )

static

Returns the last saved file version.

◆ loadFile()

virtual CC_FILE_ERROR BinFilter::loadFile	(	const QString &	filename,
		ccHObject &	container,
		LoadParameters &	parameters
	)

overridevirtual

Loads one or more entities from a file.

This method must be implemented by children classes.

Parameters

filename	file to load
container	container to store loaded entities
parameters	generic loading parameters

Returns: error

Reimplemented from FileIOFilter.

◆ LoadFileV1()

static CC_FILE_ERROR BinFilter::LoadFileV1	(	QFile &	in,
		ccHObject &	container,
		unsigned	nbScansTotal,
		const LoadParameters &	parameters
	)

static

old style BIN loading

◆ LoadFileV2()

static CC_FILE_ERROR BinFilter::LoadFileV2	(	QFile &	in,
		ccHObject &	container,
		int	flags,
		bool	parallel,
		QWidget *	parentWidget = `nullptr`
	)

static

new style BIN loading

Parameters

in	the file to read from
container	the container to load the entities into
flags	the deserialization flags
parallel	whether to use parallel loading
parentWidget	the parent widget for progress dialogs

Returns: the error code

◆ SaveFileV2()

static CC_FILE_ERROR BinFilter::SaveFileV2	(	QFile &	out,
		ccHObject *	object
	)

static

new style BIN saving

◆ saveToFile()

virtual CC_FILE_ERROR BinFilter::saveToFile	(	ccHObject *	entity,
		const QString &	filename,
		const SaveParameters &	parameters
	)

overridevirtual

Saves an entity (or a group of) to a file.

This method must be implemented by children classes.

Parameters

entity	entity (or group of) to save
filename	filename
parameters	generic saving parameters

Returns: error

Reimplemented from FileIOFilter.

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

/root/ACloudViewer/libs/CV_io/include/BinFilter.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinFilter()

Member Function Documentation

◆ canSave()

◆ GetDefaultExtension()

◆ GetFileFilter()

◆ GetLastSavedFileVersion()

◆ loadFile()

◆ LoadFileV1()

◆ LoadFileV2()

◆ SaveFileV2()

◆ saveToFile()