AdamCodd/unreal-engine-5-raw · Datasets at Hugging Face

text stringlengths 0 17.2k
Set the threshold to trigger the interpolation in seconds.

Look at Target

Set a bone from the character's skeleton to use as the target socket to look at.

Look at Location

Set a reference point in world space to angle the Bone to Modify towards. When a bone is set as the Look Target, this property's value is factored in local space and used as an offset from the selected bone.

Remarks

Since the axis used as theLook at Axisis occupied, only the other axis will be used when clamping. For example, if theLook at AxisisZ, onlyX,Ydegree of clamp will be used.

Animation Compression Codec Reference

Compression Codecs are compression algorithms and methods you can use to drive Animation Compression Settings assets, to compress animation data. You can use the following document to reference a list and description of the available Bone and Curve Compression Codecs available in Unreal Engine.

Here you can reference each of the bone compression codecs packaged with Unreal Engine, as well as a description of their functionality and their available properties.

The Anim Compress Bitwise Compress Only codec focuses on Bitwise compression and retains all animation keys.

Here you can reference a list of the Anim Compress Bitwise Compress Only codec's properties and a description of their functionality:

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

The Anim Compress Least Destructive codec restores any present animation compression to raw data.

Here you can reference a list of the Anim Compress Least Destructive codec's properties and a description of their functionality:

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

The Anim Compress Per Track Compression codec focuses compression to a per-track basis, and compresses each track individually.

Here you can reference a list of the Anim Compress Per track Compression codec's properties and a description of their functionality:

Set the following properties to control how the compression codec operates for each track:

Set the following properties to control how the compression codec operates when resampling animation data:

Set the following properties to control how the compression codec's error threshold values animation data:

EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold)

EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold)

Set the following properties to apply additional control how the compression codec's error threshold values animation data:

Set the following properties to control how the compression codec removes linear keys from the animation data:

Max Pos Diff: Set a maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Angle Diff: Set a maximum angle difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Scale Diff: Set a maximum scale difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Effector Diff: As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changed by more than this amount as a result of removing a key, the key will be retained. This value is used for all bones except the end-effector's parent.

Min Effector Diff: As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changed by less than this amount as a result of removing a key, the key will be retained. This value is used for all bones except the end-effector's parent.

Effector Diff Socket: Set an error threshold for End Effectors with Sockets attached to them. Typically End Effectors with Sockets are more important bones, where you may want to be less aggressive with compression to retain more detail.

Parent Key Scale: Set a scale value which increases the likelihood that a bone will retain a key if its parent also had a key at the same time position. Higher values can remove shaking artifacts from the animation, at the cost of compression.

Retarget: When enabled, nodes will be adjusted to compensate for compression errors, as the animation is compressed. When disabled, no node adjustment will occur.

Actually Filter Linear Keys: When enabled, the final filtering step will occur, or only the retargeting after Bitwise compression. If this property is enabled and the Retarget property is disabled, then the linear compressor will do no better than the underlying bitwise compressor, and be extremely slow.

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

Removes every second key present in the animation.

Here you can reference a list of the Anim Compress Removes Every Second Key, and a description of their function:

Set the following properties to control how the compression codec removed keys:

Set the threshold to trigger the interpolation in seconds.

Look at Target

Set a bone from the character's skeleton to use as the target socket to look at.

Look at Location

Set a reference point in world space to angle the Bone to Modify towards. When a bone is set as the Look Target, this property's value is factored in local space and used as an offset from the selected bone.

Remarks

Since the axis used as theLook at Axisis occupied, only the other axis will be used when clamping. For example, if theLook at AxisisZ, onlyX,Ydegree of clamp will be used.

Animation Compression Codec Reference

Compression Codecs are compression algorithms and methods you can use to drive Animation Compression Settings assets, to compress animation data. You can use the following document to reference a list and description of the available Bone and Curve Compression Codecs available in Unreal Engine.

Here you can reference each of the bone compression codecs packaged with Unreal Engine, as well as a description of their functionality and their available properties.

The Anim Compress Bitwise Compress Only codec focuses on Bitwise compression and retains all animation keys.

Here you can reference a list of the Anim Compress Bitwise Compress Only codec's properties and a description of their functionality:

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

The Anim Compress Least Destructive codec restores any present animation compression to raw data.

Here you can reference a list of the Anim Compress Least Destructive codec's properties and a description of their functionality:

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

The Anim Compress Per Track Compression codec focuses compression to a per-track basis, and compresses each track individually.

Here you can reference a list of the Anim Compress Per track Compression codec's properties and a description of their functionality:

Set the following properties to control how the compression codec operates for each track:

Set the following properties to control how the compression codec operates when resampling animation data:

Set the following properties to control how the compression codec's error threshold values animation data:

EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold)

Set the following properties to apply additional control how the compression codec's error threshold values animation data:

Set the following properties to control how the compression codec removes linear keys from the animation data:

Max Pos Diff: Set a maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Angle Diff: Set a maximum angle difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Scale Diff: Set a maximum scale difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

Max Effector Diff: As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changed by more than this amount as a result of removing a key, the key will be retained. This value is used for all bones except the end-effector's parent.

Min Effector Diff: As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changed by less than this amount as a result of removing a key, the key will be retained. This value is used for all bones except the end-effector's parent.

Effector Diff Socket: Set an error threshold for End Effectors with Sockets attached to them. Typically End Effectors with Sockets are more important bones, where you may want to be less aggressive with compression to retain more detail.

Parent Key Scale: Set a scale value which increases the likelihood that a bone will retain a key if its parent also had a key at the same time position. Higher values can remove shaking artifacts from the animation, at the cost of compression.

Retarget: When enabled, nodes will be adjusted to compensate for compression errors, as the animation is compressed. When disabled, no node adjustment will occur.

Actually Filter Linear Keys: When enabled, the final filtering step will occur, or only the retargeting after Bitwise compression. If this property is enabled and the Retarget property is disabled, then the linear compressor will do no better than the underlying bitwise compressor, and be extremely slow.

Set the following properties to control how the compression codec formats the compressed animation data:

Translation Compression Format: Set the format for bitwise compression of translation data. See the Compression Format Reference for more information.

Rotation Compression Format: Set the format for bitwise compression of rotation data. See the Compression Format Reference for more information.

Scale Compression Format: Set the format for bitwise compression of scale data. See the Compression Format Reference for more information.

Description: Set a description for this codec.

Removes every second key present in the animation.

Here you can reference a list of the Anim Compress Removes Every Second Key, and a description of their function:

Set the following properties to control how the compression codec removed keys: