Geometry.h

#pragma once

/* <editor-fold desc="MIT License">

Copyright(c) 2018 Robert Osfield

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

</editor-fold> */

#include <vsg/commands/Draw.h>
#include <vsg/nodes/Node.h>
#include <vsg/state/BufferInfo.h>

namespace vsg
{

    /// Geometry node is a class that provides vertex arrays, optional index array and a list of draw commands
    /// that are recorded to command buffer during RecordTraversal. Provides a lower CPU overhead
    /// compared to the equivalent functionality of adding individual commands:
    ///     auto group = vsg::Commands::create();
    ///     group->addChild(vsg::BindVertexBuffers::create(arrays));
    ///     group->addChild(vsg::BindIndexBuffer::create(indices));
    ///     group->addChild(vsg::DrawIndexed(number_vertices, 1, 0, 0));
    class VSG_DECLSPEC Geometry : public Inherit<Command, Geometry>
    {
    public:
        Geometry();
        Geometry(const Geometry& rhs, const CopyOp& copyop = {});

        using DrawCommands = std::vector<ref_ptr<Command>>;

        // settings
        uint32_t firstBinding = 0;
        BufferInfoList arrays;
        ref_ptr<BufferInfo> indices;
        DrawCommands commands;

        void assignArrays(const DataList& in_arrays);
        void assignIndices(ref_ptr<vsg::Data> in_indices);

    public:
        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return Geometry::create(*this, copyop); }
        int compare(const Object& rhs) const override;

        void read(Input& input) override;
        void write(Output& output) const override;

        void compile(Context& context) override;
        void record(CommandBuffer& commandBuffer) const override;

    protected:
        virtual ~Geometry();

        vk_buffer<VulkanArrayData> _vulkanData;
        VkIndexType indexType = VK_INDEX_TYPE_UINT16;
    };
    VSG_type_name(vsg::Geometry)

} // namespace vsg