RenderComponent.h

#pragma once
 
#include "../../Flags.h"
 
#include "Foundation/ComponentModel/Component.h"
 
namespace Cogs
{
  namespace Core
  {
    constexpr uint32_t NoObjectId = 0;
 
    enum struct RenderFlags : uint32_t
    {
      None = 0,
 
      SelfVisibility = 1 << 0,
      ParentVisibility = 1 << 1,
      SpecificVisibility = 1 << 2,
 
      SelfPickable = 1 << 3,
      ParentPickable = 1 << 4,
 
      CastShadows = 1 << 5,
 
      CustomMaterial = 1 << 6,
 
      ForcePickable = 1 << 7,
 
      DisableCulling = 1 << 8,
 
      Default = SelfVisibility | ParentVisibility | SpecificVisibility | SelfPickable | ParentPickable | CastShadows,
      DefaultNoShadows = SelfVisibility | ParentVisibility | SpecificVisibility | SelfPickable | ParentPickable,
    };
 
    ENABLE_ENUM_FLAGS(RenderFlags);
 
    enum struct RenderLayers : uint32_t
    {
      None = 0u,
 
      Default = 1u << 0,
      Ocean = 1u << 1,
      Annotations = 1u << 2,
      Sky = 1u << 3,
      Overlay = 1u << 4,
      Controllers = 1u << 5,
      AllStandard = 0x0000003Fu,
 
      Reserved0 = 1u << 6,
      Reserved1 = 1u << 7,
      Reserved2 = 1u << 8,
      Reserved3 = 1u << 9,
      Reserved4 = 1u << 10,
      Reserved5 = 1u << 11,
      AllReserved = 0x00000FC0u,
 
      Custom0 = 1u << 12,
      Custom1 = 1u << 13,
      Custom2 = 1u << 14,
      Custom3 = 1u << 15,
      Custom4 = 1u << 16,
      Custom5 = 1u << 17,
      Custom6 = 1u << 18,
      Custom7 = 1u << 19,
      Custom8 = 1u << 20,
      Custom9 = 1u << 21,
      Custom10 = 1u << 22,
      Custom11 = 1u << 23,
      Custom12 = 1u << 24,
      Custom13 = 1u << 25,
      Custom14 = 1u << 26,
      Custom15 = 1u << 27,
      Custom16 = 1u << 28,
      Custom17 = 1u << 29,
      Custom18 = 1u << 30,
      Custom19 = 1u << 31,
      AllCustom = 0xFFFFF000u,
 
      All = 0xFFFFFFFFu
    };
 
    ENABLE_ENUM_FLAGS(RenderLayers);
 
    class RenderComponent : public ComponentModel::Component
    {
    public:
      static void registerType();
 
      struct LodData
      {
        uint8_t selectedLod = 0;
        uint8_t numLods = 0;
        uint8_t currentLod = 0;
        // Fractional component of the LoD represented as a normalized unsigned byte.
        uint8_t lodFraction = 0;
      } lod;
 
      RenderLayers layer = RenderLayers::Default;
 
      int32_t drawOrder = 0;
 
      RenderFlags renderFlags = RenderFlags::Default;
 
      uint32_t objectId = NoObjectId;
 
      constexpr void setRenderFlag(RenderFlags flag) { renderFlags |= flag; }
 
      constexpr void setRenderFlag(RenderFlags flag, bool status) {
        if (status) {
          setRenderFlag(flag);
        } else {
          unsetRenderFlag(flag);
        }
      }
 
      constexpr void unsetRenderFlag(RenderFlags flag) { renderFlags &= ~flag; }
 
      constexpr bool isRenderFlagSet(RenderFlags flag) const { return (renderFlags & flag) == flag; }
 
      constexpr bool isRenderFlagsSet(RenderFlags flags) const { return (renderFlags & flags) == flags; }
 
      constexpr void setVisible(bool visible)
      {
        setRenderFlag(RenderFlags::SpecificVisibility, visible);
      }
 
      constexpr bool isVisibleInLayer(RenderLayers layerMask) const
      {
        return ((layerMask & this->layer) != RenderLayers::None) && isVisible();
      }
 
      constexpr bool isVisible() const
      {
        return isRenderFlagsSet(RenderFlags::SelfVisibility |
                                RenderFlags::ParentVisibility |
                                RenderFlags::SpecificVisibility);
      }
 
      constexpr bool isPickable() const
      {
        return isRenderFlagsSet(RenderFlags::SelfPickable | RenderFlags::ParentPickable) && isVisible();
      }
 
      constexpr bool castShadows() const
      {
        return isRenderFlagsSet(RenderFlags::CastShadows);
      }
 
      constexpr bool disableCulling() const
      {
        return isRenderFlagsSet(RenderFlags::DisableCulling);
      }
 
      constexpr bool customMaterial() const
      {
        return isRenderFlagSet(RenderFlags::CustomMaterial);
      }
 
      ComponentModel::ComponentHandle clipShapeComponent = ComponentModel::ComponentHandle::Empty();
    };
  }
}
 
template<> inline Cogs::StringView getName<Cogs::Core::RenderFlags>() { return "RenderFlags"; }
template<> inline Cogs::StringView getName<Cogs::Core::RenderLayers>() { return "RenderLayers"; }
template<> inline Cogs::StringView getName<Cogs::Core::RenderComponent>() { return "RenderComponent"; }