FlowEngine.h

Go to the documentation of this file.

/*
 *
 *                             C@@o         ____  _____   __ _
 *                        oC8@@@@@@@o      |___ \|  __ \ / _| |
 *                    o@@@@@@@@@@@@O         __) | |  | | |_| | _____      __
 *         O@O        8@@@@@@@@@O           |__ <| |  | |  _| |/ _ \ \ /\ / /
 *       o@@@@@@@O    OOOOOCo               ___) | |__| | | | | (_) \ V  V /
 *       C@@@@@@@@@@@@Oo                   |____/|_____/|_| |_|\___/ \_/\_/
 *          o8@@@@@@@@@@@@@@@@8OOCCCC
 *              oO@@@@@@@@@@@@@@@@@@@o          3Dflow s.r.l. - www.3dflow.net
 *                   oO8@@@@@@@@@@@@o           Copyright 2022
 *       oO88@@@@@@@@8OCo                       All Rights Reserved
 *  O@@@@@@@@@@@@@@@@@@@@@@@@@8OCCoooooooCCo
 *   @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@O
 *    @@@Oo            oO8@@@@@@@@@@@@@@@@8
 *
 */
 
#ifndef FLOWENGINE_H
#define FLOWENGINE_H
 
#pragma once
 
#include "CommonDef.h"
#include "LogListenerInterface.h"
#include "ProgressBarInterface.h"
#include "CameraInterface.h"
#include "SettingsInterface.h"
#include "BoundingBoxInterface.h"
#include "SparsePointCloudInterface.h"
#include "StereoPointCloudInterface.h"
#include "StereoMeshInterface.h"
#include "StereoTexturedMeshInterface.h"
#include "ControlPointConstraintInterface.h"
#include "CameraCalibrationInterface.h"
#include "CameraConstraintInterface.h"
#include "DistanceConstraintInterface.h"
#include "GaussianSplatsInterface.h"
#include "CamerasLoaderInterface.h"
#include "OrthophotoInterface.h"
#include "LicenseManager.h"
#include "ImageIO.h"
#include "Equirectangular.h"
#include "MarkerPrinter.h"
#include "ProjectedCoordinateSystemDB.h"
#include "ProjectedCoordinateSystemInterface.h"
#include "DynamicBufferInterface.h"
#include "LicenseInfoInterface.h"
#include "Utilities.h"
 
namespace FlowEngine
{
    class FlowEngineInterface
    {
        public:
 
            FLE_DLL virtual ~FlowEngineInterface() = default;
 
        public:
 
            FLE_DLL virtual Result computeStructureAndMotion( const SettingsInterface &settings,
                                                              ProgressBarInterface &progressBar,
                                                              LogListenerInterface &logListener,
                                                              Buffer< CameraInterface * > inOutCameras,
                                                              SparsePointCloudInterface &outPointCloud ) = 0;
 
            FLE_DLL virtual Result computeStructureAndMotionConstrained( const SettingsInterface &settings,
                                                                         ProgressBarInterface &progressBar,
                                                                         LogListenerInterface &logListener,
                                                                         Buffer< CameraInterface * > inOutCameras,
                                                                         ConstBuffer< ControlPointConstraintInterface * > inPointConstraints,
                                                                         ConstBuffer< CameraConstraintInterface * > inCameraConstraints,
                                                                         SparsePointCloudInterface &outPointCloud ) = 0;
 
            FLE_DLL virtual Result computeSparsePointCloudFromKnownPPM( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, SparsePointCloudInterface &outPointCloud ) = 0;
 
            FLE_DLL virtual Result performBundleAdjustment( const SettingsInterface &inSettings,
                                                            ProgressBarInterface &inProgressBar,
                                                            LogListenerInterface &inLogListener,
                                                            ConstBuffer< ControlPointConstraintInterface * > inPointConstraints,
                                                            ConstBuffer< CameraConstraintInterface * > inCameraConstraints,
                                                            ConstBuffer< DistanceConstraintInterface * > inDistanceConstraints,
                                                            Buffer< CameraInterface * > inOutCameras,
                                                            SparsePointCloudInterface &inOutPointCloud,
                                                            Buffer< unsigned char > inOutCamerasStatus ) = 0;
 
            FLE_DLL virtual Result computeDensePointCloud( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, const BoundingBoxInterface &boundingBox, Buffer< CameraInterface * > cameras, const SparsePointCloudInterface &pointCloud, StereoPointCloudInterface &outPointCloud ) = 0;
 
            FLE_DLL virtual Result computeDensePointCloudFromInputMesh( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, const BoundingBoxInterface &boundingBox, Buffer< CameraInterface * > cameras, const SparsePointCloudInterface &pointCloud, const StereoMeshInterface &stereoMesh, StereoPointCloudInterface &outPointCloud ) = 0;
 
            FLE_DLL virtual Result computeMesh( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, const BoundingBoxInterface &boundingBox, Buffer< CameraInterface * > cameras, const StereoPointCloudInterface &inStereoPointCloud, StereoMeshInterface &outStereoMesh ) = 0;
 
            FLE_DLL virtual Result computePhotoconsistency( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, StereoMeshInterface &inoutStereoMesh ) = 0;
 
            FLE_DLL virtual Result adaptMeshWithControlPoints( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< ControlPointConstraintInterface * > inStartingConstraints, Buffer< ControlPointConstraintInterface * > inDestinationConstraints, const StereoMeshInterface &inDestinationMesh, StereoMeshInterface &inoutStartingMesh ) = 0;
 
            FLE_DLL virtual Result adaptMeshWithOpticalFlow( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, const StereoMeshInterface &inPivotMesh, const StereoMeshInterface &inDestinationMesh, StereoMeshInterface &inoutStartingMesh ) = 0;
 
            FLE_DLL virtual Result morphMesh( const SettingsInterface &settings,
                                              ProgressBarInterface &progressBar,
                                              LogListenerInterface &logListener,
                                              const StereoMeshInterface &dataMesh,
                                              StereoMeshInterface &inoutTemplateMesh ) = 0;
 
            FLE_DLL virtual Result computeTexturedMesh( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, const StereoMeshInterface &mesh, StereoTexturedMeshInterface &outStereoTexturedMesh ) = 0;
 
            FLE_DLL virtual Result computeTexturedMesh( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, const StereoMeshInterface &mesh, ConstBuffer< TexCoords > uvCoords, StereoTexturedMeshInterface &outStereoTexturedMesh ) = 0;
 
            FLE_DLL virtual Result computeOrthophoto( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, const StereoMeshInterface &mesh, ConstBuffer< double > transform, OrthophotoInterface &outOrthophoto ) = 0;
 
            FLE_DLL virtual Result computeOrthophotoFromPoints( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, const StereoPointCloudInterface &pointCloud, ConstBuffer< double > transform, OrthophotoInterface &outOrthophoto ) = 0;
 
            FLE_DLL virtual Result detectMarkers( const SettingsInterface &settings,
                                                  ProgressBarInterface &progressBar,
                                                  LogListenerInterface &logListener,
                                                  Buffer< CameraInterface * > cameras,
                                                  ConstStringBuffer tagFamily,
                                                  double subsampling,
                                                  double blur,
                                                  int *minimumPoints,
                                                  double *maximumReprojectionError,
                                                  double *minimumAngle,
                                                  Buffer< ControlPointConstraintInterface * > inOutPoints,
                                                  Buffer< int > inOutIds ) = 0;
 
            FLE_DLL virtual Result recomputeVisibility( const SettingsInterface &settings,
                                                        ProgressBarInterface &progressBar,
                                                        LogListenerInterface &logListener,
                                                        Buffer< CameraInterface * > cameras,
                                                        bool updateProperties,
                                                        Index seedPoints,
                                                        bool keepOnlySeedPoints,
                                                        StereoPointCloudInterface &inOutPoints ) = 0;
 
            FLE_DLL virtual Result recomputeVisibility( const SettingsInterface &settings, ProgressBarInterface &progressBar, LogListenerInterface &logListener, Buffer< CameraInterface * > cameras, bool updateProperties, StereoMeshInterface &inOutMesh ) = 0;
 
            FLE_DLL virtual Result computeAndExportLodTexturedMesh( const SettingsInterface &settings,
                                                                    ProgressBarInterface &progressBar,
                                                                    LogListenerInterface &logListener,
                                                                    const StereoMeshInterface &mesh,
                                                                    ConstStringBuffer outputDirectory,
                                                                    ConstStringBuffer format,
                                                                    ConstStringBuffer textureFormat,
                                                                    int numberOfTiles,
                                                                    int targetMaxVerticesPerTile,
                                                                    int numberOfLevels,
                                                                    double decimationFactor,
                                                                    double textureDecimationFactor,
                                                                    bool useLocalCoordinates ) = 0;
 
            FLE_DLL virtual Result computePointClassification( const SettingsInterface &settings,
                                                               ProgressBarInterface &progressBar,
                                                               LogListenerInterface &logListener,
                                                               const StereoPointCloudInterface &pointCloud,
                                                               std::uint32_t categories,
                                                               Buffer< PointClassification > outClassifications ) = 0;
 
            FLE_DLL virtual Result computePointClassification( const SettingsInterface &settings,
                                                               ProgressBarInterface &progressBar,
                                                               LogListenerInterface &logListener,
                                                               const StereoPointCloudInterface &pointCloud,
                                                               ConstStringBuffer modelFilePath,
                                                               Buffer< PointClassification > outClassifications ) = 0;
 
            FLE_DLL virtual Result computePointClassification( const SettingsInterface &settings,
                                                               ProgressBarInterface &progressBar,
                                                               LogListenerInterface &logListener,
                                                               const StereoMeshInterface &mesh,
                                                               std::uint32_t categories,
                                                               Buffer< PointClassification > outClassifications ) = 0;
 
            FLE_DLL virtual Result computePointClassification( const SettingsInterface &settings,
                                                               ProgressBarInterface &progressBar,
                                                               LogListenerInterface &logListener,
                                                               const StereoMeshInterface &mesh,
                                                               ConstStringBuffer modelFilePath,
                                                               Buffer< PointClassification > outClassifications ) = 0;
 
            FLE_DLL virtual Result computeAutomaticMasking( const SettingsInterface &settings,
                                                            ProgressBarInterface &progressBar,
                                                            LogListenerInterface &logListener,
                                                            Buffer< CameraInterface * > inOutCameras,
                                                            ConstStringBuffer modelFilePath ) = 0;
 
            FLE_DLL virtual Result computeDepthMaps( const SettingsInterface &settings,
                                                     ProgressBarInterface &progressBar,
                                                     LogListenerInterface &logListener,
                                                     Buffer< CameraInterface * > cameras,
                                                     StereoMeshInterface &targetMesh,
                                                     bool removeRadialDistortion,
                                                     bool autoFillUnknownRegions,
                                                     Buffer< Image > inOutDepthMaps ) = 0;
 
            FLE_DLL virtual Result computeGaussianSplats( const SettingsInterface &settings,
                                                          ProgressBarInterface &progressBar,
                                                          LogListenerInterface &logListener,
                                                          const BoundingBoxInterface &inBoundingBox,
                                                          Buffer< CameraInterface * > cameras,
                                                          const StereoPointCloudInterface &stereoPointCloud,
                                                          GaussianSplatsInterface &outGaussianSplat ) = 0;
 
        public:
 
            FLE_DLL virtual Result abort() = 0;
 
            FLE_DLL virtual Result pause() = 0;
 
            FLE_DLL virtual Result resume() = 0;
 
            FLE_DLL virtual Result getVersion( StringBuffer outVersion ) const = 0;
 
            FLE_DLL virtual void getVersion( Version &outVersion ) const = 0;
 
            FLE_DLL virtual Size getVersionLength() const = 0;
 
            FLE_DLL virtual Result isLatestVersion() const = 0;
 
            FLE_DLL virtual bool isFreeVersion() const = 0;
 
        public:
 
            FLE_DLL virtual Index getGraphicsDeviceCount() const = 0;
 
            FLE_DLL virtual GraphicsDeviceID getGraphicsDevice( Index index ) const = 0;
 
            FLE_DLL virtual Result getGraphicsDeviceInfo( GraphicsDeviceID device,
                                                          GraphicsDeviceInfo &outInfo ) const = 0;
 
            FLE_DLL virtual Result selectGraphicsDevices( SettingsInterface &settings,
                                                          ConstBuffer< GraphicsDeviceID > devices ) const = 0;
 
        public:
 
            FLE_DLL virtual void setMaxNumberOfCores( Size numberOfCores ) = 0;
 
            FLE_DLL virtual void setMemoryLimit( Size memoryLimit ) = 0;
 
        public:
 
            FLE_DLL virtual void setLogTimestamp( bool logTimeStamp ) = 0;
    };
 
    FLOWENGINE_FACTORY FlowEngineInterface *CreateFlowEngine();
 
    FLOWENGINE_FACTORY void DestroyFlowEngineObject( FlowEngineInterface *flowEngine );
 
    FLOWENGINE_FACTORY void DestroyFlowEngine( FlowEngineInterface *flowEngine );
 
    namespace Detail
    {
        template< >
        struct Destroyer< FlowEngineInterface >
        {
            static void destroy( FlowEngineInterface *flowEngine )
            {
                DestroyFlowEngineObject( flowEngine );
            }
        };
    }
 
    using UniqueFlowEnginePtr = Detail::UniquePtr< FlowEngineInterface >;
}
 
#endif