docs.unity3d.com
    Show / Hide Table of Contents

    Class EndJointConversionSystem

    A system that is updated after all built-in conversion systems that produce PhysicsJoint.

    Inheritance
    Object
    EndJointConversionSystem
    Namespace: Unity.Physics.Authoring
    Syntax
    public class EndJointConversionSystem : GameObjectConversionSystem

    Methods

    CreateJointEntities(UnityEngine.Component, PhysicsConstrainedBodyPair, NativeArray<PhysicsJoint>, NativeList<Entity>)

    Create several new entities for a joint associated with the specified authoring component. Other systems can later find these joints by using GetJointEntities(UnityEngine.Component, NativeList<Entity>). Use this method instead of CreateJointEntity(UnityEngine.Component, PhysicsConstrainedBodyPair, PhysicsJoint) when the behavior specified by the authoring component requires multiple PhysicsJoint components to describe. The new entities will have all required component types, buffers, as well as readable names in the Entity Debugger.

    Declaration
    public void CreateJointEntities(UnityEngine.Component authoringComponent, PhysicsConstrainedBodyPair constrainedBodyPair, NativeArray<PhysicsJoint> joints, NativeList<Entity> newJointEntities = null)
    Parameters
    Type Name Description
    UnityEngine.Component authoringComponent

    An authoring component being converted.

    PhysicsConstrainedBodyPair constrainedBodyPair

    A component describing the bodies constrained by the joints.

    NativeArray<PhysicsJoint> joints

    The set of reference frames and corresponding constraints to apply to the bodies.

    NativeList<Entity> newJointEntities

    An optional list to populate with all of the new entities.

    CreateJointEntity(UnityEngine.Component, PhysicsConstrainedBodyPair, PhysicsJoint)

    Create a new entity for a joint associated with the specified authoring component. Other systems can later find this joint by using GetJointEntities(UnityEngine.Component, NativeList<Entity>). Use this method when the behavior specified by the authoring component can be described with a single PhysicsJoint (see also CreateJointEntities(UnityEngine.Component, PhysicsConstrainedBodyPair, NativeArray<PhysicsJoint>, NativeList<Entity>)). The new entity will have all required component types as well as a readable name in the Entity Debugger.

    Declaration
    public Entity CreateJointEntity(UnityEngine.Component authoringComponent, PhysicsConstrainedBodyPair constrainedBodyPair, PhysicsJoint joint)
    Parameters
    Type Name Description
    UnityEngine.Component authoringComponent

    An authoring component being converted.

    PhysicsConstrainedBodyPair constrainedBodyPair

    A component describing the bodies constrained by the joint.

    PhysicsJoint joint

    The reference frames and set of constraints to apply to the bodies.

    Returns
    Type Description
    Entity

    A new entity with all required component types.

    GetJointEntities(UnityEngine.Component, NativeList<Entity>)

    Get all joint entities that have been produced by the specified authoring component. In order to work, these entities must have been produced by either CreateJointEntity(UnityEngine.Component, PhysicsConstrainedBodyPair, PhysicsJoint) or CreateJointEntities(UnityEngine.Component, PhysicsConstrainedBodyPair, NativeArray<PhysicsJoint>, NativeList<Entity>).

    Declaration
    public void GetJointEntities(UnityEngine.Component authoringComponent, NativeList<Entity> jointEntities)
    Parameters
    Type Name Description
    UnityEngine.Component authoringComponent

    The authoring component that produced one or more joint entities.

    NativeList<Entity> jointEntities

    A list to populate with all of the joint entities.

    OnDestroy()

    Declaration
    protected override void OnDestroy()

    OnUpdate()

    Declaration
    protected override void OnUpdate()
    Back to top
    Terms of use
    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