Class PhysicsShape | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class PhysicsShape

    Inheritance
    System.Object
    PhysicsShape
    Namespace: Unity.Physics.Authoring
    Syntax
    public sealed class PhysicsShape : MonoBehaviour, IInheritPhysicsMaterialProperties, IPhysicsMaterialProperties

    Properties

    BelongsTo

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

    CollidesWith

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

    ConvexRadius

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

    CustomFlags

    Declaration
    public byte CustomFlags { get; set; }
    Property Value
    Type Description
    System.Byte

    Friction

    Declaration
    public PhysicsMaterialCoefficient Friction { get; set; }
    Property Value
    Type Description
    PhysicsMaterialCoefficient

    IsTrigger

    Declaration
    public bool IsTrigger { get; set; }
    Property Value
    Type Description
    System.Boolean

    MaterialTemplate

    Declaration
    public PhysicsMaterialTemplate MaterialTemplate { get; set; }
    Property Value
    Type Description
    PhysicsMaterialTemplate

    OverrideBelongsTo

    Declaration
    public bool OverrideBelongsTo { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideCollidesWith

    Declaration
    public bool OverrideCollidesWith { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideCustomFlags

    Declaration
    public bool OverrideCustomFlags { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideFriction

    Declaration
    public bool OverrideFriction { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideIsTrigger

    Declaration
    public bool OverrideIsTrigger { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideRaisesCollisionEvents

    Declaration
    public bool OverrideRaisesCollisionEvents { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverrideRestitution

    Declaration
    public bool OverrideRestitution { get; set; }
    Property Value
    Type Description
    System.Boolean

    RaisesCollisionEvents

    Declaration
    public bool RaisesCollisionEvents { get; set; }
    Property Value
    Type Description
    System.Boolean

    Restitution

    Declaration
    public PhysicsMaterialCoefficient Restitution { get; set; }
    Property Value
    Type Description
    PhysicsMaterialCoefficient

    ShapeType

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

    Methods

    FitToEnabledRenderMeshes()

    Declaration
    public void FitToEnabledRenderMeshes()

    GetBelongsTo(Int32)

    Declaration
    public bool GetBelongsTo(int categoryIndex)
    Parameters
    Type Name Description
    System.Int32 categoryIndex
    Returns
    Type Description
    System.Boolean

    GetBoxProperties(out float3, out float3, out quaternion)

    Declaration
    public void GetBoxProperties(out float3 center, out float3 size, out quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    float3 size
    quaternion orientation

    GetCapsuleProperties(out float3, out Single, out Single, out quaternion)

    Declaration
    public void GetCapsuleProperties(out float3 center, out float height, out float radius, out quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single height
    System.Single radius
    quaternion orientation

    GetCollidesWith(Int32)

    Declaration
    public bool GetCollidesWith(int categoryIndex)
    Parameters
    Type Name Description
    System.Int32 categoryIndex
    Returns
    Type Description
    System.Boolean

    GetConvexHullProperties(NativeList<float3>)

    Declaration
    public void GetConvexHullProperties(NativeList<float3> pointCloud)
    Parameters
    Type Name Description
    NativeList<float3> pointCloud

    GetCustomFlag(Int32)

    Declaration
    public bool GetCustomFlag(int customFlagIndex)
    Parameters
    Type Name Description
    System.Int32 customFlagIndex
    Returns
    Type Description
    System.Boolean

    GetCylinderProperties(out float3, out Single, out Single, out quaternion)

    Declaration
    public void GetCylinderProperties(out float3 center, out float height, out float radius, out quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single height
    System.Single radius
    quaternion orientation

    GetMesh()

    Declaration
    public UnityEngine.Mesh GetMesh()
    Returns
    Type Description
    UnityEngine.Mesh

    GetPlaneProperties(out float3, out float2, out quaternion)

    Declaration
    public void GetPlaneProperties(out float3 center, out float2 size, out quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    float2 size
    quaternion orientation

    GetSphereProperties(out float3, out Single, out quaternion)

    Declaration
    public void GetSphereProperties(out float3 center, out float radius, out quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single radius
    quaternion orientation

    SetBelongsTo(Int32, Boolean)

    Declaration
    public void SetBelongsTo(int categoryIndex, bool value)
    Parameters
    Type Name Description
    System.Int32 categoryIndex
    System.Boolean value

    SetBox(float3, float3, quaternion)

    Declaration
    public void SetBox(float3 center, float3 size, quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    float3 size
    quaternion orientation

    SetCapsule(float3, Single, Single, quaternion)

    Declaration
    public void SetCapsule(float3 center, float height, float radius, quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single height
    System.Single radius
    quaternion orientation

    SetCollidesWith(Int32, Boolean)

    Declaration
    public void SetCollidesWith(int categoryIndex, bool value)
    Parameters
    Type Name Description
    System.Int32 categoryIndex
    System.Boolean value

    SetConvexHull(UnityEngine.Mesh)

    Declaration
    public void SetConvexHull(UnityEngine.Mesh convexHull = null)
    Parameters
    Type Name Description
    UnityEngine.Mesh convexHull

    SetCustomFlag(Int32, Boolean)

    Declaration
    public void SetCustomFlag(int customFlagIndex, bool value)
    Parameters
    Type Name Description
    System.Int32 customFlagIndex
    System.Boolean value

    SetCylinder(float3, Single, Single, quaternion)

    Declaration
    public void SetCylinder(float3 center, float height, float radius, quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single height
    System.Single radius
    quaternion orientation

    SetMesh(UnityEngine.Mesh)

    Declaration
    public void SetMesh(UnityEngine.Mesh mesh = null)
    Parameters
    Type Name Description
    UnityEngine.Mesh mesh

    SetPlane(float3, float2, quaternion)

    Declaration
    public void SetPlane(float3 center, float2 size, quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    float2 size
    quaternion orientation

    SetSphere(float3, Single, quaternion)

    Declaration
    public void SetSphere(float3 center, float radius, quaternion orientation)
    Parameters
    Type Name Description
    float3 center
    System.Single radius
    quaternion orientation
    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