GeomRect2D
Inherits: Node2D
A rectangle placed on the canvas.
Drawing it
The code behind the picture above, where c is its centre, r is 30% of its height.
GeomDraw.set_corner_roundness(0.35)
GeomDraw.rect_2d_colored(c, Vector2(r * 2.0, r * 1.5), AMBER)
GeomDraw.set_corner_roundness(0.0)Properties
| BlendMode | blend_mode | Geom.BLEND_TRANSPARENT |
| bool | border | false |
| Color | color | Color(1, 1, 1, 1) |
| Color | color_end | Color(1, 1, 1, 1) |
| ColorMode | color_mode | Geom.COLOR_SINGLE |
| Vector4 | corner_radii | Vector4(0, 0, 0, 0) |
| GeomDash | dash | null |
| bool | pivot_at_corner | false |
| Vector2 | size | Vector2(180, 110) |
| ThicknessSpace | size_space | Geom.SPACE_METERS |
| float | thickness | 8.0 |
| ThicknessSpace | thickness_space | Geom.SPACE_METERS |
Enumerations
enum Geom.ThicknessSpace
- Geom.SPACE_METERS = 0
- Thickness in world units; shrinks on screen with distance.
- Geom.SPACE_PIXELS = 1
- Thickness in screen pixels; constant on-screen size.
- Geom.SPACE_VIEWPORT = 2
- A fraction of the viewport: 100 span its shorter side, so 1 is one percent of it and about 11 pixels at 1080p. The same idea as CSS
vmin. Radii and sizes here are whole-ish numbers; strokes come out below 1, and a stroke that should stay a fixed pixel width wantsSPACE_PIXELSinstead.
enum Geom.ColorMode
- Geom.COLOR_SINGLE = 0
- One flat color.
- Geom.COLOR_RADIAL = 1
- Interpolate
colortocolor_endfrom the center outwards. - Geom.COLOR_ANGULAR = 2
- Interpolate
colortocolor_endaround the sweep.
enum Geom.BlendMode
- Geom.BLEND_OPAQUE = 0
- Writes depth and sorts against other geometry; hard edges, no fade.
- Geom.BLEND_TRANSPARENT = 1
- Standard alpha compositing. The default.
- Geom.BLEND_ADDITIVE = 2
- Brightens what is behind. Good for glows.
- Geom.BLEND_MULTIPLY = 3
- Darkens what is behind. Good for tints.
- Geom.BLEND_SUBTRACT = 4
- Subtracts this color from the background.
- Geom.BLEND_TRANSPARENT_DEPTH = 5
- Transparent, but writing depth so shapes occlude by position.
Property descriptions
BlendMode blend_mode = Geom.BLEND_TRANSPARENT
How the shape combines with what is behind it. Transparent Depth is a 3D idea and behaves exactly like Transparent here, a canvas having no depth buffer.
bool border = false
Draw an outline of thickness instead of a fill.
Color color = Color(1, 1, 1, 1)
Fill color, or the wall's color for an outline.
Color color_end = Color(1, 1, 1, 1)
The far end of the gradient. Ignored unless color_mode is something other than Single.
ColorMode color_mode = Geom.COLOR_SINGLE
Single flat color, or a Radial or Angular gradient between color and color_end.
Vector4 corner_radii = Vector4(0, 0, 0, 0)
Corner radii as fractions of the shorter half-side, clockwise from bottom-left. Fractions rather than lengths so a corner cannot exceed the rectangle that owns it.
GeomDash dash = null
Assign a GeomDash to dash this shape; leave empty for solid.
bool pivot_at_corner = false
Position by the bottom-left corner rather than the center.
Vector2 size = Vector2(180, 110)
Width and height. Unlike a radius this takes a non-uniform node scale exactly, because the two sides are independent.
ThicknessSpace size_space = Geom.SPACE_METERS
Whether size is measured in canvas units or in pixels. Canvas units zoom with the view like ordinary 2D content; pixels hold their size on screen through a zoom, which is what a HUD wants. Either way the node's scale multiplies it.
float thickness = 8.0
Wall thickness, used only when border is set.
ThicknessSpace thickness_space = Geom.SPACE_METERS
Whether thickness is measured in canvas units or in pixels. Canvas units zoom with the view like ordinary 2D content; pixels hold their size on screen through a zoom, which is what a HUD wants. Either way the node's scale multiplies it.