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

text stringlengths 0 17.2k
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 any keys that are unchanged from surrounding keys.

Here you can reference a list of the Anim Compress Remove Linear Keys, and a description of their function:

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 any keys where position and orientation of Assets are unchanged from surrounding keys.

Here you can reference a list of the Anim Compress Removes Trivial Keys, and a description of their function:

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

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.

Here you can reference a list of the available bitwise compression data formats, and a description of their function:

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

This codec compresses rich animation curves when compressing Animation Sequences. Here you can reference the Compress Rich Curve codec's properties and a description of their function:

This codec uniformly indexes animation curves when compressing Animation Sequences.

Bone Compression Codec Reference

Bitwise Compression Format Reference

Curve Compression Codec Reference

Compression

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.

Compression

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.

PerTrack

Set the following properties to control how the compression codec operates for each track: Max Zeroing Threshold: Set the maximum threshold to use when replacing a component with zero. Lower values retain more keys, but yield less compression. Max Pos Diff Bitwise: Set the 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 Bitwise: Set the 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 Bitwise: Set the maximum scale difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression. Allowed Rotation Formats: Set which encoding format the per-track compressor is allowed to try on rotation keys. For available options, see the Compression Format Reference. Allowed Translation Formats: Which encoding formats the per-track compressor is allowed to try on translation keys. For available options, see the Compression Format Reference Allowed Scale Formats: Which encoding formats the per-track compressor is allowed to try on scale keys. For available options, see the Compression Format Reference

Resampling

Set the following properties to control how the compression codec operates when resampling animation data: Resample Animation: When enabled, the codec will resample the animation's framerate with the value set as the Resample Framerate property's value. Resampled Framerate: When the Resampling property is enabled, set the framerate to resample animations with during compression. Min Keys for Resampling: Set the minimum number of keys an animation should have for a resample to be performed. All animations with fewer keys than this property, will not be resampled when compressing.

AdaptiveError

Set the following properties to control how the compression codec's error threshold values animation data: Use Adaptive Error: When enabled, the error threshold will be adjusted based on the height value within the skeleton. Use Override for End Effectors: When enabled, use the Min Effector Diff property's value as the threshold for end effectors. Track Height Bias: Set a value that is used to determine a bias that is added to the track height before using it to calculate the adaptive error. Parenting Divisor: When the UseAdpative Error property is enabled, set a value to reduce the error tolerance the further up the tree that a key occurs. The following is the formula used: EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold) Parenting Divisor Exponent: When the UseAdpative Error property is enabled, set a value to exponentially reduce the error tolerance the further up the tree that a key occurs. The following is the formula used: EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold)

AdaptiveError2

Set the following properties to apply additional control how the compression codec's error threshold values animation data: Use Additive Error 2: When enabled, the adaptive error system will determine how much error to allow for each track, based on the error introduced in end effectors due to errors in the track. Rotation Error Source Ratio: Set a value to determine the ratio of how much error in an end effector rotation can come from a given track's rotation error or translation error. If a value of 1 is used, all of it must come from rotation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from translation error. Translation Error Source Ratio: Set a value to determine the ratio of how much error in an end effector translation can come from a given track's rotation error or translation error. If a value of 1 is used, all of it must come from translation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from the rotation error. Scale Error Source Ratio: Set a value to determine the ratio of how much end effector scale error can come from a given track's rotation error or scale error. If a value of 1 is used, all of it must come from rotation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from the scale error. Max Error Per Track Ratio: Set a fraction value that determines how much of the total error budget can be introduced by any particular track.

LinearKeyRemoval

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 any keys that are unchanged from surrounding keys.

Here you can reference a list of the Anim Compress Remove Linear Keys, and a description of their function:

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 any keys where position and orientation of Assets are unchanged from surrounding keys.

Here you can reference a list of the Anim Compress Removes Trivial Keys, and a description of their function:

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

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.

Here you can reference a list of the available bitwise compression data formats, and a description of their function:

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

This codec compresses rich animation curves when compressing Animation Sequences. Here you can reference the Compress Rich Curve codec's properties and a description of their function:

This codec uniformly indexes animation curves when compressing Animation Sequences.

Bone Compression Codec Reference

Bitwise Compression Format Reference

Curve Compression Codec Reference

Compression

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.

Compression

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.

PerTrack

Set the following properties to control how the compression codec operates for each track: Max Zeroing Threshold: Set the maximum threshold to use when replacing a component with zero. Lower values retain more keys, but yield less compression. Max Pos Diff Bitwise: Set the 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 Bitwise: Set the 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 Bitwise: Set the maximum scale difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression. Allowed Rotation Formats: Set which encoding format the per-track compressor is allowed to try on rotation keys. For available options, see the Compression Format Reference. Allowed Translation Formats: Which encoding formats the per-track compressor is allowed to try on translation keys. For available options, see the Compression Format Reference Allowed Scale Formats: Which encoding formats the per-track compressor is allowed to try on scale keys. For available options, see the Compression Format Reference

Resampling

Set the following properties to control how the compression codec operates when resampling animation data: Resample Animation: When enabled, the codec will resample the animation's framerate with the value set as the Resample Framerate property's value. Resampled Framerate: When the Resampling property is enabled, set the framerate to resample animations with during compression. Min Keys for Resampling: Set the minimum number of keys an animation should have for a resample to be performed. All animations with fewer keys than this property, will not be resampled when compressing.

AdaptiveError

Set the following properties to control how the compression codec's error threshold values animation data: Use Adaptive Error: When enabled, the error threshold will be adjusted based on the height value within the skeleton. Use Override for End Effectors: When enabled, use the Min Effector Diff property's value as the threshold for end effectors. Track Height Bias: Set a value that is used to determine a bias that is added to the track height before using it to calculate the adaptive error. Parenting Divisor: When the UseAdpative Error property is enabled, set a value to reduce the error tolerance the further up the tree that a key occurs. The following is the formula used: EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold) Parenting Divisor Exponent: When the UseAdpative Error property is enabled, set a value to exponentially reduce the error tolerance the further up the tree that a key occurs. The following is the formula used: EffectiveErrorTolerance = Max(BaseErrorTolerance / p[ower( parentingDiviosor, Max(Heigh + Bias,0) * ParentingDivisiorExponent), ZeroingThreshold)

AdaptiveError2

Set the following properties to apply additional control how the compression codec's error threshold values animation data: Use Additive Error 2: When enabled, the adaptive error system will determine how much error to allow for each track, based on the error introduced in end effectors due to errors in the track. Rotation Error Source Ratio: Set a value to determine the ratio of how much error in an end effector rotation can come from a given track's rotation error or translation error. If a value of 1 is used, all of it must come from rotation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from translation error. Translation Error Source Ratio: Set a value to determine the ratio of how much error in an end effector translation can come from a given track's rotation error or translation error. If a value of 1 is used, all of it must come from translation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from the rotation error. Scale Error Source Ratio: Set a value to determine the ratio of how much end effector scale error can come from a given track's rotation error or scale error. If a value of 1 is used, all of it must come from rotation error. If a value of 0.5 is used, half of the error ratio can come from each. If a value of 0.0 is used, all of it must come from the scale error. Max Error Per Track Ratio: Set a fraction value that determines how much of the total error budget can be introduced by any particular track.

LinearKeyRemoval