PhysicsDirectSpaceState2D

package
v0.0.0-...-fa94a0d Latest Latest
Warning

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

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

Documentation

Overview

Provides direct access to a physics space in the PhysicsServer2D. It's used mainly to do queries against objects and areas residing in a given space.

Note: This class is not meant to be instantiated directly. Use World2D.DirectSpaceState to get the world's physics 2D space state.

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 Any 

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

type Expanded 

type Expanded = MoreArgs

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]) AsObject 

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

func (*Extension[T]) AsPhysicsDirectSpaceState2D 

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

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.PhysicsDirectSpaceState2D

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) AsObject 

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

func (Instance) AsPhysicsDirectSpaceState2D 

func (self Instance) AsPhysicsDirectSpaceState2D() Instance

func (Instance) CastMotion 

func (self Instance) CastMotion(parameters PhysicsShapeQueryParameters2D.Instance) []float32

Checks how far a Shape2D can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a PhysicsShapeQueryParameters2D object.

Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [1.0, 1.0] will be returned.

Note: Any Shape2Ds that the shape is already colliding with e.g. inside of, will be ignored. Use CollideShape to determine the Shape2Ds that the shape is already colliding with.

func (Instance) CollideShape 

func (self Instance) CollideShape(parameters PhysicsShapeQueryParameters2D.Instance) []Vector2.XY

Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The resulting array contains a list of points where the shape intersects another. Like with IntersectShape, the number of returned results can be limited to save processing time.

Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in PhysicsShapeQueryParameters2D object, second one is in the collided shape from the physics space.

func (Instance) GetRestInfo 

func (self Instance) GetRestInfo(parameters PhysicsShapeQueryParameters2D.Instance) PhysicsDirectSpaceState2D_RestInfo

Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields:

collider_id: The colliding object's ID.

linear_velocity: The colliding object's velocity Vector2.XY. If the object is an Area2D, the result is (0, 0).

normal: The collision normal of the query shape at the intersection point, pointing away from the intersecting object.

point: The intersection point.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

If the shape did not intersect anything, then an empty dictionary is returned instead.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) IntersectPoint 

func (self Instance) IntersectPoint(parameters PhysicsPointQueryParameters2D.Instance) []PhysicsDirectSpaceState2D_Intersection

Checks whether a point is inside any solid shape. Position and other parameters are defined through PhysicsPointQueryParameters2D. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:

collider: The colliding object.

collider_id: The colliding object's ID.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

The number of intersections can be limited with the 'max_results' parameter, to reduce the processing time.

Note: ConcavePolygonShape2Ds and CollisionPolygon2Ds in Segments build mode are not solid shapes. Therefore, they will not be detected.

func (Instance) IntersectRay 

func (self Instance) IntersectRay(parameters PhysicsRayQueryParameters2D.Instance) PhysicsDirectSpaceState2D_Intersection

Intersects a ray in a given space. Ray position and other parameters are defined through PhysicsRayQueryParameters2D. The returned object is a dictionary with the following fields:

collider: The colliding object.

collider_id: The colliding object's ID.

normal: The object's surface normal at the intersection point, or Vector2(0, 0) if the ray starts inside the shape and PhysicsRayQueryParameters2D.HitFromInside is true.

position: The intersection point.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

If the ray did not intersect anything, then an empty dictionary is returned instead.

func (Instance) IntersectShape 

func (self Instance) IntersectShape(parameters PhysicsShapeQueryParameters2D.Instance) []PhysicsDirectSpaceState2D_Intersection

Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:

collider: The colliding object.

collider_id: The colliding object's ID.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

The number of intersections can be limited with the 'max_results' parameter, to reduce the processing time.

func (Instance) MoreArgs 

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (*Instance) SetObject 

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

func (Instance) Virtual 

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

type MoreArgs 

type MoreArgs [1]gdclass.PhysicsDirectSpaceState2D

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) CollideShape 

func (self MoreArgs) CollideShape(parameters PhysicsShapeQueryParameters2D.Instance, max_results int) []Vector2.XY

Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The resulting array contains a list of points where the shape intersects another. Like with IntersectShape, the number of returned results can be limited to save processing time.

Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in PhysicsShapeQueryParameters2D object, second one is in the collided shape from the physics space.

func (MoreArgs) IntersectPoint 

func (self MoreArgs) IntersectPoint(parameters PhysicsPointQueryParameters2D.Instance, max_results int) []PhysicsDirectSpaceState2D_Intersection

Checks whether a point is inside any solid shape. Position and other parameters are defined through PhysicsPointQueryParameters2D. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:

collider: The colliding object.

collider_id: The colliding object's ID.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

The number of intersections can be limited with the 'max_results' parameter, to reduce the processing time.

Note: ConcavePolygonShape2Ds and CollisionPolygon2Ds in Segments build mode are not solid shapes. Therefore, they will not be detected.

func (MoreArgs) IntersectShape 

func (self MoreArgs) IntersectShape(parameters PhysicsShapeQueryParameters2D.Instance, max_results int) []PhysicsDirectSpaceState2D_Intersection

Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:

collider: The colliding object.

collider_id: The colliding object's ID.

rid: The intersecting object's Resource.ID.

shape: The shape index of the colliding shape.

The number of intersections can be limited with the 'max_results' parameter, to reduce the processing time.

type PhysicsDirectSpaceState2D_Intersection 

type PhysicsDirectSpaceState2D_Intersection struct {
	Collider   Object.Instance `gd:"collider"`
	ColliderID Object.ID       `gd:"collider_id"`
	Normal     struct {
		X float32
		Y float32
	} `gd:"normal"`
	Position struct {
		X float32
		Y float32
	} `gd:"position"`
	RID   RID.Any `gd:"rid"`
	Shape int     `gd:"shape"`
}

type PhysicsDirectSpaceState2D_RestInfo 

type PhysicsDirectSpaceState2D_RestInfo struct {
	ColliderID     Object.ID `gd:"collider_id"`
	LinearVelocity struct {
		X float32
		Y float32
	} `gd:"linear_velocity"`
	Normal struct {
		X float32
		Y float32
	} `gd:"normal"`
	Point struct {
		X float32
		Y float32
	} `gd:"point"`
	RID   RID.Any `gd:"rid"`
	Shape int     `gd:"shape"`
}

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.