Add a way to get the editor's Camera2D/Camera3D nodes

[fabriceci]

Describe the project you are working on:

I write a tool where I need to use the use the camera method: unproject_position in a 2D node, in the process method.

Describe the problem or limitation you are having in your project:

I don't find a way to get the editor's camera, so I can't add extra info in my tool.

If this enhancement will not be used often, can it be worked around with a few lines of script?:

no

Is there a reason why this should be core and not an add-on in the asset library?:

It's a core feature.

[aaronfranke]

Here is some work-around code (designed for Godot 3.2, original by @neikeq).

func _ready():
	var editor_viewport_2d = find_viewport_2d(get_node("/root/EditorNode"), 0)
	var editor_viewport_3d = find_viewport_3d(get_node("/root/EditorNode"), 0)
	var editor_camera_3d = editor_viewport_3d.get_child(0)


func find_viewport_2d(node: Node, recursive_level):
	if node.get_class() == "CanvasItemEditor":
		return node.get_child(1).get_child(0).get_child(0).get_child(0).get_child(0)
	else:
		recursive_level += 1
		if recursive_level > 15:
			return null
		for child in node.get_children():
			var result = find_viewport_2d(child, recursive_level)
			if result != null:
				return result


func find_viewport_3d(node: Node, recursive_level):
	if node.get_class() == "SpatialEditor":
		return node.get_child(1).get_child(0).get_child(0).get_child(0).get_child(0).get_child(0)
	else:
		recursive_level += 1
		if recursive_level > 15:
			return null
		for child in node.get_children():
			var result = find_viewport_3d(child, recursive_level)
			if result != null:
				return result

[Calinou]

Note that the 3D editor keeps track of the camera transform on its own. This means that if you set the rotation manually, it will be overridden as soon as you pan the camera or use freelook again.

We should add a proper interface for setting the editor Camera3D transform as well.

[Zylann]

Note: the 3D editor has more than one camera. This is because there are split view modes with 2, 3 or 4 viewports at once. Hence why the camera is provided in input callbacks since it is paired with interactions done in that viewport. So "getting the 3D editor camera" can be ambiguous there because it assumes there is only one. At the very least you'd need to access the viewport you want. In fact, Viewport is supposed to be able to provide the 3D camera already... with Viewport.get_camera(). But oddly enough in the editor, that doesn't work and returns null last time I tried (a long time ago, admittedly).

[QbieShay]

Just stumbled on this, perhaps cameras could be exposed with a get_spatial_cameras(index) ?

[fbcosentino]

Expanded the one posted by @aaronfranke to include all viewports (if the user is splitting viewports). All 4 viewports are always there, just optionally hidden

The code gives you ViewportContainer, Viewport, Camera, and the Control UI overlay (which captures mouse events), for maximum convenience

func _ready():
	var editor_viewport_container_2d = find_viewport_2d(get_node("/root/EditorNode"), 0)
	
	var spatialeditor_viewport_container = find_SpatialEditorViewportContainer(get_node("/root/EditorNode"), 0)
	var viewports_3d = find_viewports_3d(spatialeditor_viewport_container)
	
	# viewports_3d[ <viewport index 0-3> ] = {
	#     "viewport_container": ViewportContainer,
	#     "viewport": Viewport,
	#     "camera": Camera,
	#     "control": Control, 
	# }
	#      Indices:
	# 1 viewport: index 0
	# 2 viewports (both ways): indices 0 and 2
	# 3 viewports: indices 0, 2 and 3
	# 4 viewports: indices 0, 1, 2, 3
	
	print( viewports_3d[0]["camera"].fov ) # Prints 70 (if you haven't changed)




func find_viewport_2d(node: Node, recursive_level):
	if node.get_class() == "CanvasItemEditor":
		return node.get_child(1).get_child(0).get_child(0).get_child(0).get_child(0)
	else:
		recursive_level += 1
		if recursive_level > 15:
			return null
		for child in node.get_children():
			var result = find_viewport_2d(child, recursive_level)
			if result != null:
				return result

func find_viewports_3d(spatial_editor_viewport_container) -> Array:
	var result = []
	for spatial_editor_viewport in spatial_editor_viewport_container.get_children():
		var viewport_container = spatial_editor_viewport.get_child(0)
		var control = spatial_editor_viewport.get_child(1)
		var viewport = viewport_container.get_child(0)
		var camera = viewport.get_child(0)
		result.append( {
			"viewport_container": viewport_container,
			"viewport": viewport,
			"camera": camera,
			"control": control,
		} )
	return result

func find_SpatialEditorViewportContainer(node: Node, recursive_level):
	if node.get_class() == "SpatialEditor":
		return node.get_child(1).get_child(0).get_child(0).get_child(0)
	else:
		recursive_level += 1
		if recursive_level > 15:
			return null
		for child in node.get_children():
			var result = find_SpatialEditorViewportContainer(child, recursive_level)
			if result != null:
				return result

[snektailmeat]

Note that the 3D editor keeps track of the camera transform on its own. This means that if you set the rotation manually, it will be overridden as soon as you pan the camera or use freelook again.

We should add a proper interface for setting the editor Camera3D transform as well.

so whats the status on this or the whole not being able to get the editors camera ?

[Calinou]

so whats the status on this or the whole not being able to get the editors camera ?

This isn't implemented yet. Pull requests are welcome 🙂