Namespace Unity.Kinematica

Classes

DataAttribute

Attribute used to annotate data types that are used as elements in the task graph.

DataType

Data types are identified by annotating a user-defined struct with the data attribute. All data types are collected at startup in the data type collection.

Extensions

Static class that contains various extension methods.

Kinematica

This component is a wrapper around the motion synthesizer.

PropertyAttribute

Attribute used to annotate task properties.

ReadExtensions

Static class that contains various extension methods that allow reading data types from a buffer.

TaskExtensions

Static class that contains various extension methods that allow tasks to be created. Tasks in turn offer similar methods that allow for a concise notion when creation arbitrary complex task graphs.

Utility

Static class that contains various extension methods.

WriteExtensions

Static class that contains various extension methods that allow writing data types to a buffer.

Structs

ActionTask

An action task acts as a grouping mechanism for tasks.

AnimationFrameDebugInfo

Informations about a played animation during one given frame that will feed the animation timeline in the snapshot debugger

Binary

Memory-ready runtime asset that contains the animation library and supplementary information required by the Kinematica runtime.

Binary.CodeBook

A codebook contains the necessary information to perform fast comparisons for poses and trajectories. Poses and trajectories can be compared separately.

An encoding contains the necessary information to perform fast comparisons between fragments. Fragments represent either poses or trajectories and are automatically created for all animation frames the codebook covers.

Binary.CodeBookIndex

Denotes an index into the list of codebooks contained in the runtime asset.

Binary.Interval

An interval contains information about a sequence of animation frames that collectively share the same set of tags.

Binary.IntervalIndex

Denotes an index into the list of intervals contained in the runtime asset.

Binary.Marker

Markers are used to associate a trait to a single animation frame.

Binary.MarkerIndex

Denotes an index into the list of markers contained in the runtime asset.

Binary.MetricIndex

Denotes an index into the list of metrics contained in the runtime asset.

Binary.PoseFragment

A pose fragment contains information necessary to perform similarity calculations between animation poses.

Binary.Segment

An segment contains information about animation frames that have been extracted from the supplied animation clips during the build process.

Binary.Segment.Interval

Denotes a sequence of animation frames

Binary.SegmentIndex

Denotes an index into the list of segments contained in the runtime asset.

Binary.Tag

Tags are used to associate a trait to a sequence of animation frames.

Binary.TagIndex

Denotes an index into the list of tags contained in the runtime asset.

Binary.TagList

Tag lists are created during the runtime asset build process based on the annotations that have been made at authoring time. Each unique combination of tags that is used for annotation purposes generates a unique tag list which is accessible via an index. This scheme is used extensively to speed up the execution of queries.

Binary.TagListIndex

Denotes an index into the list of tag lists contained in the runtime asset.

Binary.Trait

Traits are user-defined characteristics that can be associated to tags or markers.

Binary.TraitIndex

Denotes an index into the list of traits contained in the runtime asset.

Binary.TrajectoryFragment

A trajectory fragment contains information necessary to perform similarity calculations between trajectories.

Binary.TypeIndex

Denotes an index into the list of types contained in the runtime asset.

BinaryReference

Reference to the runtime asset.

BlittableBool

Plain struct that wraps a boolean value into a DOTS compatible data type.

ConditionTask

The condition task executes its child based on an internal condition that can be controlled externally.

CurrentPoseTask

The current pose task updates a sampling time based on the current sampling time of the motion synthesizer.

Default

Default trait used in the Kinematica asset builder tool.

DeltaSamplingTime

A delta sampling time is used to uniquely identfy a sub-sampled animation frame and optionally a root transform offset that occured while reading across segment boundaries.

Identifier<T>

Wrapper around a memory identifier that carries the type of the memory identifier.

MemoryArray<T>

A memory array is very similar in nature to a NativeArray. It stores a reference to an array of data elements and allows for retrieval of inidividual elements. This is a workaround for the inability to nest NativeArrays.

MemoryHeader<T>

A memory header maintains a chunk of memory that contains an arbitrary collection of nested value types. This is a workaround for the inability to nest NativeArrays.

MemoryIdentifier

Memory identifiers are used to uniquely identify data types and tasks that are part of Kinematica's task graph.

MemoryRef<T>

A memory reference allows a ref value to be stored in memory and later to be converted back into its ref value.

MotionSynthesizer

The motion synthesizer is the actual core component of Kinematica.

NavigationParams

Parameters of navigation query asked to Kinematica in order to move an agent along a path made of control points

NavigationTask

ParallelTask

The parallel task executes all of its children in order until it encounters a non-success status.

PoseSequence

Data type that refers to a sequence of animation poses.

PushTask

The push task injects a referenced time index into the pose stream of the motion synthesizer.

Query

Entry point for semantic filtering based query language.

QueryMarkerExpression

Marker expressions represent semantic filtering of animation poses that are based on marker types.

QueryResult

A query result is wrapper around a pose sequence and is the result of a semantic filtering query.

QueryTraitExpression

Trait expressions represent semantic filtering of animation poses that are based on tag traits.

ReduceTask

The reduce task accepts a list of animation pose sequences and a reference animation pose as its inputs. It outputs the animation pose from the input pose sequence that is most similar to the reference animation pose. A trajectory can optionally be supplied as an additional constraint.

Interfaces

Task

Tasks represent executable code that runs as part of the motion synthesizer job and can control the pose selection process.

Trait

Interface for traits.

Enums

DataType.Flag

Optional flags used to control data type behavior.

Result

Result of a task execution.