CommonDef.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 FLOWENGINECOMMONDEF_H
#define FLOWENGINECOMMONDEF_H
 
#pragma once
 
#if defined( WIN32 )
#define FLE_DLL __declspec( dllexport )
#elif defined( __LINUX__ )
#define FLE_DLL __attribute__( ( visibility( "default" ) ) )
#else
#error "FlowEngine not supported on this platform!"
#endif
 
#define FLOWENGINE_FACTORY extern "C" FLE_DLL
 
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <string>
#include <vector>
#include <cassert>
 
namespace FlowEngine
{
    enum class Result : std::size_t
    {
        Success = 0,
 
        FeatureNotAvailable,
 
        GenericError,
 
        InvalidArgument,
 
        FileNotFound,
 
        BufferTooSmall,
 
        GenericIOError,
 
        ProcessNotRunning,
 
        NewVersionAvailable,
 
        OutOfMemoryError,
 
        DiskWriteError,
 
        PreconditionNotMet,
 
        UnsupportedVersion,
 
        LicenseCheckFailed,
    };
 
    using Index = std::ptrdiff_t;
 
    using Size = std::size_t;
 
    using ColorComponent = std::uint8_t;
 
    using ColorComponent32 = float;
 
    using ReconstructionID = unsigned int;
 
    template< typename T >
    struct Buffer
    {
        T *data = nullptr;
 
        Size count = 0;
 
        Buffer() = default;
 
        Buffer( T *d, Size s )
            : data( d )
            , count( s )
        { }
 
        template< std::size_t N >
        Buffer( T( &fixedSizeArray )[ N ] )
            : data( fixedSizeArray )
            , count( N )
        { }
 
        Buffer( std::vector< T > &v )
            : data( v.empty() ? nullptr : v.data() )
            , count( v.empty() ? 0 : v.size() )
        { }
 
        Buffer( std::vector< T > &&v ) = delete;
 
        explicit operator bool() const
        {
            return data != nullptr && count != 0;
        }
 
        T *begin()
        {
            assert( data );
            return data;
        }
 
        T *end()
        {
            assert( data );
            return data + count;
        }
 
        T &operator []( std::size_t index )
        {
            assert( data );
            assert( index < count );
            return data[ index ];
        }
 
        const T &operator []( std::size_t index ) const
        {
            assert( data );
            assert( index < count );
            return data[ index ];
        }
    };
 
    template< typename T >
    struct ConstBuffer
    {
        const T *data = nullptr;
 
        Size count = 0;
 
        ConstBuffer() = default;
 
        ConstBuffer( const T *d, Size s )
            : data( d )
            , count( s )
        { }
 
        template< std::size_t N >
        ConstBuffer( const T( &fixedSizeArray )[ N ] )
            : data( fixedSizeArray )
            , count( N )
        { }
 
        ConstBuffer( const std::vector< T > &v )
            : data( v.empty() ? nullptr : v.data() )
            , count( v.empty() ? 0 : v.size() )
        { }
 
        ConstBuffer( std::vector< T > &&v ) = delete;
 
        explicit operator bool() const
        {
            return data != nullptr;
        }
 
        const T *begin() const
        {
            assert( data );
            return data;
        }
 
        const T *end() const
        {
            assert( data );
            return data + count;
        }
 
        const T &operator []( std::size_t index ) const
        {
            assert( data );
            assert( index < count );
            return data[ index ];
        }
    };
 
    template< >
    struct Buffer< char >
    {
        char *data = nullptr;
 
        Size count = 0;
 
        Buffer() = default;
 
        Buffer( std::string &str )
            : data( &str[ 0 ] )
            , count( str.size() )
        { }
 
        Buffer( char *data, Size count )
            : data( data )
            , count( count )
        { }
 
        Buffer( std::vector< char > &v )
            : data( v.empty() ? nullptr : v.data() )
            , count( v.empty() ? 0 : v.size() )
        { }
 
        Buffer( std::string &&str ) = delete;
 
        explicit operator bool() const
        {
            return data != nullptr && count != 0;
        }
    };
 
    template< >
    struct ConstBuffer< char >
    {
        const char *data = nullptr;
 
        Size count = 0;
 
        ConstBuffer() = default;
 
        ConstBuffer( const std::string &str )
            : data( str.data() )
            , count( str.size() )
        { }
 
        ConstBuffer( std::string &&str ) = delete;
 
        ConstBuffer( const char *str )
            : data( str )
            , count( std::strlen( str ) )
        { }
 
        ConstBuffer( const char *data, Size count )
            : data( data )
            , count( count )
        { }
 
        ConstBuffer( const std::vector< char > &v )
            : data( v.empty() ? nullptr : v.data() )
            , count( v.empty() ? 0 : v.size() )
        { }
 
        explicit operator bool() const
        {
            return data != nullptr && count != 0;
        }
    };
 
    using StringBuffer      = Buffer< char >;
    using ConstStringBuffer = ConstBuffer< char >;
 
    struct Version final
    {
        int major;
 
        int minor;
 
        inline bool isSameAs( const Version &other ) const
        {
            return major == other.major && minor == other.minor;
        }
 
        inline bool isOlderThan( const Version &other ) const
        {
            if ( major < other.major )
                return true;
 
            if ( major > other.major )
                return false;
 
            return minor < other.minor;
        }
    };
 
    struct Point3
    {
        double x;
 
        double y;
 
        double z;
    };
 
    struct Point2
    {
        double x;
 
        double y;
    };
 
    struct Normal
    {
        float x;
 
        float y;
 
        float z;
    };
 
    struct Color
    {
        ColorComponent r;
 
        ColorComponent g;
 
        ColorComponent b;
    };
 
    struct PointColor32
    {
        ColorComponent32 r;
 
        ColorComponent32 g;
 
        ColorComponent32 b;
    };
 
    using Color32 = PointColor32;
 
    struct Triangle
    {
        Index idx0;
 
        Index idx1;
 
        Index idx2;
    };
 
    struct TexCoords
    {
        float u;
 
        float v;
    };
 
    struct Quaternion
    {
        Point3 axis;
 
        double angle;
    };
 
    struct Image
    {
        int width;
 
        int height;
 
        Buffer< Color32 > data;
    };
 
    enum class StandardAxis
    {
        X,
 
        Y,
 
        Z,
    };
 
    template< typename T, typename S >
    struct Pair
    {
        T first;
        S second;
    };
 
    struct DateTime
    {
        int year;
 
        int month;
 
        int day;
 
        int hour;
 
        int minute;
 
        int second;
    };
}
 
#endif