PositionConstraint
Constrains the position of an object relative to the position of one or more source objects.
Read time 6 minutesLast updated 4 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
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. |