VulkanBitflagObject.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Graphics
File: VulkanBitflagObject
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDefines.h"
#include "Design/Headers/Geometry.h"
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Stores bools to be sent to both the Vertex and Fragment shaders in the Vulkan space
    **/
    struct VulkanBitflagObject
    {
        enum ModelProperties
        {
              e_3D_selected
            , e_3D_focussed
            , e_orient_to_camera
            , e_follow_camera
            , e_scale_to_camera
        };
        enum class RenderProperties
        {
              e_parity
            , e_wireframe
            , e_use_custom_color
            , e_use_lighting
            , e_smooth_normals
            , e_use_texture_model_coord
            , e_use_linework_model_coord
        };
        VulkanBitflagObject()
            : flag{ 0,0,0,0 }
        {}
        VulkanBitflagObject(const VulkanBitflagObject& object)
        {
            flag[0] = object.flag[0];
            flag[1] = object.flag[1];
            flag[2] = object.flag[2];
            flag[3] = object.flag[3];
        }
        void set(const VertexProperty& property, bool value)
        {
            flag[0](cast<uint01>(property), value);
        }
        void setExtra(bool value)
        {
            flag[0](7, value);
        }
        void set(const ModelProperties& property, bool value)
        {
            flag[1](cast<uint01>(property), value);
        }
        [[nodiscard]] bool get(const ModelProperties& property) const
        {
            return flag[1][cast<uint01>(property)];
        }
        void setRenderProperty(RenderProperties property, bool value)
        {
            flag[2](cast<uint01>(property), value);
        }
        void setHasImage(uint01 type, bool has_image)
        {
            flag[3](type, has_image);
        }
        VulkanBitflagObject& operator=(const VulkanBitflagObject& object)
        {
            for (uint01 i = 0; i < 4; i++)
                flag[i] = object.flag[i];
            return *this;
        }
        bool operator==(const VulkanBitflagObject& object) const
        {
            return  flag[0] == object.flag[0]
                 && flag[1] == object.flag[1]
                 && flag[2] == object.flag[2]
                 && flag[3] == object.flag[3];
        }
        bool operator!=(const VulkanBitflagObject& object) const
        {
            return  flag[0] != object.flag[0]
                 || flag[1] != object.flag[1]
                 || flag[2] != object.flag[2]
                 || flag[3] != object.flag[3];
        }
        BitFlag flag[4];
    };
 
}