Radient: validate entity flags and relax child pagination

Author: TheMostDiligent

Radient/interface/RadientScene.h

@@ -46,7 +46,10 @@ DILIGENT_TYPED_ENUM(RADIENT_ENTITY_FLAGS, Uint32)
     /// Entity's own visibility flag. Effective visibility also depends on parent entities.
     RADIENT_ENTITY_FLAG_VISIBLE = 1u << 0u,
 
-    RADIENT_ENTITY_FLAG_LAST = RADIENT_ENTITY_FLAG_VISIBLE
+    RADIENT_ENTITY_FLAG_LAST = RADIENT_ENTITY_FLAG_VISIBLE,
+
+    /// All currently defined entity flags.
+    RADIENT_ENTITY_FLAGS_ALL = (RADIENT_ENTITY_FLAG_LAST << 1u) - 1u
 };
 DEFINE_FLAG_ENUM_OPERATORS(RADIENT_ENTITY_FLAGS)
 

Radient/src/RadientSceneState.cpp

@@ -49,6 +49,11 @@ bool IsBuiltInComponentType(const RadientComponentTypeID ComponentType)
             ComponentType == RADIENT_COMPONENT_TYPE_LIGHT);
 }
 
+bool IsValidEntityFlags(RADIENT_ENTITY_FLAGS Flags)
+{
+    return (Flags & ~RADIENT_ENTITY_FLAGS_ALL) == RADIENT_ENTITY_FLAG_NONE;
+}
+
 } // namespace
 
 const RadientSceneDesc& RadientSceneState::GetDesc() const
@@ -155,7 +160,7 @@ RADIENT_STATUS RadientSceneState::GetChildren(RadientEntityID Entity, Uint32 Sta
 
     const std::vector<entt::entity>& Children = m_Registry.get<HierarchyComponent>(E).Children;
     if (StartChild >= Children.size())
-        return RADIENT_STATUS_INVALID_ARGUMENT;
+        return RADIENT_STATUS_OK;
 
     NumChildrenWritten = std::min(ChildCount, static_cast<Uint32>(Children.size() - StartChild));
     for (Uint32 ChildIndex = 0; ChildIndex < NumChildrenWritten; ++ChildIndex)
@@ -256,6 +261,9 @@ RADIENT_STATUS RadientSceneState::CreateEntity(const RadientEntityDesc& Desc, Ra
 {
     Entity = InvalidRadientEntityID;
 
+    if (!IsValidEntityFlags(Desc.Flags))
+        return RADIENT_STATUS_INVALID_ARGUMENT;
+
     entt::entity Parent = entt::null;
     if (Desc.Parent != InvalidRadientEntityID)
     {
@@ -306,6 +314,9 @@ RADIENT_STATUS RadientSceneState::SetEntityFlags(RadientEntityID Entity, RADIENT
     if (E == entt::null)
         return RADIENT_STATUS_NOT_FOUND;
 
+    if (!IsValidEntityFlags(Flags))
+        return RADIENT_STATUS_INVALID_ARGUMENT;
+
     EntityStateComponent& State = m_Registry.get<EntityStateComponent>(E);
     if (State.Flags == Flags)
         return RADIENT_STATUS_NO_CHANGE;

Tests/IncludeTest/Radient/RadientSceneH_test.c

@@ -97,6 +97,8 @@ void RadientScene_C_TestMacros(IRadientScene* pScene)
     RadientCustomComponentData CustomComponent = {0};
     RADIENT_STATUS             Status          = RADIENT_STATUS_OK;
 
+    EntityFlags = RADIENT_ENTITY_FLAGS_ALL;
+
     IRadientScene_GetDesc(pScene);
     Status = IRadientScene_IsEntityAlive(pScene, Entity);
     Status = IRadientScene_GetEntityFlags(pScene, Entity, &EntityFlags);

Tests/IncludeTest/Radient/RadientSceneH_test.cpp

@@ -33,6 +33,8 @@ namespace
 
 using namespace Diligent;
 
+static_assert(static_cast<Uint32>(RADIENT_ENTITY_FLAG_LAST) == static_cast<Uint32>(RADIENT_ENTITY_FLAG_VISIBLE), "Unexpected RADIENT_ENTITY_FLAGS_ALL value");
+
 static_assert(sizeof(RADIENT_CAMERA_PROJECTION) == sizeof(Uint8), "Unexpected RADIENT_CAMERA_PROJECTION size");
 static_assert(static_cast<Uint8>(RADIENT_CAMERA_PROJECTION_PERSPECTIVE) == 0, "Unexpected RADIENT_CAMERA_PROJECTION_PERSPECTIVE value");
 static_assert(static_cast<Uint8>(RADIENT_CAMERA_PROJECTION_ORTHOGRAPHIC) == 1, "Unexpected RADIENT_CAMERA_PROJECTION_ORTHOGRAPHIC value");

Tests/RadientTest/src/RadientSceneStateTest.cpp

@@ -87,15 +87,29 @@ TEST(RadientSceneStateTest, GetEntityFlags)
 {
     RadientSceneState State;
 
+    const RADIENT_ENTITY_FLAGS InvalidEntityFlags =
+        static_cast<RADIENT_ENTITY_FLAGS>(static_cast<Uint32>(RADIENT_ENTITY_FLAGS_ALL) << 1u);
+
     RADIENT_ENTITY_FLAGS Flags = RADIENT_ENTITY_FLAG_VISIBLE;
     EXPECT_EQ(State.GetEntityFlags(1, Flags), RADIENT_STATUS_NOT_FOUND);
     EXPECT_EQ(Flags, RADIENT_ENTITY_FLAG_NONE);
 
+    RadientEntityDesc InvalidEntityDesc;
+    InvalidEntityDesc.Flags = InvalidEntityFlags;
+
+    RadientEntityID InvalidEntity = 123;
+    EXPECT_EQ(State.CreateEntity(InvalidEntityDesc, InvalidEntity), RADIENT_STATUS_INVALID_ARGUMENT);
+    EXPECT_EQ(InvalidEntity, InvalidRadientEntityID);
+
     RadientEntityID DefaultEntity = InvalidRadientEntityID;
     EXPECT_EQ(State.CreateEntity({}, DefaultEntity), RADIENT_STATUS_OK);
     EXPECT_EQ(State.GetEntityFlags(DefaultEntity, Flags), RADIENT_STATUS_OK);
     EXPECT_EQ(Flags, RADIENT_ENTITY_FLAG_VISIBLE);
 
+    EXPECT_EQ(State.SetEntityFlags(DefaultEntity, InvalidEntityFlags), RADIENT_STATUS_INVALID_ARGUMENT);
+    EXPECT_EQ(State.GetEntityFlags(DefaultEntity, Flags), RADIENT_STATUS_OK);
+    EXPECT_EQ(Flags, RADIENT_ENTITY_FLAG_VISIBLE);
+
     RadientEntityDesc HiddenEntityDesc;
     HiddenEntityDesc.Flags = RADIENT_ENTITY_FLAG_NONE;
 
@@ -342,7 +356,10 @@ TEST(RadientSceneStateTest, GetChildCountAndChildren)
     EXPECT_EQ(Children[0], Child1);
     EXPECT_EQ(Children[1], Child2);
 
-    EXPECT_EQ(State.GetChildren(Root, 3, 1, Children, NumChildrenWritten), RADIENT_STATUS_INVALID_ARGUMENT);
+    EXPECT_EQ(State.GetChildren(Root, 3, 1, Children, NumChildrenWritten), RADIENT_STATUS_OK);
+    EXPECT_EQ(NumChildrenWritten, 0u);
+
+    EXPECT_EQ(State.GetChildren(Root, 4, 1, Children, NumChildrenWritten), RADIENT_STATUS_OK);
     EXPECT_EQ(NumChildrenWritten, 0u);
 
     EXPECT_EQ(State.SetParent(Child1, InvalidRadientEntityID, True), RADIENT_STATUS_OK);