LookAtConstraint
Constrains the orientation 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 LookAtConstraint : Behaviour, IConstraint
Remarks
This constraint is similar to AimConstraint but is meant for constraining a Camera. Use this constraint to point a Camera towards other sources. You can also adjust the weight of each source to influence whether the Camera points more towards one source over another source.
Make sure you use properties to align the orientation of the constraint. Otherwise, the constrained Camera might point in the wrong direction.
LookAtConstraintRefer to Look At Constraint Component for more details.
Examples
// This example uses a LookAtConstraint to point a GameObject towards two sources. // The first source has a greater influence than the second source based on their assigned weight.using UnityEngine;using UnityEngine.Animations;public class LookAtExample : MonoBehaviour{ public Transform sourceA; public Transform sourceB; private LookAtConstraint m_LookAtConstraint; void Start() { m_LookAtConstraint = gameObject.AddComponent<LookAtConstraint>(); ConstraintSource source1 = new ConstraintSource { sourceTransform = sourceA, weight = 0.6f }; ConstraintSource source2 = new ConstraintSource { sourceTransform = sourceB, weight = 0.4f }; m_LookAtConstraint.AddSource(source1); m_LookAtConstraint.AddSource(source2); m_LookAtConstraint.constraintActive = true; }}
Properties
Property | Description |
|---|---|
| constraintActive | Activates or deactivates the constraint. |
| locked | Locks the offset and rotation at rest. |
| roll | The rotation angle along the z axis of the object. The constraint uses this property to calculate the world up vector when UseUpObject is false. |
| rotationAtRest | The rotation used when the sources have a total weight of 0. |
| rotationOffset | Represents an offset from the constrained orientation. |
| sourceCount | The number of sources set on the component (Read Only). |
| useUpObject | Determines how the up vector is calculated. |
| weight | The weight of the constraint component. |
| worldUpObject | The world up object, used to calculate the world up vector when UseUpObject is true. |
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. |