Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.AnimNode

Extends
AnimObject
Modifiers
native ( Anim ) hidecategories ( Object ) abstract

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

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

Direct Known Subclasses:

AnimNodeBlendBase, AnimNodeSequence
Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
intbCachedHasRootMotion
boolbDisableCaching
boolbJustBecameRelevant
boolbRelevant
array<BoneAtom>CachedBoneAtoms
array<CurveKey>CachedCurveKeys
byteCachedNumDesiredBones
BoneAtomCachedRootMotionDelta
intNodeCachedAtomsTag
INTNodeInitTag
intNodeTickTag
floatNodeTotalWeight
Array<AnimNodeBlendBase>ParentNodes
intSearchTag
intTickArrayIndex
AnimNode
boolbCallScriptEventOnBecomeRelevant
boolbCallScriptEventOnCeaseRelevant
boolbCallScriptEventOnInit
nameNodeName
Morph
array<CurveKey>LastUpdatedAnimMorphKeys
Performance
boolbTickDuringPausedAnims
Inherited Variables from Engine.AnimObject
CategoryDesc, DrawHeight, DrawWidth, NodePosX, NodePosY, OutDrawY, SkelComponent
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
ESliderType
ST_1D, ST_2D
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
CurveKey
CurveName, Weight
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
functionAnimNode FindAnimNode (name InNodeName)
event OnBecomeRelevant ()
event OnCeaseRelevant ()
event OnInit ()
function PlayAnim (bool bLoop = false, float Rate = 1.0f, float StartTime = 0.0f)
function ReplayAnim ()
function StopAnim ()
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

bCachedHasRootMotion Source code

var transient int bCachedHasRootMotion;
Cached bool indicating if node supplies root motion, to avoid recalculating (see above).

bDisableCaching Source code

var const transient bool bDisableCaching;
Temporarily disable caching when calling Super::GetBoneAtoms so it's not done multiple times.

bJustBecameRelevant Source code

var transient const bool bJustBecameRelevant;
set to TRUE when this node became relevant this round of updates. Will be set to false on the next tick.

bRelevant Source code

var transient const bool bRelevant;
This node is considered 'relevant' - that is, has >0 weight in the final blend.

CachedBoneAtoms Source code

var transient array<BoneAtom> CachedBoneAtoms;
If a node is linked to more than once in the graph, this is a cache of the results, to avoid re-evaluating the results.

CachedCurveKeys Source code

var transient array<CurveKey> CachedCurveKeys;
Cached curve keys to avoid recalculating (see above).

CachedNumDesiredBones Source code

var transient byte CachedNumDesiredBones;
Num Desired Bones used in CachedBoneAtoms. If we request something different, CachedBoneAtoms array is not going to be valid.

CachedRootMotionDelta Source code

var transient BoneAtom CachedRootMotionDelta;
Cached root motion delta, to avoid recalculating (see above).

NodeCachedAtomsTag Source code

var transient const int NodeCachedAtomsTag;
Used to indicate whether the BoneAtom cache for this node is up-to-date or not.

NodeInitTag Source code

var transient const INT NodeInitTag;
Initialization tag, for deferred InitAnim.

NodeTickTag Source code

var transient const int NodeTickTag;
Used to avoid ticking a node twice if it has multiple parents.

NodeTotalWeight Source code

var const float NodeTotalWeight;
Total apparent weight this node has in the final blend of all animations.

ParentNodes Source code

var duplicatetransient Array<AnimNodeBlendBase> ParentNodes;
Array of Parent nodes, which in most cases only has 1 element.

SearchTag Source code

var const transient int SearchTag;
used when iterating over nodes via GetNodes() and related functions to skip nodes that have already been processed

TickArrayIndex Source code

var const int TickArrayIndex;
Index in AnimTick Array. Serialized, because we serialize TickArrayIndex in UAnimTree.

AnimNode

bCallScriptEventOnBecomeRelevant Source code

var(AnimNode) bool bCallScriptEventOnBecomeRelevant;

bCallScriptEventOnCeaseRelevant Source code

var(AnimNode) bool bCallScriptEventOnCeaseRelevant;

bCallScriptEventOnInit Source code

var(AnimNode) bool bCallScriptEventOnInit;
Flags to control if Script Events should be called. Note that those will affect performance, so be careful!

NodeName Source code

var(AnimNode) name NodeName;
This is the name used to find an AnimNode by name from a tree.

Morph

LastUpdatedAnimMorphKeys Source code

var(Morph) editoronly editconst transient array<CurveKey> LastUpdatedAnimMorphKeys;
Array of blended curve key for editor only

Performance

bTickDuringPausedAnims Source code

var(Performance) bool bTickDuringPausedAnims;
If TRUE, this node will be ticked, even if bPauseAnims is TRUE on the SkelMeshComp.

Enumerations Detail

ESliderType Source code

enum ESliderType
{
ST_1D, ST_2D
};
Enumeration for slider types

Structures Detail

CurveKey Source code

struct CurveKey
{
var name CurveName;
var float Weight;
};
Curve Key @CurveName : Morph Target name to blend

Functions Detail

FindAnimNode Source code

native final function AnimNode FindAnimNode ( name InNodeName )
Find an Animation Node in the Animation Tree whose NodeName matches InNodeName. Will search this node and all below it. Warning: The search is O(n^2), so for large AnimTrees, cache result.

OnBecomeRelevant Source code

event OnBecomeRelevant ( )
Get notification that this node has become relevant for the final blend. ie TotalWeight is now > 0

OnCeaseRelevant Source code

event OnCeaseRelevant ( )
Get notification that this node is no longer relevant for the final blend. ie TotalWeight is now == 0

OnInit Source code

event OnInit ( )
Called from InitAnim. Allows initialization of script-side properties of this node.

PlayAnim Source code

native function PlayAnim ( bool bLoop = false, float Rate = 1.0f, float StartTime = 0.0f )

ReplayAnim Source code

native function ReplayAnim ( )

StopAnim Source code

native function StopAnim ( )

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:47.254 - Created with UnCodeX