Example Poker VN Scene

src/dawn/visualnovel/ui/CMakeLists.txt

@@ -6,5 +6,6 @@
 # Sources
 target_sources(${DAWN_TARGET_NAME}
   PRIVATE
+    VisualNovelFader.cpp
     VisualNovelTextbox.cpp
 )

src/dawn/visualnovel/ui/VisualNovelFader.cpp

@@ -0,0 +1,25 @@
+// Copyright (c) 2022 Dominic Masters
+// 
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+
+#include "VisualNovelFader.hpp"
+
+using namespace Dawn;
+
+VisualNovelFader::VisualNovelFader(UICanvas *canvas) : UISprite(canvas) {
+
+}
+
+VisualNovelFader * VisualNovelFader::create(UICanvas *canvas) {
+  assertNotNull(canvas);
+  
+  auto item = canvas->addElement<VisualNovelFader>();
+  item->setTransform(
+    UI_COMPONENT_ALIGN_STRETCH, UI_COMPONENT_ALIGN_STRETCH,
+    glm::vec4(0, 0, 0, 0),
+    0.0f
+  );
+  item->color = COLOR_BLACK_TRANSPARENT;
+  return item;
+}

src/dawn/visualnovel/ui/VisualNovelFader.hpp

@@ -12,18 +12,21 @@ namespace Dawn {
     private:
 
     public:
-      static VisualNovelFader * create(UICanvas *canvas) {
-        assertNotNull(canvas);
-        auto item = canvas->addElement<VisualNovelFader>();
-        item->setTransform(
-          UI_COMPONENT_ALIGN_STRETCH, UI_COMPONENT_ALIGN_STRETCH,
-          glm::vec4(0, 0, 0, 0),
-          0.0f
-        );
-        return item;
-      }
+      /**
+       * Quickly create a visual novel fader.
+       * 
+       * @param canvas Canvas the fader belongs to.
+       * @return Created VN Fader.
+       */
+      static VisualNovelFader * create(UICanvas *canvas);
 
-      VisualNovelFader(UICanvas *canvas) : UISprite(canvas) {
-      }
+      /**
+       * Construct a new Visual Novel Fader. VN Fader is just a sprite that is
+       * easily found by the VN Manager for the purpose of adding transitions to
+       * a VN scene.
+       * 
+       * @param canvas Canvas for this component.
+       */
+      VisualNovelFader(UICanvas *canvas);
   };
 }