PositionConstraint
Constrains the position of a GameObject based on the position of one or more sources.
Read time 7 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Animations
- Assembly: UnityEngine.AnimationModule
- Inherits from: Behaviour
- Implements: IConstraint
[RequireComponent(typeof(Transform))]public sealed class PositionConstraint : Behaviour, IConstraint
Remarks
Use this constraint to move a GameObject based on the position of other sources. For example, you can use this constraint to align collectibles with a moving player. You can also adjust the weight of each source to influence whether the constrained GameObject follows the position of one source over another source.
Refer to Position Constraint Component for more details.
Examples
// This example uses a PositionConstraint to constrain the position of a GameObject based on two sources.// Each source has an equal influence based on their assigned weight.using UnityEngine;using UnityEngine.Animations;public class PositionConstraintExample : MonoBehaviour{ public Transform sourceA; public Transform sourceB; private PositionConstraint m_PositionConstraint; void Start() { m_PositionConstraint = gameObject.AddComponent<PositionConstraint>(); ConstraintSource source1 = new ConstraintSource { sourceTransform = sourceA, weight = 0.5f }; ConstraintSource source2 = new ConstraintSource { sourceTransform = sourceB, weight = 0.5f }; m_PositionConstraint.AddSource(source1); m_PositionConstraint.AddSource(source2); m_PositionConstraint.constraintActive = true; }}
Properties
Property | Description |
|---|---|
| constraintActive | Activates or deactivates the constraint. |
| locked | Locks the offset and position at rest. |
| sourceCount | The number of sources set on the component (read-only). |
| translationAtRest | The translation used when the sources have a total weight of 0. |
| translationAxis | The axes affected by the PositionConstraint. |
| translationOffset | The offset from the constrained position. |
| weight | The weight of the constraint component. |
Methods
Method | Description |
|---|---|
| AddSource | Adds a constraint source. |
| GetSource | Gets a constraint source by index. |
| GetSources | Gets the list of sources. |
| RemoveSource | Removes a source from the component. |
| SetSource | Sets a source at a specified index. |
| SetSources | Sets the list of sources on the component. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |