Class Kinematica
This component is a wrapper around the motion synthesizer.
Inherited Members
Namespace: Unity.Kinematica
Assembly: solution.dll
Syntax
[DisallowMultipleComponent]
[RequireComponent(typeof(Animator))]
[AddComponentMenu("Kinematica/Kinematica")]
public class Kinematica : SnapshotProvider, Serializable, IFrameDebugProvider, IMotionSynthesizerProviderRemarks
The motion synthesizer represents the actual core implementation of Kinematica which can be used in a pure DOTS environment directly. It provides a raw transform buffer which represents the current character pose and does not provide any infrastructure to feed the current pose to the character.
The Kinematica component is a wrapper around the motion synthesizer that can be used in scenarios where Kinematica is to be used in conjunction with stock Unity Game Objects.
It establishes a Playable graph that forwards the character pose to the Animator component. It also provides automatic snapshots and rewind functionality, i.e. no additional user code is required to support snapshot debugging of the Kinematica component.
The Kinematica component is not necessary to run Kinematica and all its associated tools (execution graph, snapshot debugger...), it is provided as an example on how to use Kinematica inside a component.
Fields
| Name | Description |
|---|---|
| _deltaTime | Denotes the delta time in seconds to be used during this frame. |
| applyRootMotion | |
| blendDuration | Denotes the default blend duration for the motion synthesizer. |
| resource | Allows access to the underlying Kinematica runtime asset. |
Properties
| Name | Description |
|---|---|
| Binary | Allows direct access to the underlying Kinematica runtime asset. |
| IsSynthesizerInitialized | |
| Query | Generates a new semantic query. |
| Synthesizer | Allows direct access to the motion synthesizer. |
Methods
| Name | Description |
|---|---|
| AddJobDependency(JobHandle) | Schedules the job handle passed as argument as a dependency of the Animator component. |
| EarlyUpdate() | This callback will be automatically invoked during UnityEngine.PlayerLoop.EarlyUpdate(). |
| GetDisplayName() | |
| GetUniqueIdentifier() | |
| LateUpdate() | return the currently active animation frames |
| OnAnimatorMove() | Handler method which gets invoked during the animator update. |
| OnDisable() | Override for OnDisable() |
| OnEarlyUpdate(bool) | Override for OnEarlyUpdate() which will be invoked as part of the snapshot debugger infrastructure during the execution of UnityEngine.PlayerLoop.EarlyUpdate. |
| OnEnable() | Override for OnEnable(). |
| PlayFirstSequence(QueryResult) | Play the first sequence from |
| ReadFromStream(Buffer) | Retrieves the contents of the Kinematica component from the buffer passed as argument. |
| Update() | Called during the regular game object update loop. |
| WriteToStream(Buffer) | Stores the contents of the Kinematica component in the buffer passed as argument. |