Camera2D

package
v0.0.0-...-e1beaa7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2025 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of graphics.gd/classdb/CanvasItem-based nodes.

Cameras register themselves in the nearest graphics.gd/classdb/Viewport node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the camera will register in the global viewport.

This node is intended to be a simple helper to get things going quickly, but more functionality may be desired to change how the camera works. To make your own custom camera node, inherit it from graphics.gd/classdb/Node2D and change the transform of the canvas by setting graphics.gd/classdb/Viewport.Instance.CanvasTransform in graphics.gd/classdb/Viewport (you can obtain the current graphics.gd/classdb/Viewport by using graphics.gd/classdb/Node.Instance.GetViewport).

Note that the graphics.gd/classdb/Camera2D node's graphics.gd/classdb/Node2D.Instance.GlobalPosition doesn't represent the actual position of the screen, which may differ due to applied smoothing or limits. You can use Instance.GetScreenCenterPosition to get the real position. Same for the node's graphics.gd/classdb/Node2D.Instance.GlobalRotation which may be different due to applied rotation smoothing. You can use Instance.GetScreenRotation to get the current rotation of the screen.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type AnchorMode 

type AnchorMode int //gd:Camera2D.AnchorMode

const (
	// The camera's position is fixed so that the top-left corner is always at the origin.
	AnchorModeFixedTopLeft AnchorMode = 0
	// The camera's position takes into account vertical/horizontal offsets and the screen size.
	AnchorModeDragCenter AnchorMode = 1
)

type Any 

type Any interface {
	gd.IsClass
	AsCamera2D() Instance
}

type Camera2DProcessCallback 

type Camera2DProcessCallback int //gd:Camera2D.Camera2DProcessCallback

const (
	// The camera updates during physics frames (see [Node.NotificationInternalPhysicsProcess]).
	Camera2dProcessPhysics Camera2DProcessCallback = 0
	// The camera updates during process frames (see [Node.NotificationInternalProcess]).
	Camera2dProcessIdle Camera2DProcessCallback = 1
)

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCamera2D 

func (self *Extension[T]) AsCamera2D() Instance

func (*Extension[T]) AsCanvasItem 

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D 

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Instance 

type Instance [1]gdclass.Camera2D

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) Align 

func (self Instance) Align()

Aligns the camera to the tracked node.

func (Instance) AnchorMode 

func (self Instance) AnchorMode() AnchorMode

func (Instance) AsCamera2D 

func (self Instance) AsCamera2D() Instance

func (Instance) AsCanvasItem 

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D 

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) CustomViewport 

func (self Instance) CustomViewport() Node.Instance

func (Instance) DragBottomMargin 

func (self Instance) DragBottomMargin() Float.X

func (Instance) DragHorizontalEnabled 

func (self Instance) DragHorizontalEnabled() bool

func (Instance) DragHorizontalOffset 

func (self Instance) DragHorizontalOffset() Float.X

func (Instance) DragLeftMargin 

func (self Instance) DragLeftMargin() Float.X

func (Instance) DragRightMargin 

func (self Instance) DragRightMargin() Float.X

func (Instance) DragTopMargin 

func (self Instance) DragTopMargin() Float.X

func (Instance) DragVerticalEnabled 

func (self Instance) DragVerticalEnabled() bool

func (Instance) DragVerticalOffset 

func (self Instance) DragVerticalOffset() Float.X

func (Instance) EditorDrawDragMargin 

func (self Instance) EditorDrawDragMargin() bool

func (Instance) EditorDrawLimits 

func (self Instance) EditorDrawLimits() bool

func (Instance) EditorDrawScreen 

func (self Instance) EditorDrawScreen() bool

func (Instance) Enabled 

func (self Instance) Enabled() bool

func (Instance) ForceUpdateScroll 

func (self Instance) ForceUpdateScroll()

Forces the camera to update scroll immediately.

func (Instance) GetScreenCenterPosition 

func (self Instance) GetScreenCenterPosition() Vector2.XY

Returns the center of the screen from this camera's point of view, in global coordinates.

Note: The exact targeted position of the camera may be different. See Instance.GetTargetPosition.

func (Instance) GetScreenRotation 

func (self Instance) GetScreenRotation() Float.X

Returns the current screen rotation from this camera's point of view.

Note: The screen rotation can be different from graphics.gd/classdb/Node2D.Instance.GlobalRotation if the camera is rotating smoothly due to Instance.RotationSmoothingEnabled.

func (Instance) GetTargetPosition 

func (self Instance) GetTargetPosition() Vector2.XY

Returns this camera's target position, in global coordinates.

Note: The returned value is not the same as graphics.gd/classdb/Node2D.Instance.GlobalPosition, as it is affected by the drag properties. It is also not the same as the current position if Instance.PositionSmoothingEnabled is true (see Instance.GetScreenCenterPosition).

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) IgnoreRotation 

func (self Instance) IgnoreRotation() bool

func (Instance) IsCurrent 

func (self Instance) IsCurrent() bool

Returns true if this graphics.gd/classdb/Camera2D is the active camera (see graphics.gd/classdb/Viewport.Instance.GetCamera2d).

func (Instance) LimitBottom 

func (self Instance) LimitBottom() int

func (Instance) LimitEnabled 

func (self Instance) LimitEnabled() bool

func (Instance) LimitLeft 

func (self Instance) LimitLeft() int

func (Instance) LimitRight 

func (self Instance) LimitRight() int

func (Instance) LimitSmoothed 

func (self Instance) LimitSmoothed() bool

func (Instance) LimitTop 

func (self Instance) LimitTop() int

func (Instance) MakeCurrent 

func (self Instance) MakeCurrent()

Forces this graphics.gd/classdb/Camera2D to become the current active one. Instance.Enabled must be true.

func (Instance) Offset 

func (self Instance) Offset() Vector2.XY

func (Instance) PositionSmoothingEnabled 

func (self Instance) PositionSmoothingEnabled() bool

func (Instance) PositionSmoothingSpeed 

func (self Instance) PositionSmoothingSpeed() Float.X

func (Instance) ProcessCallback 

func (self Instance) ProcessCallback() Camera2DProcessCallback

func (Instance) ResetSmoothing 

func (self Instance) ResetSmoothing()

Sets the camera's position immediately to its current smoothing destination.

This method has no effect if Instance.PositionSmoothingEnabled is false.

func (Instance) RotationSmoothingEnabled 

func (self Instance) RotationSmoothingEnabled() bool

func (Instance) RotationSmoothingSpeed 

func (self Instance) RotationSmoothingSpeed() Float.X

func (Instance) SetAnchorMode 

func (self Instance) SetAnchorMode(value AnchorMode)

func (Instance) SetCustomViewport 

func (self Instance) SetCustomViewport(value Node.Instance)

func (Instance) SetDragBottomMargin 

func (self Instance) SetDragBottomMargin(value Float.X)

func (Instance) SetDragHorizontalEnabled 

func (self Instance) SetDragHorizontalEnabled(value bool)

func (Instance) SetDragHorizontalOffset 

func (self Instance) SetDragHorizontalOffset(value Float.X)

func (Instance) SetDragLeftMargin 

func (self Instance) SetDragLeftMargin(value Float.X)

func (Instance) SetDragRightMargin 

func (self Instance) SetDragRightMargin(value Float.X)

func (Instance) SetDragTopMargin 

func (self Instance) SetDragTopMargin(value Float.X)

func (Instance) SetDragVerticalEnabled 

func (self Instance) SetDragVerticalEnabled(value bool)

func (Instance) SetDragVerticalOffset 

func (self Instance) SetDragVerticalOffset(value Float.X)

func (Instance) SetEditorDrawDragMargin 

func (self Instance) SetEditorDrawDragMargin(value bool)

func (Instance) SetEditorDrawLimits 

func (self Instance) SetEditorDrawLimits(value bool)

func (Instance) SetEditorDrawScreen 

func (self Instance) SetEditorDrawScreen(value bool)

func (Instance) SetEnabled 

func (self Instance) SetEnabled(value bool)

func (Instance) SetIgnoreRotation 

func (self Instance) SetIgnoreRotation(value bool)

func (Instance) SetLimitBottom 

func (self Instance) SetLimitBottom(value int)

func (Instance) SetLimitEnabled 

func (self Instance) SetLimitEnabled(value bool)

func (Instance) SetLimitLeft 

func (self Instance) SetLimitLeft(value int)

func (Instance) SetLimitRight 

func (self Instance) SetLimitRight(value int)

func (Instance) SetLimitSmoothed 

func (self Instance) SetLimitSmoothed(value bool)

func (Instance) SetLimitTop 

func (self Instance) SetLimitTop(value int)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetOffset 

func (self Instance) SetOffset(value Vector2.XY)

func (Instance) SetPositionSmoothingEnabled 

func (self Instance) SetPositionSmoothingEnabled(value bool)

func (Instance) SetPositionSmoothingSpeed 

func (self Instance) SetPositionSmoothingSpeed(value Float.X)

func (Instance) SetProcessCallback 

func (self Instance) SetProcessCallback(value Camera2DProcessCallback)

func (Instance) SetRotationSmoothingEnabled 

func (self Instance) SetRotationSmoothingEnabled(value bool)

func (Instance) SetRotationSmoothingSpeed 

func (self Instance) SetRotationSmoothingSpeed(value Float.X)

func (Instance) SetZoom 

func (self Instance) SetZoom(value Vector2.XY)

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Zoom 

func (self Instance) Zoom() Vector2.XY

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.