Struct ChainIKConstraintJob

The ChainIK constraint job.

Implements

IWeightedAnimationJob

IAnimationJob

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Animations.Rigging

Assembly: Unity.Animation.Rigging.dll

Syntax

[BurstCompile]
public struct ChainIKConstraintJob : IWeightedAnimationJob, IAnimationJob

Fields

cache

Cache for static properties in the job.

Declaration

public AnimationJobCache cache

Field Value

Type	Description
AnimationJobCache

chain

An array of Transform handles that represents the Transform chain.

Declaration

public NativeArray<ReadWriteTransformHandle> chain

Field Value

Type	Description
NativeArray<ReadWriteTransformHandle>

chainRotationWeight

The weight for which ChainIK target has an effect on chain (up to tip Transform). This is a value in between 0 and 1.

Declaration

public FloatProperty chainRotationWeight

Field Value

Type	Description
FloatProperty

linkLengths

An array of length in between Transforms in the chain.

Declaration

public NativeArray<float> linkLengths

Field Value

Type	Description
NativeArray<float>

linkPositions

An array of positions for Transforms in the chain.

Declaration

public NativeArray<Vector3> linkPositions

Field Value

Type	Description
NativeArray<Vector3>

maxIterationsIdx

CacheIndex to ChainIK maxIterations value.

Declaration

public CacheIndex maxIterationsIdx

Field Value

Type	Description
CacheIndex

See Also

AnimationJobCache

maxReach

The maximum distance the Transform chain can reach.

Declaration

public float maxReach

Field Value

Type	Description
float

target

The Transform handle for the target Transform.

Declaration

public ReadOnlyTransformHandle target

Field Value

Type	Description
ReadOnlyTransformHandle

targetOffset

The offset applied to the target transform if maintainTargetPositionOffset or maintainTargetRotationOffset is enabled.

Declaration

public AffineTransform targetOffset

Field Value

Type	Description
AffineTransform

tipRotationWeight

The weight for which ChainIK target has and effect on tip Transform. This is a value in between 0 and 1.

Declaration

public FloatProperty tipRotationWeight

Field Value

Type	Description
FloatProperty

toleranceIdx

CacheIndex to ChainIK tolerance value.

Declaration

public CacheIndex toleranceIdx

Field Value

Type	Description
CacheIndex

See Also

AnimationJobCache

Properties

jobWeight

The main weight given to the constraint. This is a value in between 0 and 1.

Declaration

public FloatProperty jobWeight { readonly get; set; }

Property Value

Type	Description
FloatProperty

Methods

ProcessAnimation(AnimationStream)

Defines what to do when processing the animation.

Declaration

public void ProcessAnimation(AnimationStream stream)

Parameters

Type	Name	Description
AnimationStream	stream	The animation stream to work on.

ProcessRootMotion(AnimationStream)

Defines what to do when processing the root motion.

Declaration

public void ProcessRootMotion(AnimationStream stream)

Parameters

Type	Name	Description
AnimationStream	stream	The animation stream to work on.

Implements

IWeightedAnimationJob

IAnimationJob