Struct CylinderCollider | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct CylinderCollider

    Namespace: Unity.Physics
    Syntax
    public struct CylinderCollider : IConvexCollider, ICollider, ICollidable

    Properties

    Center

    Declaration
    public float3 Center { get; set; }
    Property Value
    Type Description
    float3

    CollisionType

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

    ConvexRadius

    Declaration
    public float ConvexRadius { get; set; }
    Property Value
    Type Description
    System.Single

    Filter

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

    Height

    Declaration
    public float Height { get; set; }
    Property Value
    Type Description
    System.Single

    MassProperties

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

    Material

    Declaration
    public Material Material { get; set; }
    Property Value
    Type Description
    Material

    MemorySize

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

    Orientation

    Declaration
    public quaternion Orientation { get; set; }
    Property Value
    Type Description
    quaternion

    Radius

    Declaration
    public float Radius { get; set; }
    Property Value
    Type Description
    System.Single

    SideCount

    Declaration
    public int SideCount { get; set; }
    Property Value
    Type Description
    System.Int32

    Type

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

    Methods

    CalculateAabb()

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

    CalculateAabb(RigidTransform)

    Declaration
    public Aabb CalculateAabb(RigidTransform transform)
    Parameters
    Type Name Description
    RigidTransform transform
    Returns
    Type Description
    Aabb
    Implements
    ICollidable.CalculateAabb(RigidTransform)

    CalculateDistance(ColliderDistanceInput)

    Declaration
    public bool CalculateDistance(ColliderDistanceInput input)
    Parameters
    Type Name Description
    ColliderDistanceInput input
    Returns
    Type Description
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.CalculateDistance(ColliderDistanceInput, out DistanceHit)

    CalculateDistance(PointDistanceInput)

    Declaration
    public bool CalculateDistance(PointDistanceInput input)
    Parameters
    Type Name Description
    PointDistanceInput input
    Returns
    Type Description
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Type Parameters
    Name Description
    T
    Implements
    ICollidable.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
    System.Boolean
    Type Parameters
    Name Description
    T
    Implements
    ICollidable.CalculateDistance<T>(PointDistanceInput, ref T)

    CastCollider(ColliderCastInput)

    Declaration
    public bool CastCollider(ColliderCastInput input)
    Parameters
    Type Name Description
    ColliderCastInput input
    Returns
    Type Description
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Type Parameters
    Name Description
    T
    Implements
    ICollidable.CastCollider<T>(ColliderCastInput, ref T)

    CastRay(RaycastInput)

    Declaration
    public bool CastRay(RaycastInput input)
    Parameters
    Type Name Description
    RaycastInput input
    Returns
    Type Description
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Implements
    ICollidable.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
    System.Boolean
    Type Parameters
    Name Description
    T
    Implements
    ICollidable.CastRay<T>(RaycastInput, ref T)

    Create(float3, Single, Single, quaternion, Single, Nullable<CollisionFilter>, Nullable<Material>)

    Declaration
    public static BlobAssetReference<Collider> Create(float3 center, float height, float radius, quaternion orientation, float convexRadius, CollisionFilter? filter = default(CollisionFilter? ), Material? material = default(Material? ))
    Parameters
    Type Name Description
    float3 center
    System.Single height
    System.Single radius
    quaternion orientation
    System.Single convexRadius
    System.Nullable<CollisionFilter> filter
    System.Nullable<Material> material
    Returns
    Type Description
    BlobAssetReference<Collider>
    In This Article
    • Properties
      • Center
      • CollisionType
      • ConvexRadius
      • Filter
      • Height
      • MassProperties
      • Material
      • MemorySize
      • Orientation
      • Radius
      • SideCount
      • Type
    • Methods
      • CalculateAabb()
      • CalculateAabb(RigidTransform)
      • CalculateDistance(ColliderDistanceInput)
      • CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)
      • CalculateDistance(ColliderDistanceInput, out DistanceHit)
      • CalculateDistance(PointDistanceInput)
      • CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)
      • CalculateDistance(PointDistanceInput, out DistanceHit)
      • CalculateDistance<T>(ColliderDistanceInput, ref T)
      • CalculateDistance<T>(PointDistanceInput, ref T)
      • CastCollider(ColliderCastInput)
      • CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)
      • CastCollider(ColliderCastInput, out ColliderCastHit)
      • CastCollider<T>(ColliderCastInput, ref T)
      • CastRay(RaycastInput)
      • CastRay(RaycastInput, ref NativeList<RaycastHit>)
      • CastRay(RaycastInput, out RaycastHit)
      • CastRay<T>(RaycastInput, ref T)
      • Create(float3, Single, Single, quaternion, Single, Nullable<CollisionFilter>, Nullable<Material>)
    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