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

Engine.Camera

Extends
Actor
Modifiers
notplaceable native

Camera: defines the Point of View of a player in world space. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Camera

Direct Known Subclasses:

AnimatedCamera

Constants Summary
Inherited Contants from Engine.Actor
ACTORMAXSTEPHEIGHT, MINFLOORZ, RBSTATE_ANGVELSCALE, RBSTATE_LINVELSCALE, RB_NeedsUpdate, RB_None, RB_Sleeping, REP_RBLOCATION_ERROR_TOLERANCE_SQ, TRACEFLAG_Blocking, TRACEFLAG_Bullet, TRACEFLAG_PhysicsVolumes, TRACEFLAG_SkipMovers
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
boolbCamOverridePostProcess
boolbConstrainAspectRatio
boolbEnableColorScaleInterp
boolbEnableColorScaling
boolbEnableFading
ViewTargetTransitionParamsBlendParams
floatBlendTimeToGo
boolbLockedFOV
TCameraCacheCameraCache
NameCameraStyle
PostProcessSettingsCamPostProcessSettings
vectorColorScale
floatColorScaleInterpDuration
floatColorScaleInterpStartTime
floatConstrainedAspectRatio
floatDefaultAspectRatio
floatDefaultFOV
vectorDesiredColorScale
floatFadeAmount
colorFadeColor
floatFreeCamDistance
vectorFreeCamOffset
floatLockedFOV
Array<CameraModifier>ModifierList
vectorOriginalColorScale
PlayerControllerPCOwner
TViewTargetPendingViewTarget
TViewTargetViewTarget
Inherited Variables from Engine.Actor
Acceleration, AllComponents, Attached, bAlwaysEncroachCheck, bAlwaysRelevant, bAlwaysTick, Base, BaseBoneName, BaseSkelComponent, bBlockActors, bBlocksNavigation, bBlocksTeleport, bBounce, bCanBeAdheredTo, bCanBeDamaged, bCanBeFrictionedTo, bCanTeleport, bClientDemoRecording, bCollideActors, bCollideComplex, bCollideWhenPlacing, bCollideWorld, bComponentOutsideWorld, bConsiderAllStaticMeshComponentsForStreaming, bDebug, bDeleteMe, bDemoOwner, bDemoRecording, bDestroyedByInterpActor, bDestroyInPainVolume, bEdShouldSnap, bExchangedRoles, bForceNetUpdate, bGameRelevant, bHardAttach, bHasAlternateTargetLocation, bHidden, bHiddenEd, bHiddenEdCustom, bHiddenEdGroup, bHurtEntry, bIgnoreBaseRotation, bIgnoreEncroachers, bIgnoreRigidBodyPawns, bIsMoving, bJustTeleported, bKillDuringLevelTransition, bLockLocation, BlockRigidBody, bMovable, bNetDirty, bNetInitial, bNetInitialRotation, bNetOwner, bNetTemporary, bNeverReplicateRotation, bNoDelete, bNoEncroachCheck, bOnlyDirtyReplication, bOnlyOwnerSee, bOnlyRelevantToOwner, bOrientOnSlope, bPathColliding, bPathTemp, bPendingDelete, bPendingNetUpdate, bPhysRigidBodyOutOfWorldCheck, bPostRenderIfNotVisible, bProjTarget, bPushedByEncroachers, bRepClientDemo, bReplicateInstigator, bReplicateMovement, bReplicateRigidBodyLocation, bRouteBeginPlayEvenIfStatic, bScriptInitialized, bShadowParented, bShouldBaseAtStartup, bSkipActorPropertyReplication, bStasis, bStatic, bTearOff, bTempEditor, bTicked, bUpdateSimulatedPosition, bWorldGeometry, Children, CollisionComponent, CollisionType, Components, CreationTime, CustomTimeDilation, DesiredRotation, DetachFence, DrawScale, DrawScale3D, GeneratedEvents, Group, InitialState, Instigator, LastNetUpdateTime, LastRenderTime, LatentActions, LatentFloat, LatentSeqNode, LifeSpan, Location, MessageClass, MinDistForNetRBCorrection, NetPriority, NetTag, NetUpdateFrequency, NetUpdateTime, OverlapTag, Owner, PendingTouch, Physics, PhysicsVolume, PrePivot, RelativeLocation, RelativeRotation, RemoteRole, Role, Rotation, RotationRate, SupportedEvents, Tag, TickGroup, Timers, Touching, Velocity, WorldInfo
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EViewTargetBlendFunction
VTBlend_Linear, VTBlend_Cubic, VTBlend_EaseIn, VTBlend_EaseOut, VTBlend_EaseInOut,
Inherited Enumerations from Engine.Actor
ECollisionType, EDoubleClickDir, EMoveDir, ENetRole, EPhysics, ETravelType
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
TCameraCache
TimeStamp, POV
TViewTarget
Target, Controller, POV, AspectRatio, PRI
ViewTargetTransitionParams
BlendTime, BlendFunction, BlendExp
Inherited Structures from Engine.Actor
AnimSlotDesc, AnimSlotInfo, AsyncLineCheckResult, CollisionImpactData, ImpactInfo, NavReference, ReplicatedHitImpulse, RigidBodyContactInfo, RigidBodyState, TimerData, TraceHitInfo
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
functionbool AllowPawnRotation ()))
event ApplyCameraModifiers (float DeltaTime, out TPOV OutPOV))
functionTPOV BlendViewTargets (const out TViewTarget A, onst out TViewTarget B, float Alpha))
function CheckViewTarget (out TViewTarget VT)
function DisplayDebug (HUD HUD, out float out_YL, out float out_YPos))
function FillCameraCache (const out TPOV NewPOV))
function GetCameraViewPoint (out vector OutCamLoc, out rotator OutCamRot))
functionfloat GetFOVAngle ()))
function InitializeFor (PlayerController PC))
function ProcessViewRotation (float DeltaTime, out rotator OutViewRotation, out Rotator OutDeltaRot))
function SetDesiredColorScale (vector NewColorScale, float InterpTime))
function SetFOV (float NewFOV))
function SetViewTarget (Actor NewViewTarget, optional ViewTargetTransitionParams TransitionParams)
event UpdateCamera (float DeltaTime))
function UpdateViewTarget (out TViewTarget OutVT, float DeltaTime))
Inherited Functions from Engine.Actor
ActivateEventClass, AllActors, AllOwnedComponents, Attach, AttachComponent, AutonomousPhysics, BaseChange, BasedActors, BecomeViewTarget, BeginAnimControl, BroadcastLocalizedMessage, BroadcastLocalizedTeamMessage, Bump, CalcCamera, CanSplash, ChartData, CheckForErrors, CheckHitInfo, CheckMaxEffectDistance, ChildActors, ClampRotation, ClearLatentAction, ClearTimer, Clock, CollidingActors, CollisionChanged, ComponentList, ConsoleCommand, ConstraintBrokenNotify, ContainsPoint, CreateAudioComponent, DebugFreezeGame, Destroy, Destroyed, Detach, DetachComponent, DisplayDebug, DoKismetAttachment, DrawDebugBox, DrawDebugCone, DrawDebugCoordinateSystem, DrawDebugCylinder, DrawDebugLine, DrawDebugSphere, DynamicActors, EffectIsRelevant, EncroachedBy, EncroachingOn, EndViewTarget, Falling, FastTrace, FellOutOfWorld, FindActorsOfClass, FindBase, FindEventsOfClass, FindGoodEndView, FindSpot, FinishAnim, FinishAnimControl, FlushPersistentDebugLines, ForceNetRelevant, ForceUpdateComponents, GainedChild, GetActorEyesViewPoint, GetActorFaceFXAsset, GetBaseMost, GetBoundingCylinder, GetComponentsBoundingBox, GetDebugName, GetDestination, GetFaceFXAudioComponent, GetGravityZ, GetHumanReadableName, GetItemName, GetLocalString, GetLocationStringFor, GetPackageGuid, GetPhysicsName, GetTargetLocation, GetTeamNum, GetTerminalVelocity, GetTimerCount, GetTimerRate, GetURLMap, GetUTFlag, HealDamage, HitWall, HurtRadius, InterpolationChanged, InterpolationFinished, InterpolationStarted, IsActorPlayingFaceFXAnim, IsBasedOn, IsInPain, IsInVolume, IsOverlapping, IsOwnedBy, IsPlayerOwned, IsStationary, IsTimerActive, KilledBy, Landed, LocalPlayerControllers, LostChild, MakeNoise, MatchStarting, ModifyHearSoundComponent, Move, MoveSmooth, MovingWhichWay, NativePostRenderFor, NotifyLocalPlayerTeamReceived, NotifySkelControlBeyondLimit, OnAnimEnd, OnAnimPlay, OnAttachToActor, OnCauseDamage, OnChangeCollision, OnDestroy, OnHealDamage, OnMakeNoise, OnRanOver, OnSetBlockRigidBody, OnSetPhysics, OnTeleport, OnToggleHidden, OutsideWorldBounds, OverlappingActors, OverRotated, PawnBaseDied, PhysicsVolumeChange, PickedUpBy, PlayActorFaceFXAnim, PlayerCanSeeMe, PlaySound, PlayTeleportEffect, PointCheckComponent, PostBeginPlay, PostInitAnimTree, PostRenderFor, PostTeleport, PostTouch, PreBeginPlay, PreTeleport, RanInto, ReplaceText, ReplicatedEvent, Reset, RigidBodyCollision, RootMotionExtracted, RootMotionModeChanged, ScriptGetTeamNum, SetAnimPosition, SetAnimWeights, SetBase, SetCollision, SetCollisionSize, SetDrawScale, SetDrawScale3D, SetForcedInitialReplicatedProperty, SetGRI, SetHardAttach, SetHidden, SetHUDLocation, SetInitialState, SetLocation, SetMorphWeight, SetNetUpdateTime, SetOnlyOwnerSee, SetOwner, SetPhysics, SetRelativeLocation, SetRelativeRotation, SetRotation, SetSkelControlScale, SetTickGroup, SetTimer, SetZone, ShutDown, Sleep, Spawn, SpawnedByKismet, SpecialHandling, StopActorFaceFXAnim, StopsProjectile, SuggestTossVelocity, TakeDamage, TakeRadiusDamage, Tick, Timer, TimeSince, TornOff, Touch, TouchingActors, Trace, TraceActors, TraceComponent, TriggerEventClass, UnClock, UnTouch, UsedBy, VisibleActors, VisibleCollidingActors
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, ^, ^^, |, ||, ~, ~=


Variables Detail

bCamOverridePostProcess Source code

var bool bCamOverridePostProcess;
Indicates if CamPostProcessSettings should be used when using this Camera to view through.

bConstrainAspectRatio Source code

var bool bConstrainAspectRatio;
If we should insert black areas when rendering the scene to ensure an aspect ratio of ConstrainedAspectRatio

bEnableColorScaleInterp Source code

var bool bEnableColorScaleInterp;
Should interpolate color scale values

bEnableColorScaling Source code

var bool bEnableColorScaling;
Turn on scaling of color channels in final image using ColorScale property.

bEnableFading Source code

var bool bEnableFading;
If we should apply FadeColor/FadeAmount to the screen.

BlendParams Source code

var ViewTargetTransitionParams BlendParams;

BlendTimeToGo Source code

var float BlendTimeToGo;
Time left when blending to pending view target

bLockedFOV Source code

var bool bLockedFOV;
true if FOV is locked to a constant value

CameraCache Source code

var TCameraCache CameraCache;

CameraStyle Source code

var Name CameraStyle;
Camera Mode

CamPostProcessSettings Source code

var PostProcessSettings CamPostProcessSettings;
Post-process settings to use if bCamOverridePostProcess is TRUE.

ColorScale Source code

var vector ColorScale;
Allows control over scaling individual color channels in the final image.

ColorScaleInterpDuration Source code

var float ColorScaleInterpDuration;
Total time for color scale interpolation to complete

ColorScaleInterpStartTime Source code

var float ColorScaleInterpStartTime;
Time at which interpolation started

ConstrainedAspectRatio Source code

var float ConstrainedAspectRatio;
If bConstrainAspectRatio is true, add black regions to ensure aspect ratio is this. Ratio is horizontal/vertical.

DefaultAspectRatio Source code

var float DefaultAspectRatio;
Default aspect ratio

DefaultFOV Source code

var float DefaultFOV;
default FOV

DesiredColorScale Source code

var vector DesiredColorScale;
Desired color scale which ColorScale will interpolate to

FadeAmount Source code

var float FadeAmount;
Amount of fading to apply.

FadeColor Source code

var color FadeColor;
Color to fade to.

FreeCamDistance Source code

var float FreeCamDistance;
Distance to place free camera from view target

FreeCamOffset Source code

var vector FreeCamOffset;
Offset to Z free camera position

LockedFOV Source code

var float LockedFOV;
value FOV is locked at

ModifierList Source code

var Array<CameraModifier> ModifierList;
List of camera modifiers to apply during update of camera position/ rotation

OriginalColorScale Source code

var vector OriginalColorScale;
Color scale value at start of interpolation

PCOwner Source code

var PlayerController PCOwner;
PlayerController Owning this Camera Actor

PendingViewTarget Source code

var TViewTarget PendingViewTarget;
Pending view target for blending

ViewTarget Source code

var TViewTarget ViewTarget;
Current ViewTarget


Enumerations Detail

EViewTargetBlendFunction Source code

enum EViewTargetBlendFunction
{
VTBlend_Linear, VTBlend_Cubic, VTBlend_EaseIn, VTBlend_EaseOut, VTBlend_EaseInOut,
};


Structures Detail

TCameraCache Source code

struct TCameraCache
{
var TPOV POV;
var float TimeStamp;
};
The actors which the camera shouldn't see. Used to hide actors which the camera penetrates.
POV:
cached Point of View
TimeStamp:
Cached Time Stamp

TViewTarget Source code

struct TViewTarget
{
var(Camera) float AspectRatio;
var(Camera) Controller Controller;
var(Camera) TPOV POV;
var(Camera) PlayerReplicationInfo PRI;
var(Camera) Actor Target;
};
View Target definition A View Target is responsible for providing the Camera with an ideal Point of View (POV)
AspectRatio:
Aspect ratio
Controller:
Controller of Target (only for non Locally controlled Pawns)
POV:
Point of View
PRI:
PlayerReplicationInfo (used to follow same player through pawn transitions, etc., when spectating)
Target:
Target Actor used to compute ideal POV

ViewTargetTransitionParams Source code

struct ViewTargetTransitionParams
{
var(Camera) float BlendExp;
var(Camera) EViewTargetBlendFunction BlendFunction;
var(Camera) float BlendTime;
};
A set of parameters to describe how to transition between viewtargets.
BlendExp:
Exponent, used by certain blend functions to control the shape of the curve.
BlendFunction:
Function to apply to the blend parameter
BlendTime:
Total duration of blend to pending view target. 0 means no blending.


Functions Detail

AllowPawnRotation Source code

function bool AllowPawnRotation ( ) )

ApplyCameraModifiers Source code

event ApplyCameraModifiers ( float DeltaTime, out TPOV OutPOV) )
Apply modifiers on Camera.
@param DeltaTime Time is seconds since last update
@param OutPOV Point of View

BlendViewTargets Source code

final function TPOV BlendViewTargets ( const out TViewTarget A,const out TViewTarget B, float Alpha) )
Blend 2 viewtargets.
@param A Source view target
@paramn B destination view target
@param Alpha Alpha, % of blend from A to B.

CheckViewTarget Source code

native function CheckViewTarget ( out TViewTarget VT )
Make sure ViewTarget is valid

DisplayDebug Source code

simulated function DisplayDebug ( HUD HUD, out float out_YL, out float out_YPos) )
list important Camera variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used
@param HUD - HUD with canvas to draw on
@input out_YL - Height of the current font
@input out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.

FillCameraCache Source code

final function FillCameraCache ( const out TPOV NewPOV) )
Cache update results

GetCameraViewPoint Source code

final function GetCameraViewPoint ( out vector OutCamLoc, out rotator OutCamRot) )
Master function to retrieve Camera's actual view point. do not call this directly, call PlayerController::GetPlayerViewPoint() instead.
@param OutCamLoc Camera Location
@param OutCamRot Camera Rotation

GetFOVAngle Source code

function float GetFOVAngle ( ) )
returns camera's current FOV angle

InitializeFor Source code

function InitializeFor ( PlayerController PC) )
Initialize Camera for associated PlayerController
@param PC PlayerController attached to this Camera.

ProcessViewRotation Source code

function ProcessViewRotation ( float DeltaTime, out rotator OutViewRotation, out Rotator OutDeltaRot) )
Give each modifier a chance to change view rotation/deltarot

SetDesiredColorScale Source code

simulated function SetDesiredColorScale ( vector NewColorScale, float InterpTime) )
Sets the new desired color scale and enables interpolation.

SetFOV Source code

function SetFOV ( float NewFOV) )
Lock FOV to a specific value. A value of 0 to beyond 170 will unlock the FOV setting.

SetViewTarget Source code

native final function SetViewTarget ( Actor NewViewTarget, optional ViewTargetTransitionParams TransitionParams )
Set a new ViewTarget with optional BlendTime

UpdateCamera Source code

simulated event UpdateCamera ( float DeltaTime) )
Performs camera update. Called once per frame after all actors have been ticked.

UpdateViewTarget Source code

function UpdateViewTarget ( out TViewTarget OutVT, float DeltaTime) )
Query ViewTarget and outputs Point Of View.
@param OutVT ViewTarget to use.
@param DeltaTime Delta Time since last camera update (in seconds).


Defaultproperties

defaultproperties
{
   DefaultFOV=90.000000
   DefaultAspectRatio=1.333333
   CamPostProcessSettings=(bEnableBloom=True,bEnableSceneEffect=True,Bloom_Scale=1.000000,Bloom_InterpolationDuration=1.000000,DOF_FalloffExponent=4.000000,DOF_BlurKernelSize=16.000000,DOF_MaxNearBlurAmount=1.000000,DOF_MaxFarBlurAmount=1.000000,DOF_ModulateBlurColor=(B=255,G=255,R=255,A=255),DOF_FocusInnerRadius=2000.000000,DOF_InterpolationDuration=1.000000,MotionBlur_MaxVelocity=1.000000,MotionBlur_Amount=0.500000,MotionBlur_FullMotionBlur=True,MotionBlur_CameraRotationThreshold=45.000000,MotionBlur_CameraTranslationThreshold=10000.000000,MotionBlur_InterpolationDuration=1.000000,Scene_HighLights=(X=1.000000,Y=1.000000,Z=1.000000),Scene_MidTones=(X=1.000000,Y=1.000000,Z=1.000000),Scene_InterpolationDuration=1.000000)
   CameraCache=(POV=(FOV=90.000000))
   ViewTarget=(POV=(FOV=90.000000))
   PendingViewTarget=(POV=(FOV=90.000000))
   BlendParams=(BlendFunction=VTBlend_Cubic,BlendExp=2.000000)
   FreeCamDistance=256.000000
   bHidden=True
   CollisionType=COLLIDE_CustomDefault
   Name="Default__Camera"
   ObjectArchetype=Actor'Engine.Default__Actor'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:35.323 - Created with UnCodeX