Struct Binary
Memory-ready runtime asset that contains the animation library and supplementary information required by the Kinematica runtime.
Namespace: Unity.Kinematica
Assembly: solution.dll
Syntax
public struct BinaryRemarks
Kinematica strictly distinguishes between the editor and runtime asset. The asset builder in the Unity editor generates the runtime asset from from the editor asset. Conceptionally both representations are identical. The runtime asset contains additional acceleration structures.
Properties
| Name | Description |
|---|---|
| SampleRate | Returns the sample rate as number of samples per second. |
| TimeHorizon | Time horizon in seconds. |
| numCodeBooks | Returns the number of code books stored in the runtime asset. |
| numIntervals | Returns the number of intervals stored in the runtime asset. |
| numJoints | Returns the number of animation rig joints. |
| numMarkers | Returns the number of markers stored in the runtime asset. |
| numPoses | Returns the number of individual animation poses stored in the runtime asset. |
| numSegments | Returns the number of segments stored in the runtime asset. |
| numTagLists | Returns the number of tag lists stored in the runtime asset. |
| numTags | Returns the number of tags stored in the runtime asset. |
| numTraits | Returns the number of traits stored in the runtime asset. |
Methods
| Name | Description |
|---|---|
| Advance(SamplingTime, float) | Advances a sampling time by a certain amount of time. |
| Contains(ref TagList, TraitIndex) | Checks if a given trait belongs to a given trait list. |
| Contains(TagListIndex, TraitIndex) | Checks if a given trait belongs to a given trait list. |
| CreatePoseFragment(MetricIndex, SamplingTime) | Create a pose fragment from a sampling time. |
| CreateTrajectoryFragment(MetricIndex, NativeSlice<AffineTransform>) | Creates a trajectory fragment from sequence of root transforms. |
| CreateTrajectoryFragment(MetricIndex, SamplingTime) | Creates a trajectory fragment from a sampling time. |
| DebugDrawPoseWorldSpace(AffineTransform, int, Color) | Debug visualization for animation poses. |
| DebugDrawPoseWorldSpace(AffineTransform, float, Color) | Debug visualization for animation poses. |
| DebugDrawPoseWorldSpace(AffineTransform, SamplingTime, Color) | Debug visualization for animation poses. |
| DebugDrawTrajectory(AffineTransform, int, int, Color) | Debug visualization for trajectories. |
| DebugDrawTrajectory(AffineTransform, float, float, Color) | Debug visualization for trajectories. |
| DebugDrawTrajectory(AffineTransform, SamplingTime, float, Color) | Debug visualization for trajectories. |
| DebugDrawTransform(AffineTransform, float, float) | Debug visualization for transforms, i.e. a position and rotation. |
| GetAverageTrajectorySpeed(SamplingTime, float) | |
| GetCodeBook(CodeBookIndex) | Retrieves a reference to a codebook stored in the runtime asset. |
| GetCodeBookAt(TimeIndex) | Returns a codebook index for a time index. |
| GetCodeBookFragmentIndex(ref CodeBook, TimeIndex) | Retrieve fragment index inside codebook that is associated to a time index |
| GetFragmentDebugText(SamplingTime, string, float) | |
| GetInterval(IntervalIndex) | Retrieves a reference to an interval stored in the runtime asset. |
| GetMarker(MarkerIndex) | Retrieves a reference to a marker stored in the runtime asset. |
| GetPayload<T>(int) | Retrieves a reference to a payload stored in the runtime asset. |
| GetPayload<T>(TraitIndex) | Retrieves the associated payload (i.e. the instance of the user-defined value) for a given trait index. |
| GetSegment(SegmentIndex) | Retrieves a reference to a segment stored in the runtime asset. |
| GetString(int) | Retrieves a string that corresponds to the index passed as argument. |
| GetTag(TagIndex) | Retrieves a reference to a tag stored in the runtime asset. |
| GetTagIndex(ref TagList, int) | Returns the tag index from the tag list at given index |
| GetTagList(TagListIndex) | Retrieves a tag list given a tag list index from the runtime asset. |
| GetTrait(TraitIndex) | Retrieves a reference to a trait stored in the runtime asset. |
| GetTraitIndex<T>(T) | Converts a value to a trait index. |
| GetTrajectoryTransform(int) | Retrieves the root transform for an animation frame. |
| GetTrajectoryTransform(float) | Retrieves the root transform for a sample time in seconds. |
| GetTrajectoryTransform(DeltaSamplingTime) | Retrieves the root transform displacement for a delta sampling time. |
| GetTrajectoryTransform(SamplingTime) | Retrieves the root transform for a sampling time. |
| GetTrajectoryTransformBetween(int, int) | Calculates the relative root transform displacement between a frame and an offset. |
| GetTrajectoryTransformBetween(SamplingTime, float) | Calculates the relative root transform between a sampling time and a delta time in seconds. |
| GetTypeIndex<T>() | Converts the generic type into a type index. |
| IndexToTimeInSeconds(int) | Converts a frame index to the corresponding time in seconds. |
| IsPayload<T>(ref T, int) | Determines whether the specified trait value matches a payload stored in the runtime asset. |
| IsType(MarkerIndex, TypeIndex) | Determines whether the specified marker is an instance of the type passed as argument. |
| IsValid(SamplingTime) | Determines if a given sampling time is valid. |
| IsValid(TimeIndex) | Determines if a given time index is valid. |
| ReconstructPoseFragment(SamplingTime) | Reconstructs a pose fragment from the runtime asset that corresponds to a sampling time. |
| ReconstructTrajectoryFragment(SamplingTime) | Reconstructs a trajectory fragment for a given sampling time in the runtime asset. |
| TimeInSecondsToIndex(float) | Converts a time in seconds to an index. |