model_import_queue.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program 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.
 *
 * This program 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 this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-3.0.html
 */
 
#ifndef MODEL_IMPORT_QUEUE_H
#define MODEL_IMPORT_QUEUE_H
 
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
 
#include <plugins/3dapi/model_import.h>
 
namespace S3D
{
class KICAD_3D_IMPORT_API MODEL_IMPORT_QUEUE
{
public:
    using COMPLETION = std::function<void( std::uint64_t aGeneration, MODEL_IMPORT_RESULT aResult )>;
 
    MODEL_IMPORT_QUEUE();
    ~MODEL_IMPORT_QUEUE();
 
    MODEL_IMPORT_QUEUE( const MODEL_IMPORT_QUEUE& ) = delete;
    MODEL_IMPORT_QUEUE& operator=( const MODEL_IMPORT_QUEUE& ) = delete;

    std::uint64_t Submit( std::string aFileName, const MODEL_IMPORT_OPTIONS& aOptions, COMPLETION aCompletion );

    void Cancel();

    void Shutdown();

    std::uint64_t CurrentGeneration() const;
 
private:
    struct STATE;
 
    std::shared_ptr<STATE> m_state;
};
} // namespace S3D
 
#endif // MODEL_IMPORT_QUEUE_H