https://github.com/peter-kish/primitives2d

A plugin for the Godot game engine (version 4.x) for rendering primitive 2d shapes.
https://github.com/peter-kish/primitives2d

Last synced: 12 months ago
JSON representation

A plugin for the Godot game engine (version 4.x) for rendering primitive 2d shapes.

• Host: GitHub
• URL: https://github.com/peter-kish/primitives2d
• Owner: peter-kish
• License: mit
• Created: 2022-10-22T12:16:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-03T17:59:56.000Z (almost 2 years ago)
• Last Synced: 2025-03-16T23:26:01.475Z (over 1 year ago)
• Language: GDScript
• Size: 255 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Primitives2D



  



A plugin for the Godot game engine (version 4.x) for rendering primitive 2d shapes.

![](images/ss_editor.png "Primitives2D")

While the [`CanvasItem`](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html) class supports a number of methods for rendering primitive shapes, the engine only offers the [Line2D](https://docs.godotengine.org/en/stable/classes/class_line2d.html) and [Polygon2D](https://docs.godotengine.org/en/stable/classes/class_polygon2d.html) nodes for adding primitive shapes to a scene. This plugin introduces the following node types in a similar fashion:

* ![](addons/primitives2d/icon_rect.svg "Rectangle2D icon") [Rectangle2D](#rectangle2d)

* ![](addons/primitives2d/icon_circle.svg "Circle2D icon") [Circle2D](#circle2d)

* ![](addons/primitives2d/icon_arc.svg "Arc2D icon") [Arc2D](#arc2d)

The nodes simply use the builtin [`CanvasItem`](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html) methods for drawing primitive shapes: [`draw_rect`](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html#class-canvasitem-method-draw-rect), [`draw_circle`](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html#class-canvasitem-method-draw-circle) and [`draw_arc`](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html#class-canvasitem-method-draw-arc).

## Installation

1. Create an `addons` directory inside your project directory.

2. Get the plugin from the AssetLib or from GitHub

    * From the AssetLib: Open the AssetLib from the Godot editor and search for "Primitives2D". Click download to install the plugin.

    * From GitHub: Run `git clone https://github.com/peter-kish/primitives2d.git` and copy the contents of the `addons` directory to your projects `addons` directory.

4. Enable the plugin in `Project Settings > Plugins`.

## Usage

Add a [Rectangle2D](#rectangle2d), [Circle2D](#circle2d) or [Arc2D](#arc2d) node to your scene and set the node properties described below.

### Rectangle2D

Draws a 2D rectangle.

#### Properties

* `color: Color` - The color of the rectangle.

* `size: Vector2` - The size of the rectangle.

* `filled: bool` - If `false`, the rectangle will be drawn as a stroke with the `color` and `line_width` specified.

* `line_width: float` - Width of the stroke (in case `filled` is `true`).

* `centered: bool` - If `true`, the rectangle will be drawn centered.

### Circle2D

Draws a 2D circle.

#### Properties

* `color: Color` - The color of the circle.

* `radius: float` - The radius of the circle.

* `filled: bool` - If `false`, the circle will be drawn as a stroke with the `color` and `line_width` specified.

* `line_width: float` - Width of the stroke (in case `filled` is `true`).

* `antialiased: bool` - If `true`, the lines will attempt to perform antialiasing using OpenGL line smoothing.

* `detail: int` - The number of line segments.

### Arc2D

Draws a unfilled 2D arc.

#### Properties

* `color: Color` - The color of the arc.

* `radius: float` - The radius of the arc.

* `filled: bool` - If `false`, the arc will be drawn as a stroke with the `color` and `line_width` specified.

* `line_width: float` - Width of the stroke (in case `filled` is `true`).

* `antialiased: bool` - If `true`, the lines will attempt to perform antialiasing using OpenGL line smoothing.

* `detail: int` - The number of line segments.