Clip reader

The clip reader module reads an animation clip and applies it to the group agents.



Attributes

AttributesTypeOverridableDescription
behave3dboolnoIf true, the agents will move freely in 3D as if they were particles. The Particle operator is going to be applied instead of the Pelvis and Foot Operators.
clipNamestringyesThe animation clip name.
fixLegStretchboolnoIf true, compensate the leg stretching.
frameRatestringyesThe frame rate used for playing the agent animation.
gravityFieldstringnoThe name of the gravity field.
heightFieldstringnoThe name of the height field.
heightFieldOffsetdoublenoAn extra offset applied to your agent heights from the ground.
seedintnoSeed random value.
startFramedoubleyesThe start frame of the clip. If set to a value lower than 0, a random value is used instead.
frameOffsetintyesA frame offset
debug boolnoEnables module debug drawing.
maxUpAxisAngledoubleyesMaximum up axis rotation angle in degrees
alignUpAxisTresholdAngledoubleyesThreshold angle used to realign the agent up axis with the global up axis
sitAdaptationboolyesIf on, the agent will adapt to the height field when playing sitting clips. The sitting factor must be properly configured for the clip being played.
softIkDistancedouble yesThe soft ik distance used by the IK algorithm. Set this value to 0 to disable the soft IK
useClipDirectionboolyesIf on, the clip direction is used instead of the agent direction metadata
disableFootLockOnLegStretchboolyesDisables the foot lock when leg stretches too much compared to the bind leg length.
legStretchMaxRatiodoubleyesWhen disableFootLockOnLegStretch is on, this value provides the maximum ratio between the current leg length and the bind leg length. The foot lock is disabled when the ratio is greater than the given value.


Copyright © 2017, Toolchefs LTD.