Add example project for how to use CanvasItemGizmoPlugins#1305
Draft
derkork wants to merge 2 commits intogodotengine:masterfrom
Draft
Add example project for how to use CanvasItemGizmoPlugins#1305derkork wants to merge 2 commits intogodotengine:masterfrom
derkork wants to merge 2 commits intogodotengine:masterfrom
Conversation
13 tasks
AThousandShips
requested changes
Mar 17, 2026
| func _get_gizmo_name() -> String: | ||
| return "Circle" | ||
|
|
||
| ## This function tells the editor whether this node has a bounding rectangle. |
Member
There was a problem hiding this comment.
Suggested change
| ## This function tells the editor whether this node has a bounding rectangle. | |
| ## This function tells the editor whether this node has a bounding rectangle. |
Everywhere, two empty lines between methods
| ## This is only called if _edit_use_rect returns true. | ||
| func _edit_get_rect(gizmo: EditorCanvasItemGizmo) -> Rect2: | ||
| # First we get the node we're editing | ||
| var circle:Circle = gizmo.get_canvas_item() |
Member
There was a problem hiding this comment.
Suggested change
| var circle:Circle = gizmo.get_canvas_item() | |
| var circle: Circle = gizmo.get_canvas_item() |
Everywhere for var
Member
There was a problem hiding this comment.
Per the GDScript style guide, no space before the standalone colon.
Member
There was a problem hiding this comment.
Okay I thought we did the opposite recently, will correct
| ## This function tells the editor what the bounding rectangle of the node is. | ||
| ## This is only called if _edit_use_rect returns true. | ||
| func _edit_get_rect(gizmo: EditorCanvasItemGizmo) -> Rect2: | ||
| # First we get the node we're editing |
Member
There was a problem hiding this comment.
Suggested change
| # First we get the node we're editing | |
| # First we get the node we're editing. |
For all
| # the base state (transform, etc.) is automatically saved from the | ||
| # underlying node, so we only need to add what is custom to our node. In our case | ||
| # this is just the pivot field. | ||
| return {"pivot" : circle.pivot } |
Member
There was a problem hiding this comment.
Suggested change
| return {"pivot" : circle.pivot } | |
| return { "pivot" : circle.pivot } |
Trailing whitespace needs to be removed everywhere
| var _circle_gizmo_plugin:CircleGizmoPlugin | ||
| var _flower_gizmo_plugin:FlowerGizmoPlugin | ||
|
|
||
| ## Registers the gizmo plugins with the editor. |
Member
There was a problem hiding this comment.
Suggested change
| ## Registers the gizmo plugins with the editor. | |
| ## Registers the gizmo plugins with the editor. |
Same here
| return | ||
|
|
||
| var undo_redo:EditorUndoRedoManager = EditorInterface.get_editor_undo_redo() | ||
| undo_redo.create_action("Set radius ") |
Member
There was a problem hiding this comment.
Suggested change
| undo_redo.create_action("Set radius ") | |
| undo_redo.create_action("Set radius") |
| func _edit_get_rect(gizmo: EditorCanvasItemGizmo) -> Rect2: | ||
| # First we get the node we're editing | ||
| var circle:Circle = gizmo.get_canvas_item() | ||
|
|
Member
There was a problem hiding this comment.
Empty lines should be fully empty with no trailing whitespace, everywhere
|
|
||
| # Otherwise, we need to create an undo/redo action for the change: | ||
| var undo_redo:EditorUndoRedoManager = EditorInterface.get_editor_undo_redo() | ||
| undo_redo.create_action("Set radius ") |
Member
There was a problem hiding this comment.
Suggested change
| undo_redo.create_action("Set radius ") | |
| undo_redo.create_action("Set radius") |
| ## The radius of the flower disk. | ||
| @export var radius:float = 100: | ||
| set(value): | ||
| radius = max(0, value) |
Member
There was a problem hiding this comment.
Suggested change
| radius = max(0, value) | |
| radius = maxf(0, value) |
| @export var radius:float = 100: | ||
| set(value): | ||
| # don't allow negative values | ||
| radius = max(0, value) |
Member
There was a problem hiding this comment.
Suggested change
| radius = max(0, value) | |
| radius = maxf(0, value) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an example project for the new 2D gizmo plugins introduced in: godotengine/godot#112979. I'll keep this a draft until the PR is in a state to be merged.