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

Engine.UIAnimation

Extends
UIRoot
Modifiers
abstract native ( UserInterface )

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

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIAnimation

Direct Known Subclasses:

UIAnimationSeq
Constants Summary
Inherited Contants from Engine.UIRoot
ASPECTRATIO_Monitor, ASPECTRATIO_Normal, ASPECTRATIO_Widescreen, DEFAULT_SIZE_X, DEFAULT_SIZE_Y, MAX_SUPPORTED_GAMEPADS, PRIVATE_EditorNoDelete, PRIVATE_EditorNoRename, PRIVATE_EditorNoReparent, PRIVATE_KeepFocusedState, PRIVATE_ManagedStyle, PRIVATE_NotDockable, PRIVATE_NotEditorSelectable, PRIVATE_NotFocusable, PRIVATE_NotRotatable, PRIVATE_PropagateState, PRIVATE_Protected, PRIVATE_TreeHidden, PRIVATE_TreeHiddenRecursive, SCENE_DATASTORE_TAG, TEMP_SPLITSCREEN_INDEX
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
Inherited Variables from Engine.UIRoot
CurrentMenuState, ModifierStack
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EUIAnimNotifyType
EANT_WidgetFunction, EANT_SceneFunction, EANT_KismetEvent, EANT_Sound,
EUIAnimType
EAT_None, EAT_Position, EAT_RelPosition, EAT_Rotation, EAT_RelRotation, EAT_Color, EAT_Opacity, EAT_Visibility, EAT_Scale, EAT_Left, EAT_Top, EAT_Right, EAT_Bottom, EAT_MAX
Inherited Enumerations from Engine.UIRoot
EColumnHeaderState, EMaterialAdjustmentType, ENavigationLinkType, EPositionEvalType, ERotationAnchor, EScreenInputMode, ESplitscreenRenderMode, ETextAutoScaleMode, ETextClipMode, EUIAlignment, EUIAspectRatioConstraint, EUIAutoSizeConstraintType, EUIDataProviderFieldType, EUIDefaultPenColor, EUIDockPaddingEvalType, EUIExtentEvalType, EUIListElementState, EUIOrientation, EUIWidgetFace
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
UIAnimationKeyFrame
TimeMark, Data
UIAnimationNotify
NotifyType, NotifyName
UIAnimationRawData
DestAsFloat, DestAsColor, DestAsRotator, DestAsVector, DestAsNotify
UIAnimSeqRef
SeqRef, PlaybackRate, AnimTime, bIsPlaying, bIsLooping, LoopCount, InitialRenderOffset, InitialRotation
UIAnimTrack
TrackType, TrackWidgetTag, KeyFrames, TargetWidget
Inherited Structures from Engine.UIRoot
AutoSizeData, AutoSizePadding, DefaultEventSpecification, InputEventSubscription, InputKeyAction, PlayerInteractionData, RenderParameters, ScreenPositionRange, StateInputKeyAction, StyleReferenceId, STYLE_ID, TextAutoScaleValue, TextureCoordinates, UIAnchorPosition, UICombinedStyleData, UIDataStoreBinding, UIDockingNode, UIDockingSet, UIFocusPropagationData, UIImageAdjustmentData, UIImageStyleOverride, UIInputAliasClassMap, UIInputAliasMap, UIInputAliasStateMap, UIMouseBounds, UINavigationData, UIProviderFieldValue, UIProviderScriptFieldValue, UIRangeData, UIRenderingSubregion, UIRotation, UIScreenValue, UIScreenValue_AutoSizeRegion, UIScreenValue_Bounds, UIScreenValue_DockPadding, UIScreenValue_Extent, UIScreenValue_Position, UIStringCaretParameters, UIStringNodeModifier, UIStyleOverride, UIStyleReference, UIStyleSubscriberReference, UITextAttributes, UITextStyleOverride, WIDGET_ID
Inherited Structures from Core.Object
Box, BoxSphereBounds, Color, Cylinder, double, DynamicMap_Mirror, Guid, IndirectArray_Mirror, InterpCurveFloat, InterpCurvePointFloat, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, Rotator, TextureMipBulkData_Mirror, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
Inherited Functions from Engine.UIRoot
<, =, ConvertWidgetIDToString, GetCurrentUIController, GetCursorPosition, GetCursorSize, GetDataStoreFieldValue, GetDataStoreStringValue, GetFaceOrientation, GetPrimitiveTransform, GetSceneClient, IsConsole, SetDataStoreFieldValue, SetDataStoreStringValue, SetMouseCaptureOverride
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClassIsChildOf, ClearConfig, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, Exp, FClamp, FCubicInterp, FindDeltaAngle, FindObject, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetDotDistance, GetEnum, GetFuncName, GetHeadingAngle, GetNetFuncName, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetSpecialValue, GetStateName, GetUnAxes, GotoState, InStr, IsA, IsChildState, IsInState, IsNetScript, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, OrthoRotation, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointInBox, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, SaveConfig, SClampRotAxis, ScriptTrace, SetSpecialValue, SetUTracing, Sin, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Enumerations Detail

EUIAnimNotifyType Source code

enum EUIAnimNotifyType
{
EANT_WidgetFunction, EANT_SceneFunction, EANT_KismetEvent, EANT_Sound,
};
The different type of notification events

EUIAnimType Source code

enum EUIAnimType
{
EAT_None, EAT_Position, EAT_RelPosition, EAT_Rotation, EAT_RelRotation, EAT_Color, EAT_Opacity, EAT_Visibility, EAT_Scale, EAT_Left, EAT_Top, EAT_Right, EAT_Bottom, EAT_MAX
};

Structures Detail

UIAnimationKeyFrame Source code

struct UIAnimationKeyFrame
{
var UIAnimationRawData Data;
var float TimeMark;
};
UTUIAnimationKeyFrames are a collection of 1 or more UTUIAnimationOps that will be applied to a given widget.
Data:
This holds the array of AnimationOps that will be applied to this Widget
TimeMark:
This is the timemark where this frame is fully in effect. Note Timemark is

UIAnimationNotify Source code

struct UIAnimationNotify
{
var name NotifyName;
var EUIAnimNotifyType NotifyType;
};
Holds information about a given notify
NotifyName:
Holds the name of the function to call or UI sound to play

UIAnimationRawData Source code

struct UIAnimationRawData
{
var LinearColor DestAsColor;
var float DestAsFloat;
var UIAnimationNotify DestAsNotify;
var Rotator DestAsRotator;
var Vector DestAsVector;
};
We don't have unions in script so we burn a little more space than I would like. Which value will be used depends on the OpType.

UIAnimSeqRef Source code

struct UIAnimSeqRef
{
var float AnimTime;
var bool bIsLooping;
var bool bIsPlaying;
var vector InitialRenderOffset;
var rotator InitialRotation;
var int LoopCount;
var float PlaybackRate;
var UIAnimationSeq SeqRef;
};
Holds a reference to an animation Sequence
AnimTime:
How long have we been playing
bIsLooping:
This animation is looping
bIsPlaying:
This animation is playing
InitialRenderOffset:
Initial rendering offset before any animation has occurred.
InitialRotation:
Initial rotation before any animation has occurred.
LoopCount:
Holds a count of the # of times this animation has looped.
PlaybackRate:
How fast are we playing this back
SeqRef:
The Template to use

UIAnimTrack Source code

struct UIAnimTrack
{
var array<UIAnimationKeyFrame> KeyFrames;
var transient UIObject TargetWidget;
var EUIAnimType TrackType;
var name TrackWidgetTag;
};
This defines a single animation track. Each track will animation only a single type of data.
KeyFrames:
Holds the actual key frame data
TargetWidget:
The widget we are being applied to if it's not the current
TrackType:
The type of animation date contained in this track
TrackWidgetTag:
Which child widget does this track affect. Can be NAME_None

Defaultproperties 

defaultproperties
{
   Name="Default__UIAnimation"
   ObjectArchetype=UIRoot'Engine.Default__UIRoot'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.291 - Created with UnCodeX