I don't need to test my programs. I have an error-correcting modem.

UE3:CameraAnimInst (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 08:37, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 1))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> CameraAnimInst
Package: 
Engine
This class in other games:
UT3

CameraAnim: defines a pre-packaged animation to be played on a camera.

Properties[edit]

BasePlayScale[edit]

Type: float

"Intensity" scalar. This is the scale at which the anim was first played.

bAutoReleaseWhenFinished[edit]

Type: bool

Modifiers: transient

True if it's ok for the system to auto-release this instance upon completion.

bBlendingIn[edit]

Type: bool

Modifiers: protected, transient

True if currently blending in.

bBlendingOut[edit]

Type: bool

Modifiers: protected, transient

True if currently blending out.

bFinished[edit]

Type: bool

Modifiers: transient

True if the animation has finished, false otherwise.

BlendInTime[edit]

Type: float

Modifiers: protected

Time to interpolate in from zero, for smooth starts.

BlendOutTime[edit]

Type: float

Modifiers: protected

Time to interpolate out to zero, for smooth finishes.

bLooping[edit]

Type: bool

Modifiers: protected, transient

True if the animation should loop, false otherwise.

CamAnim[edit]

Type: CameraAnim

which CameraAnim this is an instance of

CurBlendInTime[edit]

Type: float

Modifiers: protected, transient

Current time for the blend-in. I.e. how long we have been blending.

CurBlendOutTime[edit]

Type: float

Modifiers: protected, transient

Current time for the blend-out. I.e. how long we have been blending.

CurrentBlendWeight[edit]

Type: float


CurTime[edit]

Type: float

Modifiers: protected, transient

Current time for the animation

InterpGroupInst[edit]

Type: InterpGroupInst

Modifiers: protected, instanced

the InterpGroupInst used to do the interpolation

Default value: InterpGroupInst'Engine.Default__CameraAnimInst:InterpGroupInst0'

MoveInst[edit]

Type: InterpTrackInstMove

Modifiers: transient


MoveTrack[edit]

Type: InterpTrackMove

Modifiers: transient

cached movement track from the currently playing anim so we don't have to go find it every frame

PlayRate[edit]

Type: float

Modifiers: protected

Multiplier for playback rate. 1.0 = normal.

Default value: 1.0

PlaySpace[edit]

Type: Camera.ECameraAnimPlaySpace

Modifiers: protectedwrite


RemainingTime[edit]

Type: float

Modifiers: protected, transient

How much longer to play the anim, if a specific duration is desired. Has no effect if 0.

SourceAnimNode[edit]

Type: AnimNodeSequence

Modifiers: protected, transient

Ref to the AnimNodeSequence that's instigating this anim. Can be None.

TransientScaleModifier[edit]

Type: float

A supplemental scale factor, allowing external systems to scale this anim as necessary. This is reset to 1.f each frame.

Default value: 1.0

UserPlaySpaceMatrix[edit]

Type: Object.Matrix

Modifiers: transient

The user-defined space for CAPS_UserDefined

Subobjects[edit]

InterpGroupInst0[edit]

Class: Engine.InterpGroupInst

No new values.

Native functions[edit]

AdvanceAnim[edit]

native final function AdvanceAnim (float DeltaTime, bool bJump)

advances the animation by the specified time - updates any modified interp properties, moves the group actor, etc

ApplyTransientScaling[edit]

native final function ApplyTransientScaling (float Scalar)

Applies given scaling factor to the playing animation for the next update only.

Play[edit]

native final function Play (CameraAnim Anim, Actor CamActor, float InRate, float InScale, float InBlendInTime, float InBlendOutTime, bool bInLoop, bool bRandomStartTime, optional float Duration)

Starts this instance playing the specified CameraAnim.

CamAnim: The animation that should play on this instance. CamActor: The Actor that will be modified by this animation. InRate: How fast to play the animation. 1.f is normal. InScale: How intense to play the animation. 1.f is normal. InBlendInTime: Time over which to linearly ramp in. InBlendInTime: Time over which to linearly ramp out. bInLoop: Whether or not to loop the animation. bRandomStartTime: Whether or not to choose a random time to start playing. Only really makes sense for bLoop = TRUE; Duration: optional specific playtime for this animation. This is total time, including blends.

SetPlaySpace[edit]

native final function SetPlaySpace (Camera.ECameraAnimPlaySpace NewSpace, optional Object.Rotator UserPlaySpace)

Sets this anim to play in an alternate playspace

Stop[edit]

native final function Stop (optional bool bImmediate)

Stops this instance playing whatever animation it is playing.

Update[edit]

native final function Update (float NewRate, float NewScale, float NewBlendInTime, float NewBlendOutTime, optional float NewDuration)

Update this instance with new parameters.