Engine.AnimNodeSequence

Extends

AnimNode

Modifiers

native ( Anim ) hidecategories ( Object )

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

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

Direct Known Subclasses:

AnimNodeSequenceBlendBase, UDKAnimNodeFramePlayer, UDKAnimNodeSequence, UDKAnimNodeSequenceByBoneRotation

Functions Summary
	float	FindGroupPosition (FLOAT GroupRelativePosition) con)
	float	FindGroupRelativePosition (FLOAT GroupRelativePosition) con)
	float	GetAnimPlaybackLength ()
	float	GetGlobalPlayRate ()
	float	GetGroupRelativePosition () con)
	float	GetNormalizedPosition () con)
	float	GetTimeLeft ()
		PlayAnim (bool bLoop = false, float InRate = 1.0f, float StartTime = 0.0f)
		ReplayAnim ()
		SetAnim (name Sequence)
		SetPosition (float NewTime, bool bFireNotifies)
		SetRootBoneAxisOption (ERootBoneAxis AxisX = RBA_Default, ERootBoneAxis AxisY = RBA_Default, ERootBoneAxis AxisZ = RBA_Default)
		SetRootBoneRotationOption (ERootRotationOption AxisX = RRO_Default, ERootRotationOption AxisY = RRO_Default, ERootRotationOption AxisZ = RRO_Default)
		StopAnim ()

ActiveCameraAnimInstance Source code

Ref to the CameraAnimInst that is currently playing.

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.

bEditorOnlyAddRefPoseToAdditiveAnimation Source code

EDITOR ONLY Add Ref Pose to Additive Animation, so it can be viewed fully into the AnimSetViewer.

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.

EndTime Source code

This is the time at which to end the anim. Example: You have a 10 second anim where you just want a portion of the anim! Great for prototyping!

MetaDataSkelControlList Source code

List of SkelControl controlled by MetaData

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.

bDisableWarningWhenAnimNotFound Source code

if TRUE, don't display a warning when animation is not found.

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).

Camera

bLoopCameraAnim Source code

True to loop the CameraAnim, false for a one-off.

bRandomizeCameraAnimLoopStartTime Source code

True to randomize the CameraAnims start position, so it doesn't look the same every time. Ignored if bLoopCameraAnim is false.

CameraAnim Source code

Reference to the CameraAnim to play in conjunction with this animation.

CameraAnimBlendInTime Source code

How long to blend in the camera anim.

CameraAnimBlendOutTime Source code

How long to blend out the camera anim.

CameraAnimPlayRate Source code

How fast to playback the camera anim.

CameraAnimScale Source code

"Intensity" multiplier applied to the camera anim.

Display

bShowTimeLineSlider Source code

Display time line slider

Group

bForceAlwaysSlave Source code

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

bReverseSync Source code

Reverse synchronization. Go in opposite direction.

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.

FindGroupPosition Source code

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

FindGroupRelativePosition 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

GetGroupRelativePosition Source code

Get relative position of a synchronized node. Taking into account node's relative offset.

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.

ReplayAnim Source code

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.

SetRootBoneAxisOption Source code

Set custom animation root bone options.

SetRootBoneRotationOption Source code

Set custom animation root rotation options.

StopAnim Source code

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

defaultproperties
{
	Rate=1.0
	NotifyWeightThreshold=0.0
	bSynchronize=TRUE

	RootBoneOption[0] = RBA_Default
	RootBoneOption[1] = RBA_Default
	RootBoneOption[2] = RBA_Default

	RootRotationOption[0]=RRO_Default
	RootRotationOption[1]=RRO_Default
	RootRotationOption[2]=RRO_Default

	CameraAnimPlayRate=1.f
	CameraAnimScale=1.f
	CameraAnimBlendInTime=0.2f
	CameraAnimBlendOutTime=0.2f
}