foamGltfBase.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2021-2025 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Namespace
    Foam::glTF
 
Description
    Namespace for handling glTF creation.
    https://www.khronos.org/registry/glTF/
 
Class
    Foam::glTF::base
 
Description
    Base class for glTF entities
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_gltf_base_H
#define Foam_gltf_base_H
 
#include "word.H"
#include "label.H"
#include "Ostream.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace glTF
{
 
    enum class componentTypes : int
    {
        BYTE            = 5120, 
        UNSIGNED_BYTE   = 5121, 
        SHORT           = 5122, 
        UNSIGNED_SHORT  = 5123, 
        UNSIGNED_INT    = 5125, 
        FLOAT           = 5126  
    };
 
    // accessor
    enum class dataTypes
    {
        SCALAR, 
        VEC2,   
        VEC3,   
        VEC4,   
        MAT2,   
        MAT3,   
        MAT4    
    };
 
    enum class attributeTypes
    {
        POSITION,   
        NORMAL,     
        TANGENT,    
        TEXCOORD_0, 
        TEXCOORD_1, 
        COLOR_0,    
        JOINTS_0,   
        WEIGHTS_0   
    };
 
    // bufferView
    enum class targetTypes : int
    {
        ARRAY_BUFFER = 34962, 
        ELEMENT_ARRAY_BUFFER = 34963 
    };
 
    enum class primitiveModes : int
    {
        POINTS = 0,
        LINES = 1,
        LINE_LOOP = 2,
        LINE_STRIP = 3,
        TRIANGLES = 4,
        TRIANGLE_STRIP = 5,
        TRIANGLE_FAN = 6
    };
 
    //- Helper function to return the enum value
    template<class Type, class = std::enable_if_t<std::is_enum_v<Type>>>
    constexpr auto key(const Type& t) noexcept
    {
        return static_cast<std::underlying_type_t<Type>>(t);
    }
 
 
/*---------------------------------------------------------------------------*\
                          Class base Declaration
\*---------------------------------------------------------------------------*/
 
class base
{
protected:
 
    // Protected Data
 
        //- Name
        word name_;
 
        //- ID
        label id_;
 
 
public:
 
    // Constructors
 
        //- Default construct
        base()
        :
            id_(-1)
        {}
 
        //- Construct with name
        explicit base(const word& name)
        :
            name_(name),
            id_(-1)
        {}
 
 
    //- Destructor
    ~base() = default;
 
 
    // Member Functions
 
        //- Return access to the ID
        label& id() noexcept
        {
            return id_;
        }
 
        //- Return const access to the name
        const word& name() const noexcept
        {
            return name_;
        }
 
        //- Write
        void write(Ostream& os) const
        {
            os  << "," << nl
                << indent << "\"name\" : \"" << name_ << "\"";
        }
 
 
    // Member Operators
 
        void operator=(const base& gltf)
        {
            name_ = gltf.name_;
            id_ = gltf.id_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace glTF
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //