Struct PhysicsCompoundCollider | 2D Entities | 0.22.0-preview.8
docs.unity3d.com
    Show / Hide Table of Contents

    Struct PhysicsCompoundCollider

    Namespace: Unity.U2D.Entities.Physics
    Syntax
    public struct PhysicsCompoundCollider : ICompositeCollider, ICollider, IQueryable

    Properties

    Children

    Declaration
    public BlobArray.Accessor<PhysicsCompoundCollider.Child> Children { get; }
    Property Value
    Type Description
    BlobArray.Accessor<PhysicsCompoundCollider.Child>

    ColliderType

    Declaration
    public ColliderType ColliderType { get; }
    Property Value
    Type Description
    ColliderType

    CollisionType

    Declaration
    public CollisionType CollisionType { get; }
    Property Value
    Type Description
    CollisionType

    Filter

    Declaration
    public CollisionFilter Filter { get; }
    Property Value
    Type Description
    CollisionFilter

    MassProperties

    Declaration
    public MassProperties MassProperties { get; }
    Property Value
    Type Description
    MassProperties

    MemorySize

    Declaration
    public int MemorySize { get; }
    Property Value
    Type Description
    Int32

    NumChildren

    Declaration
    public int NumChildren { get; }
    Property Value
    Type Description
    Int32

    NumColliderKeyBits

    Declaration
    public uint NumColliderKeyBits { get; }
    Property Value
    Type Description
    UInt32

    UserData

    Declaration
    public uint UserData { get; set; }
    Property Value
    Type Description
    UInt32

    Methods

    CalculateAabb()

    Declaration
    public Aabb CalculateAabb()
    Returns
    Type Description
    Aabb
    Implements
    IQueryable.CalculateAabb()

    CalculateAabb(PhysicsTransform)

    Declaration
    public Aabb CalculateAabb(PhysicsTransform transform)
    Parameters
    Type Name Description
    PhysicsTransform transform
    Returns
    Type Description
    Aabb
    Implements
    IQueryable.CalculateAabb(PhysicsTransform)

    CalculateDistance(ColliderDistanceInput)

    Declaration
    public bool CalculateDistance(ColliderDistanceInput input)
    Parameters
    Type Name Description
    ColliderDistanceInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(ColliderDistanceInput)

    CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

    Declaration
    public bool CalculateDistance(ColliderDistanceInput input, ref NativeList<DistanceHit> allHits)
    Parameters
    Type Name Description
    ColliderDistanceInput input
    NativeList<DistanceHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

    CalculateDistance(ColliderDistanceInput, out DistanceHit)

    Declaration
    public bool CalculateDistance(ColliderDistanceInput input, out DistanceHit closestHit)
    Parameters
    Type Name Description
    ColliderDistanceInput input
    DistanceHit closestHit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(ColliderDistanceInput, out DistanceHit)

    CalculateDistance(PointDistanceInput)

    Declaration
    public bool CalculateDistance(PointDistanceInput input)
    Parameters
    Type Name Description
    PointDistanceInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(PointDistanceInput)

    CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

    Declaration
    public bool CalculateDistance(PointDistanceInput input, ref NativeList<DistanceHit> allHits)
    Parameters
    Type Name Description
    PointDistanceInput input
    NativeList<DistanceHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

    CalculateDistance(PointDistanceInput, out DistanceHit)

    Declaration
    public bool CalculateDistance(PointDistanceInput input, out DistanceHit closestHit)
    Parameters
    Type Name Description
    PointDistanceInput input
    DistanceHit closestHit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CalculateDistance(PointDistanceInput, out DistanceHit)

    CalculateDistance<T>(ColliderDistanceInput, ref T)

    Declaration
    public bool CalculateDistance<T>(ColliderDistanceInput input, ref T collector)
        where T : struct, ICollector<DistanceHit>
    Parameters
    Type Name Description
    ColliderDistanceInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.CalculateDistance<T>(ColliderDistanceInput, ref T)

    CalculateDistance<T>(PointDistanceInput, ref T)

    Declaration
    public bool CalculateDistance<T>(PointDistanceInput input, ref T collector)
        where T : struct, ICollector<DistanceHit>
    Parameters
    Type Name Description
    PointDistanceInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.CalculateDistance<T>(PointDistanceInput, ref T)

    CastCollider(ColliderCastInput)

    Declaration
    public bool CastCollider(ColliderCastInput input)
    Parameters
    Type Name Description
    ColliderCastInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastCollider(ColliderCastInput)

    CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

    Declaration
    public bool CastCollider(ColliderCastInput input, ref NativeList<ColliderCastHit> allHits)
    Parameters
    Type Name Description
    ColliderCastInput input
    NativeList<ColliderCastHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

    CastCollider(ColliderCastInput, out ColliderCastHit)

    Declaration
    public bool CastCollider(ColliderCastInput input, out ColliderCastHit closestHit)
    Parameters
    Type Name Description
    ColliderCastInput input
    ColliderCastHit closestHit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastCollider(ColliderCastInput, out ColliderCastHit)

    CastCollider<T>(ColliderCastInput, ref T)

    Declaration
    public bool CastCollider<T>(ColliderCastInput input, ref T collector)
        where T : struct, ICollector<ColliderCastHit>
    Parameters
    Type Name Description
    ColliderCastInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.CastCollider<T>(ColliderCastInput, ref T)

    CastRay(RaycastInput)

    Declaration
    public bool CastRay(RaycastInput input)
    Parameters
    Type Name Description
    RaycastInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastRay(RaycastInput)

    CastRay(RaycastInput, ref NativeList<RaycastHit>)

    Declaration
    public bool CastRay(RaycastInput input, ref NativeList<RaycastHit> allHits)
    Parameters
    Type Name Description
    RaycastInput input
    NativeList<RaycastHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastRay(RaycastInput, ref NativeList<RaycastHit>)

    CastRay(RaycastInput, out RaycastHit)

    Declaration
    public bool CastRay(RaycastInput input, out RaycastHit closestHit)
    Parameters
    Type Name Description
    RaycastInput input
    RaycastHit closestHit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.CastRay(RaycastInput, out RaycastHit)

    CastRay<T>(RaycastInput, ref T)

    Declaration
    public bool CastRay<T>(RaycastInput input, ref T collector)
        where T : struct, ICollector<RaycastHit>
    Parameters
    Type Name Description
    RaycastInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.CastRay<T>(RaycastInput, ref T)

    Create(NativeArray<PhysicsCompoundCollider.ColliderBlobInstance>, UInt32)

    Declaration
    public static BlobAssetReference<Collider> Create(NativeArray<PhysicsCompoundCollider.ColliderBlobInstance> children, uint userData = 0U)
    Parameters
    Type Name Description
    NativeArray<PhysicsCompoundCollider.ColliderBlobInstance> children
    UInt32 userData
    Returns
    Type Description
    BlobAssetReference<Collider>

    GetChild(ref ColliderKey, out ChildCollider)

    Declaration
    public bool GetChild(ref ColliderKey key, out ChildCollider child)
    Parameters
    Type Name Description
    ColliderKey key
    ChildCollider child
    Returns
    Type Description
    Boolean

    GetLeaf(ColliderKey, out ChildCollider)

    Declaration
    public bool GetLeaf(ColliderKey key, out ChildCollider leaf)
    Parameters
    Type Name Description
    ColliderKey key
    ChildCollider leaf
    Returns
    Type Description
    Boolean

    GetLeaves<T>(ref T)

    Declaration
    public void GetLeaves<T>(ref T collector)
        where T : struct, ILeafColliderCollector
    Parameters
    Type Name Description
    T collector
    Type Parameters
    Name Description
    T

    OverlapCollider(OverlapColliderInput)

    Declaration
    public bool OverlapCollider(OverlapColliderInput input)
    Parameters
    Type Name Description
    OverlapColliderInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapCollider(OverlapColliderInput)

    OverlapCollider(OverlapColliderInput, ref NativeList<OverlapColliderHit>)

    Declaration
    public bool OverlapCollider(OverlapColliderInput input, ref NativeList<OverlapColliderHit> allHits)
    Parameters
    Type Name Description
    OverlapColliderInput input
    NativeList<OverlapColliderHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapCollider(OverlapColliderInput, ref NativeList<OverlapColliderHit>)

    OverlapCollider(OverlapColliderInput, out OverlapColliderHit)

    Declaration
    public bool OverlapCollider(OverlapColliderInput input, out OverlapColliderHit hit)
    Parameters
    Type Name Description
    OverlapColliderInput input
    OverlapColliderHit hit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapCollider(OverlapColliderInput, out OverlapColliderHit)

    OverlapCollider<T>(OverlapColliderInput, ref T)

    Declaration
    public bool OverlapCollider<T>(OverlapColliderInput input, ref T collector)
        where T : struct, ICollector<OverlapColliderHit>
    Parameters
    Type Name Description
    OverlapColliderInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.OverlapCollider<T>(OverlapColliderInput, ref T)

    OverlapPoint(OverlapPointInput)

    Declaration
    public bool OverlapPoint(OverlapPointInput input)
    Parameters
    Type Name Description
    OverlapPointInput input
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapPoint(OverlapPointInput)

    OverlapPoint(OverlapPointInput, ref NativeList<OverlapPointHit>)

    Declaration
    public bool OverlapPoint(OverlapPointInput input, ref NativeList<OverlapPointHit> allHits)
    Parameters
    Type Name Description
    OverlapPointInput input
    NativeList<OverlapPointHit> allHits
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapPoint(OverlapPointInput, ref NativeList<OverlapPointHit>)

    OverlapPoint(OverlapPointInput, out OverlapPointHit)

    Declaration
    public bool OverlapPoint(OverlapPointInput input, out OverlapPointHit hit)
    Parameters
    Type Name Description
    OverlapPointInput input
    OverlapPointHit hit
    Returns
    Type Description
    Boolean
    Implements
    IQueryable.OverlapPoint(OverlapPointInput, out OverlapPointHit)

    OverlapPoint<T>(OverlapPointInput, ref T)

    Declaration
    public bool OverlapPoint<T>(OverlapPointInput input, ref T collector)
        where T : struct, ICollector<OverlapPointHit>
    Parameters
    Type Name Description
    OverlapPointInput input
    T collector
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    Implements
    IQueryable.OverlapPoint<T>(OverlapPointInput, ref T)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023