FlexiMotionRuntime Class

Summary

Manages the was the FlexiMotion.FlexiMotionRuntime.RuntimeSprings simulation is updates.
Assembly
FlexiMotion.dll
Namespace
FlexiMotion
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IJobSource"] click Interface0 "/flexi-motion/api/FlexiMotion.Jobs/IJobSource" Type-.->Interface1["IDisposable"] Type["FlexiMotionRuntime"] class Type type-node

Syntax

public class FlexiMotionRuntime : IJobSource, IDisposable

Constructors

Name Summary
FlexiMotionRuntime(FlexiMotionDefinition, JobModifierGroup) Creates a new FlexiMotion.FlexiMotionRuntime.

Fields

Name Constant Value Summary
RuntimeSprings
The simulation manager.

Properties

Name Value Summary
DeltaTime float
The FlexiMotion.Jobs.SpringSimulationJob.DeltaTime.
IsEnabled bool
Is the simulation currently running?
MaximumUpdatesPerFrame int
The most updates that can occur in a single tick of the FlexiMotion.FlexiMotionRuntime.UpdateMode to meet the required number of FlexiMotion.FlexiMotionRuntime.UpdatesPerSecond.
static
TargetJobSources List<IJobSource>
The FlexiMotion.Jobs.JobScheduller for the current FlexiMotion.FlexiMotionRuntime.UpdateMode.
UpdateInterval float
The inverse of FlexiMotion.FlexiMotionRuntime.UpdatesPerSecond.
UpdateMode AnimatorUpdateMode
Determines when the simulation will be updated and how its delta time is calculated.
UpdatesPerSecond float
Determines how often the simulation will be updated.
UpdateTimer float
The timer used to enforce the correct number of FlexiMotion.FlexiMotionRuntime.UpdatesPerSecond.

Methods

Name Value Summary
Disable() bool
Removes this simulation to stop receiving updates.
Dispose() void
Cleans up this simulation.
DrawGizmos() void
Draws scene gizmos for the FlexiMotion.FlexiMotionRuntime.RuntimeSprings.
Enable() void
Registers this simulation to receive updates.
RecenterSprings() void
Runs a FlexiMotion.Jobs.RecenterSpringsJob.
ResetSprings() void
Runs a FlexiMotion.Jobs.ResetSpringsJob.
ResetTransforms() void
Runs an FlexiMotion.Jobs.ApplyRotationsJob to return all springs to their starting rotations.
ScheduleJob(float, JobHandle) JobHandle
Schedules jobs to update this simulation.

Extension Methods

Name Value Summary
LogTemp<FlexiMotionRuntime>(Object) T
Debug.Log(message, context) with an [System.ObsoleteAttribute] warning so you remember to remove any calls.
SafeGetHashCode<FlexiMotionRuntime>() int
Uses System.Collections.Generic.EqualityComparer`1.Default to get a hash code.