Engine.AnimSequence

Extends

Object

Modifiers

native ( Anim ) config ( Engine ) hidecategories ( Object )

One animation sequence of keyframes. Contains a number of tracks of data. The Outer of AnimSequence is expected to be its AnimSet. Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.AnimSequence

Functions Summary
	float	GetNotifyTimeByClass (class<AnimNotify> NotifyClass, optional float PlayRate = 1.f, optional float StartPosition = -1.f, optional out AnimNotify out_Notify, optional out float out_Duration)

AdditiveBasePose Source code

Store Reference Pose animation used to create this additive one. For playback in editor only.

AdditiveBasePoseAnimSeq Source code

If this animation is Additive, this is the reference to the Base Pose used. For automatic rebuilding in the editor. Made into a list to handle duplicate animations.

AdditiveRefName Source code

Reference animation name

AdditiveRefPose Source code

Reference pose for additive animation. Deprecated.

AdditiveTargetPoseAnimSeq Source code

If this animation is Additive, this is the reference to the Target Pose used. For automatic rebuilding in the editor. Made into a list to handle duplicate animations.

AnimTags Source code

Animation tag for stat system: This is temporary until we can add content tag to animation Currently it auto tags based on "contains" - Check DefaultEngine.ini for modification

bAdditiveBuiltLooping Source code

TRUE if additive animation was built with looping interpolation.

bHasBeenUsed Source code

Debug flag to trace if this anim sequence was played.

bIsAdditive Source code

TRUE if this is an Additive Animation

BoneControlModifiers Source code

DEPRECATED VER_ADDED_ANIM_METADATA_FIXED_QUATERROR Bone Control Modifiers, sorted by time (earliest notification first).

CompressCommandletVersion Source code

Saved version number with CompressAnimations commandlet. To help with doing it in multiple passes.

CompressedByteStream Source code

ByteStream for compressed animation data. All keys are currently stored at evenly-spaced intervals (ie no explicit key times). For a translation track of n keys, data is packed as n uncompressed float[3]: For a rotation track of n>1 keys, the first 24 bytes are reserved for compression info (eg Fixed32 stores float Mins[3]; float Ranges[3]), followed by n elements of the compressed type. For a rotation track of n=1 keys, the single key is packed as an FQuatFloat96NoW.

CompressedTrackOffsets Source code

An array of 4*NumTrack ints, arranged as follows: [0] Trans0.Offset [1] Trans0.NumKeys [2] Rot0.Offset [3] Rot0.NumKeys [4] Trans1.Offset . . .

CurveData Source code

EncodingPkgVersion Source code

The version of the global encoding package used at the time of import

KeyEncodingFormat Source code

NumFrames Source code

Number of raw frames in this sequence (not used by engine - just for informational purposes).

RawAnimationData Source code

RawAnimData Source code

Raw uncompressed keyframe data. RawAnimData is deprecated and moved to RawAnimationData to switch to native serialization. Down the road it should be switched to use lazy loading as the data is only used in the editor. It is used pervasively enough to be a separate change.

RelatedAdditiveAnimSeqs Source code

If this animation was used, either as a Base or Target Pose, to build additive animations, they are referenced there. For automatic rebuilding in the editor.

RotationCodec Source code

RotationCompressionFormat Source code

The compression format that was used to compress rotation tracks.

RotationData Source code

Rotation data post keyframe reduction. RotationData.Num() is zero if keyframe reduction has not yet been applied.

SequenceLength Source code

Length (in seconds) of this AnimSequence if played back with a speed of 1.0.

SequenceName Source code

Name of the animation sequence. Used in AnimNodeSequence.

TranslationCodec Source code

The runtime interface to decode and byte swap the compressed animation May be NULL. Set at runtime - does not exist in editor

TranslationCompressionFormat Source code

The compression format that was used to compress translation tracks.

TranslationData Source code

Translation data post keyframe reduction. TranslationData.Num() is zero if keyframe reduction has not yet been applied.

UseScore Source code

Debug score to find out animation usage

AnimSequence

bDoNotOverrideCompression Source code

Do not attempt to override compression scheme when running CompressAnimations commandlet. Some high frequency animations are too sensitive and shouldn't be changed.

bNoLoopingInterpolation Source code

if TRUE, disable interpolation between last and first frame when looping.

CompressionScheme Source code

The compression scheme that was most recently used to compress this animation. May be NULL.

MetaData Source code

Animation Meta Data

Notifies Source code

Animation notifies, sorted by time (earliest notification first).

RateScale Source code

Number for tweaking playback rate of this animation globally.

AnimationCompressionFormat Source code

Indicates animation data compression format.

AnimationKeyFormat Source code

Indicates animation data compression format.

AnimNotifyEvent Source code

AnimTag Source code

Temporary Animation Tagging Information: until we integrate Content Tagging This is configurable information in Engine Tag: Name of Tag Contains: Contains text Priority is index of array

CompressedTrack Source code

CurveTrack Source code

Key frame curve data for one track CurveName: Morph Target Name CurveWeights: List of weights for each frame

RawAnimSequenceTrack Source code

Raw keyframe data for one track. Each array will contain either NumFrames elements or 1 element. One element is used as a simple compression scheme where if all keys are the same, they'll be reduced to 1 key that is constant over the entire sequence. @warning: manually mirrored in UnMiscDeclerations.h due to mixed native/ script serialization
PosKeys:

Position keys.

RotKeys:

Rotation keys.

RotationTrack Source code

Keyframe rotation data for one track. Rot(i) occurs at Time(i). Rot.Num() always equals Time.Num().

SkelControlModifier Source code

Modifiers:

Modifiers for what time and what strength for this skelcontrol nam

SkelControlName:

SkelControl Node Name in the Anim Tree that would apply

TimeModifier Source code

TargetStrength:

This will linearly interpolate between multiple strength within one anim dat

Time:

Time to apply

TranslationTrack Source code

Keyframe position data for one track. Pos(i) occurs at Time(i). Pos.Num() always equals Time.Num().

GetNotifyTimeByClass Source code

Get the time (in seconds) from the start of the animation that the first notify of the given class would fire
@param NotifyClass Class of AnimNotify we are looking for (ie AnimNotify_Sound)
@param PlayRate Rate that animation would be played at
@param StartPosition Initial position in the animation to start checking from
@return Time in seconds that notify would fire if anim was played at given rate Returns -1.f if no notify is found

defaultproperties
{
	RateScale=1.0
}