Show / Hide Table of Contents

Struct PhysicsScene2D

Implements
IEquatable<PhysicsScene2D>
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
public struct PhysicsScene2D : IEquatable<PhysicsScene2D>

Methods

| Improve this Doc View Source

BoxCast(Vector2, Vector2, Single, Vector2, Single, Int32)

Declaration
public RaycastHit2D BoxCast(Vector2 origin, Vector2 size, float angle, Vector2 direction, float distance, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 size
Single angle
Vector2 direction
Single distance
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

BoxCast(Vector2, Vector2, Single, Vector2, Single, ContactFilter2D)

Declaration
public RaycastHit2D BoxCast(Vector2 origin, Vector2 size, float angle, Vector2 direction, float distance, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 origin
Vector2 size
Single angle
Vector2 direction
Single distance
ContactFilter2D contactFilter
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

BoxCast(Vector2, Vector2, Single, Vector2, Single, ContactFilter2D, RaycastHit2D[])

Declaration
public int BoxCast(Vector2 origin, Vector2 size, float angle, Vector2 direction, float distance, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 origin
Vector2 size
Single angle
Vector2 direction
Single distance
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

BoxCast(Vector2, Vector2, Single, Vector2, Single, RaycastHit2D[], Int32)

Declaration
public int BoxCast(Vector2 origin, Vector2 size, float angle, Vector2 direction, float distance, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 size
Single angle
Vector2 direction
Single distance
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

CapsuleCast(Vector2, Vector2, CapsuleDirection2D, Single, Vector2, Single, Int32)

Declaration
public RaycastHit2D CapsuleCast(Vector2 origin, Vector2 size, CapsuleDirection2D capsuleDirection, float angle, Vector2 direction, float distance, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 size
CapsuleDirection2D capsuleDirection
Single angle
Vector2 direction
Single distance
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

CapsuleCast(Vector2, Vector2, CapsuleDirection2D, Single, Vector2, Single, ContactFilter2D)

Declaration
public RaycastHit2D CapsuleCast(Vector2 origin, Vector2 size, CapsuleDirection2D capsuleDirection, float angle, Vector2 direction, float distance, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 origin
Vector2 size
CapsuleDirection2D capsuleDirection
Single angle
Vector2 direction
Single distance
ContactFilter2D contactFilter
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

CapsuleCast(Vector2, Vector2, CapsuleDirection2D, Single, Vector2, Single, ContactFilter2D, RaycastHit2D[])

Declaration
public int CapsuleCast(Vector2 origin, Vector2 size, CapsuleDirection2D capsuleDirection, float angle, Vector2 direction, float distance, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 origin
Vector2 size
CapsuleDirection2D capsuleDirection
Single angle
Vector2 direction
Single distance
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

CapsuleCast(Vector2, Vector2, CapsuleDirection2D, Single, Vector2, Single, RaycastHit2D[], Int32)

Declaration
public int CapsuleCast(Vector2 origin, Vector2 size, CapsuleDirection2D capsuleDirection, float angle, Vector2 direction, float distance, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 size
CapsuleDirection2D capsuleDirection
Single angle
Vector2 direction
Single distance
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

CircleCast(Vector2, Single, Vector2, Single, Int32)

Declaration
public RaycastHit2D CircleCast(Vector2 origin, float radius, Vector2 direction, float distance, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Single radius
Vector2 direction
Single distance
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

CircleCast(Vector2, Single, Vector2, Single, ContactFilter2D)

Declaration
public RaycastHit2D CircleCast(Vector2 origin, float radius, Vector2 direction, float distance, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 origin
Single radius
Vector2 direction
Single distance
ContactFilter2D contactFilter
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

CircleCast(Vector2, Single, Vector2, Single, ContactFilter2D, RaycastHit2D[])

Declaration
public int CircleCast(Vector2 origin, float radius, Vector2 direction, float distance, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 origin
Single radius
Vector2 direction
Single distance
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

CircleCast(Vector2, Single, Vector2, Single, RaycastHit2D[], Int32)

Declaration
public int CircleCast(Vector2 origin, float radius, Vector2 direction, float distance, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Single radius
Vector2 direction
Single distance
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
Object other
Returns
Type Description
Boolean
Overrides
ValueType.Equals(Object)
| Improve this Doc View Source

Equals(PhysicsScene2D)

Declaration
public bool Equals(PhysicsScene2D other)
Parameters
Type Name Description
PhysicsScene2D other
Returns
Type Description
Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
ValueType.GetHashCode()
| Improve this Doc View Source

GetRayIntersection(Ray, Single, Int32)

Declaration
public RaycastHit2D GetRayIntersection(Ray ray, float distance, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Ray ray
Single distance
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

GetRayIntersection(Ray, Single, RaycastHit2D[], Int32)

Declaration
public int GetRayIntersection(Ray ray, float distance, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Ray ray
Single distance
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

IsEmpty()

Declaration
public bool IsEmpty()
Returns
Type Description
Boolean
| Improve this Doc View Source

IsValid()

Declaration
public bool IsValid()
Returns
Type Description
Boolean
| Improve this Doc View Source

Linecast(Vector2, Vector2, Int32)

Declaration
public RaycastHit2D Linecast(Vector2 start, Vector2 end, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 start
Vector2 end
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

Linecast(Vector2, Vector2, ContactFilter2D)

Declaration
public RaycastHit2D Linecast(Vector2 start, Vector2 end, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 start
Vector2 end
ContactFilter2D contactFilter
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

Linecast(Vector2, Vector2, ContactFilter2D, RaycastHit2D[])

Declaration
public int Linecast(Vector2 start, Vector2 end, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 start
Vector2 end
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Linecast(Vector2, Vector2, RaycastHit2D[], Int32)

Declaration
public int Linecast(Vector2 start, Vector2 end, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 start
Vector2 end
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapArea(Vector2, Vector2, Int32)

Declaration
public Collider2D OverlapArea(Vector2 pointA, Vector2 pointB, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 pointA
Vector2 pointB
Int32 layerMask
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapArea(Vector2, Vector2, Collider2D[], Int32)

Declaration
public int OverlapArea(Vector2 pointA, Vector2 pointB, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 pointA
Vector2 pointB
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapArea(Vector2, Vector2, ContactFilter2D)

Declaration
public Collider2D OverlapArea(Vector2 pointA, Vector2 pointB, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 pointA
Vector2 pointB
ContactFilter2D contactFilter
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapArea(Vector2, Vector2, ContactFilter2D, Collider2D[])

Declaration
public int OverlapArea(Vector2 pointA, Vector2 pointB, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Vector2 pointA
Vector2 pointB
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapBox(Vector2, Vector2, Single, Int32)

Declaration
public Collider2D OverlapBox(Vector2 point, Vector2 size, float angle, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Vector2 size
Single angle
Int32 layerMask
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapBox(Vector2, Vector2, Single, Collider2D[], Int32)

Declaration
public int OverlapBox(Vector2 point, Vector2 size, float angle, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Vector2 size
Single angle
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapBox(Vector2, Vector2, Single, ContactFilter2D)

Declaration
public Collider2D OverlapBox(Vector2 point, Vector2 size, float angle, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 point
Vector2 size
Single angle
ContactFilter2D contactFilter
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapBox(Vector2, Vector2, Single, ContactFilter2D, Collider2D[])

Declaration
public int OverlapBox(Vector2 point, Vector2 size, float angle, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Vector2 point
Vector2 size
Single angle
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, Single, Int32)

Declaration
public Collider2D OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Vector2 size
CapsuleDirection2D direction
Single angle
Int32 layerMask
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, Single, Collider2D[], Int32)

Declaration
public int OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Vector2 size
CapsuleDirection2D direction
Single angle
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, Single, ContactFilter2D)

Declaration
public Collider2D OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 point
Vector2 size
CapsuleDirection2D direction
Single angle
ContactFilter2D contactFilter
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, Single, ContactFilter2D, Collider2D[])

Declaration
public int OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Vector2 point
Vector2 size
CapsuleDirection2D direction
Single angle
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCircle(Vector2, Single, Int32)

Declaration
public Collider2D OverlapCircle(Vector2 point, float radius, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Single radius
Int32 layerMask
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapCircle(Vector2, Single, Collider2D[], Int32)

Declaration
public int OverlapCircle(Vector2 point, float radius, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Single radius
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCircle(Vector2, Single, ContactFilter2D)

Declaration
public Collider2D OverlapCircle(Vector2 point, float radius, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 point
Single radius
ContactFilter2D contactFilter
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapCircle(Vector2, Single, ContactFilter2D, Collider2D[])

Declaration
public int OverlapCircle(Vector2 point, float radius, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Vector2 point
Single radius
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCollider(Collider2D, Collider2D[], Int32)

Declaration
public static int OverlapCollider(Collider2D collider, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Collider2D collider
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapCollider(Collider2D, ContactFilter2D, Collider2D[])

Declaration
public static int OverlapCollider(Collider2D collider, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Collider2D collider
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapPoint(Vector2, Int32)

Declaration
public Collider2D OverlapPoint(Vector2 point, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Int32 layerMask
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapPoint(Vector2, Collider2D[], Int32)

Declaration
public int OverlapPoint(Vector2 point, Collider2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 point
Collider2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

OverlapPoint(Vector2, ContactFilter2D)

Declaration
public Collider2D OverlapPoint(Vector2 point, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 point
ContactFilter2D contactFilter
Returns
Type Description
Collider2D
| Improve this Doc View Source

OverlapPoint(Vector2, ContactFilter2D, Collider2D[])

Declaration
public int OverlapPoint(Vector2 point, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
Vector2 point
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, Vector2, Single, Int32)

Declaration
public RaycastHit2D Raycast(Vector2 origin, Vector2 direction, float distance, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 direction
Single distance
Int32 layerMask
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

Raycast(Vector2, Vector2, Single, ContactFilter2D)

Declaration
public RaycastHit2D Raycast(Vector2 origin, Vector2 direction, float distance, ContactFilter2D contactFilter)
Parameters
Type Name Description
Vector2 origin
Vector2 direction
Single distance
ContactFilter2D contactFilter
Returns
Type Description
RaycastHit2D
| Improve this Doc View Source

Raycast(Vector2, Vector2, Single, ContactFilter2D, RaycastHit2D[])

Declaration
public int Raycast(Vector2 origin, Vector2 direction, float distance, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 origin
Vector2 direction
Single distance
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, Vector2, Single, RaycastHit2D[], Int32)

Declaration
public int Raycast(Vector2 origin, Vector2 direction, float distance, RaycastHit2D[] results, [DefaultValue("Physics2D.DefaultRaycastLayers")] int layerMask = -5)
Parameters
Type Name Description
Vector2 origin
Vector2 direction
Single distance
RaycastHit2D[] results
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

Simulate(Single)

Declaration
public bool Simulate(float step)
Parameters
Type Name Description
Single step
Returns
Type Description
Boolean
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
ValueType.ToString()

Operators

| Improve this Doc View Source

Equality(PhysicsScene2D, PhysicsScene2D)

Declaration
public static bool operator ==(PhysicsScene2D lhs, PhysicsScene2D rhs)
Parameters
Type Name Description
PhysicsScene2D lhs
PhysicsScene2D rhs
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(PhysicsScene2D, PhysicsScene2D)

Declaration
public static bool operator !=(PhysicsScene2D lhs, PhysicsScene2D rhs)
Parameters
Type Name Description
PhysicsScene2D lhs
PhysicsScene2D rhs
Returns
Type Description
Boolean

Implements

System.IEquatable<T>

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX