Merge pull request #105 from RobLoach/by-reference

Pass objects by reference

Author: RobLoach

CHANGELOG.md

@@ -11,11 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `models_first_person_maze.cpp` example
 - String override functions to use `std::string` directly instead of `const char*`
 - `std::vector<std::string>` wrapper for `GetDirectoryFiles()` and `GetDroppedFiles()`
+- `raylib::Color::RayWhite()` static functions to build `Color` objects
+- `Rectangle.GetPosition()` and `Rectangle.SetPosition()`
+- `Rectangle.GetSize()` and `Rectangle.SetSize()`
 
 ### Fixed
 - `Mouse::SetX()` and `Mouse::SetY()`
+- Most objects are now passed by reference
 - Error correction when unloading images, materials, models and meshes
 
+### Changed
+- `Mouse` functions are now `static`. Use `Mouse::SetX()` instead of using `Mouse mouse`.
+- `Camera*::BeginMode()` and `Camera*::EndMode()` no longer have 2D/3D in the name
+
 ## [v3.5.0-alpha1] - 2020-12-26
 ### Changed
 - Update to raylib 3.5.0

examples/core/core_3d_camera_first_person.cpp

@@ -61,7 +61,7 @@ int main() {
 
             background.ClearBackground();
 
-            camera.BeginMode3D();
+            camera.BeginMode();
 
                 DrawPlane(Vector3{ 0.0f, 0.0f, 0.0f }, Vector2{ 32.0f, 32.0f }, LIGHTGRAY); // Draw ground
                 DrawCube(Vector3{ -16.0f, 2.5f, 0.0f }, 1.0f, 5.0f, 32.0f, BLUE);     // Draw a blue wall
@@ -75,7 +75,7 @@ int main() {
                     positions[i].DrawCubeWires(2.0f, heights[i], 2.0f, MAROON);
                 }
 
-            EndMode3D();
+            camera.EndMode();
 
             DrawRectangle( 10, 10, 220, 70, Fade(SKYBLUE, 0.5f));
             DrawRectangleLines( 10, 10, 220, 70, BLUE);

examples/models/models_billboard.cpp

@@ -50,13 +50,13 @@ int main() {
 
             ClearBackground(RAYWHITE);
 
-            camera.BeginMode3D();
+            camera.BeginMode();
 
                 DrawGrid(10, 1.0f);        // Draw a grid
 
                 camera.DrawBillboard(bill, billPosition, 2.0f, WHITE);
 
-            camera.EndMode3D();
+            camera.EndMode();
 
             DrawFPS(10, 10);
 

examples/models/models_first_person_maze.cpp

@@ -75,7 +75,7 @@ int main(void)
             for (int x = 0; x < cubicmap.width; x++)
             {
                 if ((mapPixels[y*cubicmap.width + x].r == 255) &&       // Collision: white pixel, only check R channel
-                    (playerPos.CheckCollisionCircleRec(playerRadius,
+                    (playerPos.CheckCollisionCircle(playerRadius,
                     (Rectangle){ mapPosition.x - 0.5f + x*1.0f, mapPosition.z - 0.5f + y*1.0f, 1.0f, 1.0f })))
                 {
                     // Collision detected, reset camera position
@@ -91,12 +91,12 @@ int main(void)
 
             ClearBackground(RAYWHITE);
 
-            camera.BeginMode3D();
+            camera.BeginMode();
 
                 model.Draw(mapPosition);               // Draw maze map
                 // playerPosition.DrawCube((Vector3){ 0.2f, 0.4f, 0.2f }, RED);  // Draw player
 
-            camera.EndMode3D();
+            camera.EndMode();
 
             cubicmap.Draw((Vector2){ static_cast<float>(GetScreenWidth() - cubicmap.width*4 - 20), 20 }, 0.0f, 4.0f, WHITE);
             DrawRectangleLines(GetScreenWidth() - cubicmap.width*4 - 20, 20, cubicmap.width*4, cubicmap.height*4, GREEN);

examples/textures/textures_image_drawing.cpp

@@ -35,9 +35,9 @@ int main(void)
     // Draw one image over the other with a scaling of 1.5f
     parrots
         .Draw(cat,
-            raylib::Rectangle(0, 0, cat.width, cat.height),
-            raylib::Rectangle(30, 40, cat.width*1.5f, cat.height*1.5f))
-        .Crop(raylib::Rectangle(0, 50, parrots.width, parrots.height - 100)); // Crop resulting image
+            raylib::Rectangle(0, 0, cat.GetWidth(), cat.GetHeight()),
+            raylib::Rectangle(30, 40, cat.GetWidth() * 1.5f, cat.GetHeight() * 1.5f))
+        .Crop(raylib::Rectangle(0, 50, parrots.GetWidth(), parrots.GetHeight() - 100)); // Crop resulting image
 
     // Load custom font for frawing on image
     raylib::Font font("resources/custom_jupiter_crash.png");

include/AudioStream.hpp

@@ -34,7 +34,7 @@ namespace raylib {
  */
 class AudioStream : public ::AudioStream {
  public:
-    AudioStream(::AudioStream music) {
+    AudioStream(const ::AudioStream& music) {
         set(music);
     }
 
@@ -149,7 +149,7 @@ class AudioStream : public ::AudioStream {
     }
 
  protected:
-    inline void set(::AudioStream stream) {
+    inline void set(const ::AudioStream& stream) {
         buffer = stream.buffer;
         sampleRate = stream.sampleRate;
         sampleSize = stream.sampleSize;

include/BoundingBox.hpp

@@ -34,15 +34,15 @@ namespace raylib {
  */
 class BoundingBox : public ::BoundingBox {
  public:
-    BoundingBox(::BoundingBox box) {
+    BoundingBox(const ::BoundingBox& box) {
         set(box);
     }
 
     /**
      * Compute mesh bounding box limits
      */
-    BoundingBox(::Mesh mesh) {
-        set(MeshBoundingBox(mesh));
+    BoundingBox(const ::Mesh& mesh) {
+        set(::MeshBoundingBox(mesh));
     }
 
     BoundingBox(::Vector3 Min, ::Vector3 Max) {
@@ -66,15 +66,15 @@ class BoundingBox : public ::BoundingBox {
     /**
      * Draw a bounding box with wires
      */
-    inline BoundingBox& Draw(::Color color = WHITE) {
+    inline BoundingBox& Draw(::Color color = {255, 255, 255, 255}) {
         DrawBoundingBox(*this, color);
         return *this;
     }
 
     /**
      * Detect collision between two boxes
      */
-    inline bool CheckCollision(::BoundingBox box2) const {
+    inline bool CheckCollision(const ::BoundingBox& box2) const {
         return CheckCollisionBoxes(*this, box2);
     }
 
@@ -88,12 +88,12 @@ class BoundingBox : public ::BoundingBox {
     /**
      * Detect collision between ray and bounding box
      */
-    inline bool CheckCollision(::Ray ray) const {
+    inline bool CheckCollision(const ::Ray& ray) const {
         return CheckCollisionRayBox(ray, *this);
     }
 
  protected:
-    inline void set(::BoundingBox box) {
+    inline void set(const ::BoundingBox& box) {
         min = box.min;
         max = box.max;
     }

include/Camera2D.hpp

@@ -32,6 +32,11 @@
 namespace raylib {
 class Camera2D : public ::Camera2D {
  public:
+    Camera2D() {}
+    Camera2D(const ::Camera2D& camera) {
+        set(camera);
+    }
+
     Camera2D(::Vector2 offsetValue, ::Vector2 targetValue, float rotationValue = 0,
             float zoomValue = 1) {
         offset = offsetValue;
@@ -40,12 +45,12 @@ class Camera2D : public ::Camera2D {
         zoom = zoomValue;
     }
 
-    inline Camera2D& BeginMode2D() {
+    inline Camera2D& BeginMode() {
         ::BeginMode2D(*this);
         return *this;
     }
 
-    inline Camera2D& EndMode2D() {
+    inline Camera2D& EndMode() {
         ::EndMode2D();
         return *this;
     }
@@ -75,14 +80,14 @@ class Camera2D : public ::Camera2D {
     /**
      * Returns the screen space position for a 3d world space position
      */
-    inline Vector2 GetWorldToScreen2D(Vector2 position) const {
+    inline Vector2 GetWorldToScreen(::Vector2 position) const {
         return ::GetWorldToScreen2D(position, *this);
     }
 
     /**
      * Returns the world space position for a 2d camera screen space position
      */
-    inline Vector2 GetScreenToWorld2D(Vector2 position) const {
+    inline Vector2 GetScreenToWorld(::Vector2 position) const {
         return ::GetScreenToWorld2D(position, *this);
     }
 

include/Camera3D.hpp

@@ -32,6 +32,10 @@
 namespace raylib {
 class Camera3D : public ::Camera3D {
  public:
+    Camera3D(const ::Camera3D& camera) {
+        set(camera);
+    }
+
     Camera3D(::Vector3 positionValue, ::Vector3 targetValue, ::Vector3 upValue,
             float fovyValue = 0, int typeValue = 0) {
         position = positionValue;
@@ -59,11 +63,18 @@ class Camera3D : public ::Camera3D {
         return *this;
     }
 
-    Camera3D& BeginMode3D() {
+    /**
+     * Initializes 3D mode with custom camera (3D)
+     */
+    Camera3D& BeginMode() {
         ::BeginMode3D(*this);
         return *this;
     }
-    Camera3D& EndMode3D() {
+
+    /**
+     * Ends 3D mode and returns to default 2D orthographic mode
+     */
+    Camera3D& EndMode() {
         ::EndMode3D();
         return *this;
     }
@@ -102,7 +113,9 @@ class Camera3D : public ::Camera3D {
     /**
      * Set camera move controls (1st person and 3rd person cameras)
      */
-    inline Camera3D& SetMoveControls(int frontKey, int backKey, int rightKey, int leftKey,
+    inline Camera3D& SetMoveControls(
+            int frontKey, int backKey,
+            int rightKey, int leftKey,
             int upKey, int downKey) {
         ::SetCameraMoveControls(frontKey, backKey, rightKey, leftKey, upKey, downKey);
         return *this;
@@ -138,14 +151,21 @@ class Camera3D : public ::Camera3D {
         return ::GetWorldToScreen(position, *this);
     }
 
-    inline Camera3D& DrawBillboard(::Texture2D texture, ::Vector3 center, float size,
-            ::Color tint = WHITE) {
+    inline Camera3D& DrawBillboard(
+            const ::Texture2D& texture,
+            ::Vector3 center,
+            float size,
+            ::Color tint = {255, 255, 255, 255}) {
         ::DrawBillboard(*this, texture, center, size, tint);
         return *this;
     }
 
-    inline Camera3D& DrawBillboard(::Texture2D texture, ::Rectangle sourceRec, ::Vector3 center,
-            float size, ::Color tint = WHITE) {
+    inline Camera3D& DrawBillboard(
+            const ::Texture2D& texture,
+            ::Rectangle sourceRec,
+            ::Vector3 center,
+            float size,
+            ::Color tint = {255, 255, 255, 255}) {
         ::DrawBillboardRec(*this, texture, sourceRec, center, size, tint);
         return *this;
     }

include/Color.hpp

@@ -34,15 +34,13 @@
 namespace raylib {
 class Color : public ::Color {
  public:
-    Color(::Color color) {
-        r = color.r;
-        g = color.g;
-        b = color.b;
-        a = color.a;
+    Color(const ::Color& color) {
+        set(color);
     }
 
     Color(unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha) :
         ::Color{red, green, blue, alpha} {};
+
     Color(unsigned char red, unsigned char green, unsigned char blue) :
         ::Color{red, green, blue, 255} {};
 
@@ -61,7 +59,7 @@ class Color : public ::Color {
     /**
      * Returns a Color from HSV values
      */
-    static Color FromHSV(float hue, float saturation, float value) {
+    static ::Color FromHSV(float hue, float saturation, float value) {
         return ::ColorFromHSV(hue, saturation, value);
     }
 
@@ -183,14 +181,19 @@ class Color : public ::Color {
         return *this;
     }
 
-    inline Color& DrawText(::Font font, const std::string& text, ::Vector2 position,
+    inline Color& DrawText(const ::Font& font, const std::string& text, ::Vector2 position,
             float fontSize, float spacing) {
         ::DrawTextEx(font, text.c_str(), position, fontSize, spacing, *this);
         return *this;
     }
 
-    inline Color& DrawText(::Font font, const std::string& text, ::Rectangle rec, float fontSize,
-            float spacing, bool wordWrap = false) {
+    inline Color& DrawText(
+            const ::Font& font,
+            const std::string& text,
+            ::Rectangle rec,
+            float fontSize,
+            float spacing,
+            bool wordWrap = false) {
         ::DrawTextRec(font, text.c_str(), rec, fontSize, spacing, wordWrap, *this);
         return *this;
     }
@@ -239,6 +242,33 @@ class Color : public ::Color {
         return ::ColorAlphaBlend(dst, *this, tint);
     }
 
+    inline static Color LightGray() { return LIGHTGRAY; }
+    inline static Color Gray() { return GRAY; }
+    inline static Color DarkGray() { return DARKGRAY; }
+    inline static Color Yellow() { return YELLOW; }
+    inline static Color Gold() { return GOLD; }
+    inline static Color Orange() { return ORANGE; }
+    inline static Color Pink() { return PINK; }
+    inline static Color Red() { return RED; }
+    inline static Color Maroon() { return MAROON; }
+    inline static Color Green() { return GREEN; }
+    inline static Color Lime() { return LIME; }
+    inline static Color DarkGreen() { return DARKGREEN; }
+    inline static Color SkyBlue() { return SKYBLUE; }
+    inline static Color Blue() { return BLUE; }
+    inline static Color DarkBlue() { return DARKBLUE; }
+    inline static Color Purple() { return PURPLE; }
+    inline static Color Violet() { return VIOLET; }
+    inline static Color DarkPurple() { return DARKPURPLE; }
+    inline static Color Beige() { return BEIGE; }
+    inline static Color Brown() { return BROWN; }
+    inline static Color DarkBrown() { return DARKBROWN; }
+    inline static Color White() { return WHITE; }
+    inline static Color Black() { return BLACK; }
+    inline static Color Blank() { return BLANK; }
+    inline static Color Magenta() { return MAGENTA; }
+    inline static Color RayWhite() { return RAYWHITE; }
+
  protected:
     inline void set(const ::Color& color) {
         r = color.r;