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

Engine.CameraShake

Extends
Object
Modifiers
editinlinenew native ( Camera )

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved. Object that encapsulates parameters for defining a camera shake. a code-driven (oscillating) screen shake. 

Core.Object
|   
+-- Engine.CameraShake
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
AnimShake
CameraAnimAnim
floatAnimBlendInTime
floatAnimBlendOutTime
floatAnimPlayRate
floatAnimScale
boolbRandomAnimSegment
floatRandomAnimSegmentDuration
CameraShake
boolbSingleInstance
Oscillation
FOscillatorFOVOscillation
VOscillatorLocOscillation
floatOscillationBlendInTime
floatOscillationBlendOutTime
floatOscillationDuration
ROscillatorRotOscillation
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EInitialOscillatorOffset
EOO_OffsetRandom, EOO_OffsetZero,
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
FOscillator
Amplitude, Frequency, InitialOffset
ROscillator
Pitch, Yaw, Roll
VOscillator
X, Y, Z
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
functionfloat GetLocOscillationMagnitude ()))
functionfloat GetRotOscillationMagnitude ()))
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

AnimShake

Anim Source code

var(AnimShake) CameraAnim Anim;
Parameters for defining CameraAnim-driven camera shakes

AnimBlendInTime Source code

var(AnimShake) float AnimBlendInTime<ClampMin=0.0>;
Linear blend-in time.

AnimBlendOutTime Source code

var(AnimShake) float AnimBlendOutTime<ClampMin=0.0>;
Linear blend-out time.

AnimPlayRate Source code

var(AnimShake) float AnimPlayRate<ClampMin=0.001>;
Scalar defining how fast to play the anim.

AnimScale Source code

var(AnimShake) float AnimScale<ClampMin=0.0>;
Scalar defining how "intense" to play the anim.

bRandomAnimSegment Source code

var(AnimShake) bool bRandomAnimSegment;
If TRUE, play a random snippet of the animation of length Duration. Implies bLoop and bRandomStartTime = TRUE for the CameraAnim. If FALSE, play the full anim once, non-looped.

RandomAnimSegmentDuration Source code

var(AnimShake) float RandomAnimSegmentDuration<ClampMin=0.0|EditCondition=bRandomAnimSegment>;
When bRandomAnimSegment=true, this defines how long the anim should play.

CameraShake

bSingleInstance Source code

var(CameraShake) bool bSingleInstance;
TRUE to only allow a single instance of this shake to play at any given time. Subsequents attempts to play this shake will simply restart the timer.

Oscillation

FOVOscillation Source code

var(Oscillation) FOscillator FOVOscillation;
FOV oscillation

LocOscillation Source code

var(Oscillation) VOscillator LocOscillation;
Positional oscillation

OscillationBlendInTime Source code

var(Oscillation) float OscillationBlendInTime<ClampMin=0.0>;

OscillationBlendOutTime Source code

var(Oscillation) float OscillationBlendOutTime<ClampMin=0.0>;

OscillationDuration Source code

var(Oscillation) float OscillationDuration;
Duration in seconds of current screen shake. <0 means indefinite, 0 means no oscillation

RotOscillation Source code

var(Oscillation) ROscillator RotOscillation;
Rotational oscillation

Enumerations Detail

EInitialOscillatorOffset Source code

enum EInitialOscillatorOffset
{
EOO_OffsetRandom, EOO_OffsetZero,
};
Shake start offset parameter

Structures Detail

FOscillator Source code

struct FOscillator
{
var(CameraShake) float Amplitude;
var(CameraShake) float Frequency;
var(CameraShake) EInitialOscillatorOffset InitialOffset;
};
Defines oscillation of a single number.

ROscillator Source code

struct ROscillator
{
var(CameraShake) FOscillator Pitch;
var(CameraShake) FOscillator Roll;
var(CameraShake) FOscillator Yaw;
};
Defines rotator oscillation.

VOscillator Source code

struct VOscillator
{
var(CameraShake) FOscillator X;
var(CameraShake) FOscillator Y;
var(CameraShake) FOscillator Z;
};
Defines vector oscillation.

Functions Detail

GetLocOscillationMagnitude Source code

simulated function float GetLocOscillationMagnitude ( ) )

GetRotOscillationMagnitude Source code

simulated function float GetRotOscillationMagnitude ( ) )

Defaultproperties 

defaultproperties
{
	AnimPlayRate=1.f
	AnimScale=1.f
	AnimBlendInTime=0.2f
	AnimBlendOutTime=0.2f
	OscillationBlendInTime=0.1f
	OscillationBlendOutTime=0.2f
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:47.824 - Created with UnCodeX