qCC_io version 2.13.alpha (Qt) - 31 May 2022
CloudCompare standard I/O filters (file readers & writers)
Public Member Functions | Static Public Member Functions | List of all members
BinFilter Class Reference

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

#include <BinFilter.h>

Inheritance diagram for BinFilter:
Inheritance graph
[legend]
Collaboration diagram for BinFilter:
Collaboration graph
[legend]

Public Member Functions

CC_FILE_ERROR loadFile (const QString &filename, ccHObject &container, LoadParameters &parameters) override
 Loads one or more entities from a file. More...
 
bool canSave (CC_CLASS_ENUM type, bool &multiple, bool &exclusive) const override
 Returns whether this I/O filter can save the specified type of entity. More...
 
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
QCC_IO_LIB_API bool importSupported () const
 Returns whether this I/O filter can import files.
 
QCC_IO_LIB_API bool exportSupported () const
 Returns whether this I/O filter can export files.
 
QCC_IO_LIB_API const QStringList & getFileFilters (bool onImport) const
 Returns the file filter(s) for this I/O filter. More...
 
QCC_IO_LIB_API QString getDefaultExtension () const
 Returns the default file extension.
 
virtual CC_FILE_ERROR loadFile (const QString &filename, ccHObject &container, LoadParameters &parameters)
 Loads one or more entities from a file. More...
 
virtual CC_FILE_ERROR saveToFile (ccHObject *entity, const QString &filename, const SaveParameters &parameters)
 Saves an entity (or a group of) to a file. More...
 
virtual bool canSave (CC_CLASS_ENUM type, bool &multiple, bool &exclusive) const
 Returns whether this I/O filter can save the specified type of entity. More...
 
virtual void unregister ()
 Called when the filter is unregistered. More...
 

Static Public Member Functions

static QString GetFileFilter ()
 
static QString GetDefaultExtension ()
 
static CC_FILE_ERROR LoadFileV1 (QFile &in, ccHObject &container, unsigned nbScansTotal, const LoadParameters &parameters)
 old style BIN loading
 
static CC_FILE_ERROR LoadFileV2 (QFile &in, ccHObject &container, int flags)
 new style BIN loading
 
static CC_FILE_ERROR SaveFileV2 (QFile &out, ccHObject *object)
 new style BIN saving
 
- Static Public Member Functions inherited from FileIOFilter
static QCC_IO_LIB_API QStringList ImportFilterList ()
 
static QCC_IO_LIB_API 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 QCC_IO_LIB_API 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 QCC_IO_LIB_API CC_FILE_ERROR SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, Shared filter)
 Saves an entity (or a group of) to a specific file thanks to a given filter. More...
 
static QCC_IO_LIB_API CC_FILE_ERROR SaveToFile (ccHObject *entities, const QString &filename, const SaveParameters &parameters, const QString &fileFilter)
 Saves an entity (or a group of) to a specific file thanks to a given filter. More...
 
static QCC_IO_LIB_API bool HandleGlobalShift (const CCVector3d &P, CCVector3d &Pshift, bool &preserveCoordinateShift, LoadParameters &loadParameters, bool useInputCoordinatesShiftIfPossible=false)
 Shortcut to the ccGlobalShiftManager mechanism specific for files. More...
 
static QCC_IO_LIB_API 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 QCC_IO_LIB_API bool CheckForSpecialChars (const QString &filename)
 Returns whether special characters are present in the input string.
 
static QCC_IO_LIB_API void ResetSesionCounter ()
 Indicates to the I/O filters that a new loading/saving session has started (for "Apply all" buttons for instance)
 
static QCC_IO_LIB_API unsigned IncreaseSesionCounter ()
 Indicates to the I/O filters that a new loading/saving action has started. More...
 
static QCC_IO_LIB_API void InitInternalFilters ()
 Init internal filters (should be called once)
 
static QCC_IO_LIB_API void Register (Shared filter)
 Registers a new filter.
 
static QCC_IO_LIB_API Shared GetFilter (const QString &fileFilter, bool onImport)
 Returns the filter corresponding to the given 'file filter'.
 
static QCC_IO_LIB_API Shared FindBestFilterForExtension (const QString &ext)
 Returns the best filter (presumably) to open a given file extension.
 
static QCC_IO_LIB_API const FilterContainerGetFilters ()
 Returns the set of all registered filters.
 
static QCC_IO_LIB_API 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.
 
using FilterContainer = std::vector< FileIOFilter::Shared >
 Type of a I/O filters container.
 
- Protected Member Functions inherited from FileIOFilter
QCC_IO_LIB_API 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

CloudCompare dedicated binary point cloud I/O filter.

Member Function Documentation

◆ canSave()

bool BinFilter::canSave ( CC_CLASS_ENUM  type,
bool &  multiple,
bool &  exclusive 
) const
overridevirtual

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

Parameters
typeentity type
multiplewhether the filter can save multiple instances of this entity at once
exclusivewhether 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.

◆ loadFile()

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
filenamefile to load
containercontainer to store loaded entities
parametersgeneric loading parameters
Returns
error

Reimplemented from FileIOFilter.

◆ saveToFile()

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
entityentity (or group of) to save
filenamefilename
parametersgeneric saving parameters
Returns
error

Reimplemented from FileIOFilter.


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