Interface IRigConstraint
This interface is used to represent all constraints classes.
Namespace: UnityEngine.Animations.Rigging
Syntax
public interface IRigConstraintProperties
binder
The job binder for the constraint.
Declaration
IAnimationJobBinder binder { get; }Property Value
| Type | Description |
|---|---|
| IAnimationJobBinder |
component
The component for the constraint.
Declaration
Component component { get; }Property Value
| Type | Description |
|---|---|
| Component |
data
The data container for the constraint.
Declaration
IAnimationJobData data { get; }Property Value
| Type | Description |
|---|---|
| IAnimationJobData |
weight
The constraint weight. This is a value in between 0 and 1.
Declaration
float weight { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Methods
CreateJob(Animator)
Creates the animation job for this constraint.
Declaration
IAnimationJob CreateJob(Animator animator)Parameters
| Type | Name | Description |
|---|---|---|
| Animator | animator | The animated hierarchy Animator component. |
Returns
| Type | Description |
|---|---|
| IAnimationJob | Returns the newly instantiated job. |
DestroyJob(IAnimationJob)
Frees the specified job memory.
Declaration
void DestroyJob(IAnimationJob job)Parameters
| Type | Name | Description |
|---|---|---|
| IAnimationJob | job | The job to destroy. |
IsValid()
Retrieves the constraint valid state.
Declaration
bool IsValid()Returns
| Type | Description |
|---|---|
| Boolean | Returns true if constraint data can be successfully evaluated. Returns false otherwise. |
UpdateJob(IAnimationJob)
Updates the specified job data.
Declaration
void UpdateJob(IAnimationJob job)Parameters
| Type | Name | Description |
|---|---|---|
| IAnimationJob | job | The job to update. |