Add Rect class

Author: adazem009

CMakeLists.txt

@@ -50,6 +50,7 @@ target_sources(scratchcpp
     include/scratchcpp/keyevent.h
     include/scratchcpp/iimageformat.h
     include/scratchcpp/iimageformatfactory.h
+    include/scratchcpp/rect.h
 )
 
 add_library(zip SHARED

include/scratchcpp/rect.h

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "global.h"
+#include "spimpl.h"
+
+namespace libscratchcpp
+{
+
+class RectPrivate;
+
+/*! The Rect class represents a rectangle. */
+class LIBSCRATCHCPP_EXPORT Rect
+{
+    public:
+        Rect(double left, double top, double right, double bottom);
+        Rect();
+
+        double left() const;
+        void setLeft(double left);
+
+        double top() const;
+        void setTop(double top);
+
+        double right() const;
+        void setRight(double right);
+
+        double bottom() const;
+        void setBottom(double bottom);
+
+        double width() const;
+        double height() const;
+
+    private:
+        spimpl::impl_ptr<RectPrivate> impl;
+};
+
+} // namespace libscratchcpp

include/scratchcpp/sprite.h

@@ -8,6 +8,7 @@ namespace libscratchcpp
 {
 
 class ISpriteHandler;
+class Rect;
 class SpritePrivate;
 
 /*! \brief The Sprite class represents a Scratch sprite. */
@@ -62,6 +63,8 @@ class LIBSCRATCHCPP_EXPORT Sprite : public Target
         void setRotationStyle(const std::string &newRotationStyle);
         void setRotationStyle(const char *newRotationStyle);
 
+        Rect boundingRect() const;
+
     private:
         Target *dataSource() const override;
 

src/CMakeLists.txt

@@ -6,6 +6,9 @@ target_sources(scratchcpp
     scratchconfiguration.cpp
     scratchconfiguration_p.cpp
     scratchconfiguration_p.h
+    rect.cpp
+    rect_p.cpp
+    rect_p.h
 )
 
 add_subdirectory(blocks)

src/rect.cpp

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/rect.h>
+#include <cmath>
+#include "rect_p.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs Rect. */
+Rect::Rect(double left, double top, double right, double bottom) :
+    impl(spimpl::make_impl<RectPrivate>(left, top, right, bottom))
+{
+}
+
+/*! \copydoc Rect() */
+Rect::Rect() :
+    impl(spimpl::make_impl<RectPrivate>())
+{
+}
+
+/*! Returns the x-coordinate of the left edge. */
+double Rect::left() const
+{
+    return impl->left;
+}
+
+/*! Sets the x-coordinate of the left edge. */
+void Rect::setLeft(double left)
+{
+    impl->left = left;
+}
+
+/*! Returns the y-coordinate of the top edge. */
+double Rect::top() const
+{
+    return impl->top;
+}
+
+/*! Sets the y-coordinate of the top edge. */
+void Rect::setTop(double top)
+{
+    impl->top = top;
+}
+
+/*! Returns the x-coordinate of the right edge. */
+double Rect::right() const
+{
+    return impl->right;
+}
+
+/*! Sets the x-coordinate of the right edge. */
+void Rect::setRight(double right)
+{
+    impl->right = right;
+}
+
+/*! Returns the y-coordinate of the bottom edge. */
+double Rect::bottom() const
+{
+    return impl->bottom;
+}
+
+/*! Sets the y-coordinate of the bottom edge. */
+void Rect::setBottom(double bottom)
+{
+    impl->bottom = bottom;
+}
+
+/*! Returns the width of the rectangle. */
+double Rect::width() const
+{
+    return std::abs(impl->right - impl->left);
+}
+
+/*! Returns the height of the rectangle. */
+double Rect::height() const
+{
+    return std::abs(impl->top - impl->bottom);
+}

src/rect_p.cpp

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "rect_p.h"
+
+namespace libscratchcpp
+{
+
+RectPrivate::RectPrivate(double left, double top, double right, double bottom) :
+    left(left),
+    top(top),
+    right(right),
+    bottom(bottom)
+{
+}
+
+RectPrivate::RectPrivate()
+{
+}
+
+} // namespace libscratchcpp

src/rect_p.h

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+namespace libscratchcpp
+{
+
+struct RectPrivate
+{
+        RectPrivate(double left, double top, double right, double bottom);
+        RectPrivate();
+
+        double left = 0;
+        double top = 0;
+        double right = 0;
+        double bottom = 0;
+};
+
+} // namespace libscratchcpp

test/CMakeLists.txt

@@ -32,3 +32,4 @@ add_subdirectory(clock)
 add_subdirectory(timer)
 add_subdirectory(randomgenerator)
 add_subdirectory(imageformats)
+add_subdirectory(rect)

test/rect/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_executable(
+  rect_test
+  rect_test.cpp
+)
+
+target_link_libraries(
+  rect_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(rect_test)

test/rect/rect_test.cpp

@@ -0,0 +1,79 @@
+#include <scratchcpp/rect.h>
+#include <cmath>
+
+#include "../common.h"
+
+using namespace libscratchcpp;
+
+TEST(RectTest, Constructors)
+{
+    {
+        Rect rect;
+        ASSERT_EQ(rect.left(), 0);
+        ASSERT_EQ(rect.top(), 0);
+        ASSERT_EQ(rect.right(), 0);
+        ASSERT_EQ(rect.bottom(), 0);
+        ASSERT_EQ(rect.width(), 0);
+        ASSERT_EQ(rect.height(), 0);
+    }
+
+    {
+        Rect rect(8.4, 150.78, 145.89, -179.99);
+        ASSERT_EQ(rect.left(), 8.4);
+        ASSERT_EQ(rect.top(), 150.78);
+        ASSERT_EQ(rect.right(), 145.89);
+        ASSERT_EQ(rect.bottom(), -179.99);
+        ASSERT_EQ(std::round(rect.width() * 100) / 100, 137.49);
+        ASSERT_EQ(rect.height(), 330.77);
+    }
+}
+
+TEST(RectTest, Left)
+{
+    Rect rect;
+
+    rect.setLeft(-78.05);
+    ASSERT_EQ(rect.left(), -78.05);
+}
+
+TEST(RectTest, Top)
+{
+    Rect rect;
+
+    rect.setTop(-22.89);
+    ASSERT_EQ(rect.top(), -22.89);
+}
+
+TEST(RectTest, Right)
+{
+    Rect rect;
+
+    rect.setRight(100.512);
+    ASSERT_EQ(rect.right(), 100.512);
+}
+
+TEST(RectTest, Bottom)
+{
+    Rect rect;
+
+    rect.setBottom(-58.162);
+    ASSERT_EQ(rect.bottom(), -58.162);
+}
+
+TEST(RectTest, Width)
+{
+    Rect rect;
+
+    rect.setLeft(-78.05);
+    rect.setRight(100.512);
+    ASSERT_EQ(rect.width(), 178.562);
+}
+
+TEST(RectTest, Height)
+{
+    Rect rect;
+
+    rect.setTop(-22.89);
+    rect.setBottom(-58.162);
+    ASSERT_EQ(rect.height(), 35.272);
+}