Engine.AnimNodeSequence

Extends

AnimNode

Modifiers

native ( Anim ) hidecategories ( Object )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.AnimNode
   |   
   +-- Engine.AnimNodeSequence

Direct Known Subclasses:

AnimNodeSequenceBlendBase, UTAnimNodeFramePlayer, UTAnimNodeSequence, UTAnimNodeSequenceByBoneRotation

Functions Summary
	float	FindNormalizedPositionFromGroupRelativePosition (FLOAT GroupRelativePosition)
	float	GetAnimPlaybackLength ()
	float	GetGlobalPlayRate ()
	float	GetNormalizedPosition ()
	float	GetTimeLeft ()
		PlayAnim (bool bLoop = false, float InRate = 1.0f, float StartTime = 0.0f)
		SetAnim (name Sequence)
		SetPosition (float NewTime, bool bFireNotifies)
		StopAnim ()

AnimLinkupIndex Source code

Bone -> Track mapping info for this player node. Index into the LinkupCache array in the AnimSet. Found from AnimSet when you call SetAnim.

AnimSeq Source code

Pointer to actual AnimSequence. Found from SkeletalMeshComponent using AnimSeqName when you call SetAnim.

bIsIssuingNotifies Source code

Flag that indicates if Notifies are currently being executed. Allows you to avoid doing dangerous things to this Node while this is going on.

DebugCarat Source code

For debugging. Small icon to show current position in animation.

DebugTrack Source code

For debugging. Track graphic used for showing animation position.

PreviousTime Source code

AnimNodeSequence

AnimSeqName Source code

This name will be looked for in all AnimSet's specified in the AnimSets array in the SkeletalMeshComponent.

bCauseActorAnimEnd Source code

Should this node call the OnAnimEnd event on its parent Actor when it reaches the end and stops.

bCauseActorAnimPlay Source code

Should this node call the OnAnimPlay event on its parent Actor when PlayAnim is called on it.

bForceRefposeWhenNotPlaying Source code

Forces the skeletal mesh into the ref pose by setting bForceRespose on the skelmesh comp when not playing. (Optimization)

bLooping Source code

If animation is looping. If false, animation will stop when it reaches end, otherwise will continue from beginning.

bNoNotifies Source code

Whether any notifies in the animation sequence should be executed for this node.

bPlaying Source code

Whether this animation is currently playing ie. if the CurrentTime will be advanced when Tick is called.

bZeroRootRotation Source code

Always return a zero rotation (unit quaternion) for the root bone of this animation.

bZeroRootTranslation Source code

Always return root bone translation at the origin.

CurrentTime Source code

Current position (in seconds)

NotifyWeightThreshold Source code

Total weight that this node must be at in the final blend for notifies to be executed. This is ignored when the node is part of a group.

Rate Source code

Speed at which the animation will be played back. Multiplied by the RateScale in the AnimSequence. Default is 1.0

RootBoneOption[3] Source code

discard root movement on animation, and forward its velocity to the owning actor.

RootRotationOption[3] Source code

Discard root rotation from animation, and forwards it to the actor. (to be used by it or not).

Display

bShowTimeLineSlider Source code

Display time line slider

Group

bForceAlwaysMaster Source code

Any node with this flag set with global weight > 0.0 will be picked over any other node as master node.

bForceAlwaysSlave Source code

If TRUE, this node can never be a synchronization master node, always slave.

bSynchronize Source code

TRUE by default. This node can be synchronized with others, when part of a SynchGroup. Set to FALSE if node shouldn't be synchronized, but still part of notification group.

SynchGroupName Source code

name of group this node belongs to

SynchPosOffset Source code

Relative position offset

ERootBoneAxis Source code

This will actually call MoveActor to move the Actor owning this SkeletalMeshComponent. You can specify the behaviour for each axis (mesh space). Doing this for multiple skeletal meshes on the same Actor does not make much sense!

ERootRotationOption Source code

Root Motion Rotation.

FindNormalizedPositionFromGroupRelativePosition Source code

Finds out normalized position of a synchronized node given a relative position of a group. Takes into account node's relative SynchPosOffset.

GetAnimPlaybackLength Source code

Returns the duration (in seconds) of the current animation at the current play rate. Returns 0.0 if no animation.

GetGlobalPlayRate Source code

Returns the global play rate of this animation. Taking into account all Rate Scales

GetNormalizedPosition Source code

Get normalized position, from 0.f to 1.f.

GetTimeLeft Source code

Returns in seconds the time left until the animation is done playing. This is assuming the play rate is not going to change.

PlayAnim Source code

Start the current animation playing with the supplied parameters.

SetAnim Source code

Change the animation this node is playing to the new name. Will be looked up in owning SkeletaMeshComponent's AnimSets array.

SetPosition Source code

Force the animation to a particular time. NewTime is in seconds.

StopAnim Source code

Stop the current animation playing. CurrentTime will stay where it was.

defaultproperties
{
   Rate=1.000000
   bSynchronize=True
   DebugTrack=Texture2D'EngineResources.AnimPlayerTrack'
   DebugCarat=Texture2D'EngineResources.AnimPlayerCarat'
   Name="Default__AnimNodeSequence"
   ObjectArchetype=AnimNode'Engine.Default__AnimNode'
}