Class PhysicsShapeAuthoring | Unity Physics | 0.5.1-preview.2
docs.unity3d.com
    Show / Hide Table of Contents

    Class PhysicsShapeAuthoring

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    PhysicsShapeAuthoring
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.Physics.Authoring
    Syntax
    [AddComponentMenu("DOTS/Physics/Physics Shape")]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.physics@0.5/api/Unity.Physics.Authoring.PhysicsShapeAuthoring.html")]
    public sealed class PhysicsShapeAuthoring : MonoBehaviour, IInheritPhysicsMaterialProperties, IPhysicsMaterialProperties, ISerializationCallbackReceiver

    Properties

    BelongsTo

    Declaration
    public PhysicsCategoryTags BelongsTo { get; set; }
    Property Value
    Type Description
    PhysicsCategoryTags

    CollidesWith

    Declaration
    public PhysicsCategoryTags CollidesWith { get; set; }
    Property Value
    Type Description
    PhysicsCategoryTags

    CollisionResponse

    Declaration
    public CollisionResponsePolicy CollisionResponse { get; set; }
    Property Value
    Type Description
    CollisionResponsePolicy

    ConvexHullGenerationParameters

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

    CustomTags

    Declaration
    public CustomPhysicsMaterialTags CustomTags { get; set; }
    Property Value
    Type Description
    CustomPhysicsMaterialTags

    ForceUnique

    Declaration
    public bool ForceUnique { get; set; }
    Property Value
    Type Description
    Boolean

    Friction

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

    MaterialTemplate

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

    OverrideBelongsTo

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

    OverrideCollidesWith

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

    OverrideCollisionResponse

    Declaration
    public bool OverrideCollisionResponse { get; set; }
    Property Value
    Type Description
    Boolean

    OverrideCustomTags

    Declaration
    public bool OverrideCustomTags { get; set; }
    Property Value
    Type Description
    Boolean

    OverrideFriction

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

    OverrideRestitution

    Declaration
    public bool OverrideRestitution { get; set; }
    Property Value
    Type Description
    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(Single)

    Fit this shape to render geometry in its GameObject hierarchy. Children in the hierarchy will influence the result if they have enabled MeshRenderer components or have vertices bound to them on a SkinnedMeshRenderer. Children will only count as influences if this shape is the first ancestor shape in their hierarchy. As such, you should add shape components to all GameObjects that should have them before you call this method on any of them.

    Declaration
    public void FitToEnabledRenderMeshes(float minimumSkinnedVertexWeight = 0F)
    Parameters
    Type Name Description
    Single minimumSkinnedVertexWeight

    The minimum total weight that a vertex in a skinned mesh must have assigned to this object and/or any of its influencing children.

    GetBoxProperties()

    Declaration
    public BoxGeometry GetBoxProperties()
    Returns
    Type Description
    BoxGeometry

    GetCapsuleProperties()

    Declaration
    public CapsuleGeometryAuthoring GetCapsuleProperties()
    Returns
    Type Description
    CapsuleGeometryAuthoring

    GetConvexHullProperties(NativeList<float3>)

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

    GetCylinderProperties()

    Declaration
    public CylinderGeometry GetCylinderProperties()
    Returns
    Type Description
    CylinderGeometry

    GetMeshProperties(NativeList<float3>, NativeList<int3>)

    Declaration
    public void GetMeshProperties(NativeList<float3> vertices, NativeList<int3> triangles)
    Parameters
    Type Name Description
    NativeList<Unity.Mathematics.float3> vertices
    NativeList<Unity.Mathematics.int3> triangles

    GetPlaneProperties(out float3, out float2, out quaternion)

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

    GetSphereProperties(out quaternion)

    Declaration
    public SphereGeometry GetSphereProperties(out quaternion orientation)
    Parameters
    Type Name Description
    Unity.Mathematics.quaternion orientation
    Returns
    Type Description
    SphereGeometry

    SetBox(BoxGeometry)

    Declaration
    public void SetBox(BoxGeometry geometry)
    Parameters
    Type Name Description
    BoxGeometry geometry

    SetCapsule(CapsuleGeometryAuthoring)

    Declaration
    public void SetCapsule(CapsuleGeometryAuthoring geometry)
    Parameters
    Type Name Description
    CapsuleGeometryAuthoring geometry

    SetConvexHull(ConvexHullGenerationParameters, Single)

    Declaration
    public void SetConvexHull(ConvexHullGenerationParameters hullGenerationParameters, float minimumSkinnedVertexWeight)
    Parameters
    Type Name Description
    ConvexHullGenerationParameters hullGenerationParameters
    Single minimumSkinnedVertexWeight

    SetConvexHull(ConvexHullGenerationParameters, Mesh)

    Declaration
    public void SetConvexHull(ConvexHullGenerationParameters hullGenerationParameters, Mesh customMesh = null)
    Parameters
    Type Name Description
    ConvexHullGenerationParameters hullGenerationParameters
    Mesh customMesh

    SetCylinder(CylinderGeometry)

    Declaration
    public void SetCylinder(CylinderGeometry geometry)
    Parameters
    Type Name Description
    CylinderGeometry geometry

    SetMesh(Mesh)

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

    SetPlane(float3, float2, quaternion)

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

    SetSphere(SphereGeometry, quaternion)

    Declaration
    public void SetSphere(SphereGeometry geometry, quaternion orientation)
    Parameters
    Type Name Description
    SphereGeometry geometry
    Unity.Mathematics.quaternion orientation

    Explicit Interface Implementations

    ISerializationCallbackReceiver.OnAfterDeserialize()

    Declaration
    void ISerializationCallbackReceiver.OnAfterDeserialize()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    ISerializationCallbackReceiver.OnBeforeSerialize()

    Declaration
    void ISerializationCallbackReceiver.OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()
    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