RotationConstraint
Constrains the rotation of a GameObject based on the rotation of one or more sources.
Read time 7 minutesLast updated 8 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Animations
- Assembly: UnityEngine.AnimationModule
- Inherits from: Behaviour
- Implements: IConstraint
[RequireComponent(typeof(Transform))]public sealed class RotationConstraint : Behaviour, IConstraint
Remarks
Use this constraint to rotate a GameObject based on the rotation of other sources. For example, you can use this constraint to synchronize spinning gears in a machine. You can also adjust the weight of each source to influence whether the constrained GameObject follows the rotation of one source over another source.
Refer to Rotation Constraint Component for more details.
Examples
// This example uses a RotationConstraint to constrain the rotation 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 RotationConstraintExample : MonoBehaviour{ public Transform sourceA; public Transform sourceB; private RotationConstraint m_RotationConstraint; void Start() { m_RotationConstraint = gameObject.AddComponent<RotationConstraint>(); ConstraintSource source1 = new ConstraintSource { sourceTransform = sourceA, weight = 0.5f }; ConstraintSource source2 = new ConstraintSource { sourceTransform = sourceB, weight = 0.5f }; m_RotationConstraint.AddSource(source1); m_RotationConstraint.AddSource(source2); m_RotationConstraint.constraintActive = true; }}
Properties
Property | Description |
|---|---|
| constraintActive | Activates or deactivates the constraint. |
| locked | Locks the offset and rotation at rest. |
| rotationAtRest | The rotation used when the sources have a total weight of 0. |
| rotationAxis | The axes affected by the RotationConstraint. |
| rotationOffset | The offset from the constrained rotation. |
| sourceCount | The number of sources set on the component (read-only). |
| 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. |