ScaleConstraint
Constrains the scale of a GameObject based on the scale of one or more sources.
Read time 7 minutesLast updated 7 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Animations
- Assembly: UnityEngine.AnimationModule
- Inherits from: Behaviour
- Implements: IConstraint
[RequireComponent(typeof(Transform))]public sealed class ScaleConstraint : Behaviour, IConstraint
Remarks
Use this constraint to scale a GameObject based on the scale of other sources. For example, use this constraint to scale UI elements based on the scale of a viewport. You can also adjust the weight of each source to influence whether the constrained GameObject follows the scale of one source over another source.
Refer to Scale Constraint Component for more details.
Examples
// This example uses a ScaleConstraint to constrain the scale of a GameObject based on 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 ScaleConstraintExample : MonoBehaviour{ public Transform sourceA; public Transform sourceB; private ScaleConstraint m_ScaleConstraint; void Start() { m_ScaleConstraint = gameObject.AddComponent<ScaleConstraint>(); ConstraintSource source1 = new ConstraintSource { sourceTransform = sourceA, weight = 0.7f }; ConstraintSource source2 = new ConstraintSource { sourceTransform = sourceB, weight = 0.3f }; m_ScaleConstraint.AddSource(source1); m_ScaleConstraint.AddSource(source2); m_ScaleConstraint.constraintActive = true; }}
Properties
Property | Description |
|---|---|
| constraintActive | Activates or deactivates the constraint. |
| locked | Locks the offset and scale at rest. |
| scaleAtRest | The scale used when the sources have a total weight of 0. |
| scaleOffset | The offset from the constrained scale. |
| scalingAxis | The axes affected by the ScaleConstraint. |
| 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. |