| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||
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
AnimatedCamera
| Constants Summary |
|---|
| Inherited Contants from Core.Object |
|---|
| DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg |
| Variables Summary | |
|---|---|
| bool | bCamOverridePostProcess |
| bool | bConstrainAspectRatio |
| bool | bEnableColorScaleInterp |
| bool | bEnableColorScaling |
| bool | bEnableFading |
| ViewTargetTransitionParams | BlendParams |
| float | BlendTimeToGo |
| bool | bLockedFOV |
| TCameraCache | CameraCache |
| Name | CameraStyle |
| PostProcessSettings | CamPostProcessSettings |
| vector | ColorScale |
| float | ColorScaleInterpDuration |
| float | ColorScaleInterpStartTime |
| float | ConstrainedAspectRatio |
| float | DefaultAspectRatio |
| float | DefaultFOV |
| vector | DesiredColorScale |
| float | FadeAmount |
| color | FadeColor |
| float | FreeCamDistance |
| vector | FreeCamOffset |
| float | LockedFOV |
| Array<CameraModifier> | ModifierList |
| vector | OriginalColorScale |
| PlayerController | PCOwner |
| TViewTarget | PendingViewTarget |
| TViewTarget | ViewTarget |
| 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 |
| Functions Summary | ||
|---|---|---|
![]() | bool | AllowPawnRotation ())) |
![]() | ApplyCameraModifiers (float DeltaTime, out TPOV OutPOV)) | |
![]() | TPOV | BlendViewTargets (const out TViewTarget A, onst out TViewTarget B, float Alpha)) |
![]() | CheckViewTarget (out TViewTarget VT) | |
![]() | DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)) | |
![]() | FillCameraCache (const out TPOV NewPOV)) | |
![]() | GetCameraViewPoint (out vector OutCamLoc, out rotator OutCamRot)) | |
![]() | float | GetFOVAngle ())) |
![]() | InitializeFor (PlayerController PC)) | |
![]() | ProcessViewRotation (float DeltaTime, out rotator OutViewRotation, out Rotator OutDeltaRot)) | |
![]() | SetDesiredColorScale (vector NewColorScale, float InterpTime)) | |
![]() | SetFOV (float NewFOV)) | |
![]() | SetViewTarget (Actor NewViewTarget, optional ViewTargetTransitionParams TransitionParams) | |
![]() | UpdateCamera (float DeltaTime)) | |
![]() | UpdateViewTarget (out TViewTarget OutVT, float DeltaTime)) | |
| Variables Detail |
|---|
Indicates if CamPostProcessSettings should be used when using this Camera to view through.
If we should insert black areas when rendering the scene to ensure an aspect ratio of ConstrainedAspectRatio
Should interpolate color scale values
Turn on scaling of color channels in final image using ColorScale property.
If we should apply FadeColor/FadeAmount to the screen.
Time left when blending to pending view target
true if FOV is locked to a constant value
Camera Mode
Post-process settings to use if bCamOverridePostProcess is TRUE.
Allows control over scaling individual color channels in the final image.
Total time for color scale interpolation to complete
Time at which interpolation started
If bConstrainAspectRatio is true, add black regions to ensure aspect ratio is this. Ratio is horizontal/vertical.
Default aspect ratio
default FOV
Desired color scale which ColorScale will interpolate to
Amount of fading to apply.
Color to fade to.
Distance to place free camera from view target
Offset to Z free camera position
value FOV is locked at
List of camera modifiers to apply during update of camera position/ rotation
Color scale value at start of interpolation
PlayerController Owning this Camera Actor
Pending view target for blending
Current ViewTarget
| Enumerations Detail |
|---|
VTBlend_Linear, VTBlend_Cubic, VTBlend_EaseIn, VTBlend_EaseOut, VTBlend_EaseInOut,};
| Structures Detail |
|---|
The actors which the camera shouldn't see. Used to hide actors which the camera penetrates.
POV:cached Point of ViewTimeStamp:Cached Time Stamp
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 ratioController:Controller of Target (only for non Locally controlled Pawns)POV:Point of ViewPRI:PlayerReplicationInfo (used to follow same player through pawn transitions, etc., when spectating)Target:Target Actor used to compute ideal POV
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 parameterBlendTime:Total duration of blend to pending view target. 0 means no blending.
| Functions Detail |
|---|
AllowPawnRotation Source code
ApplyCameraModifiers Source codeApply modifiers on Camera.
@param DeltaTime Time is seconds since last update
@param OutPOV Point of View
BlendViewTargets Source codeBlend 2 viewtargets.
@param A Source view target
@paramn B destination view target
@param Alpha Alpha, % of blend from A to B.
CheckViewTarget Source codeMake sure ViewTarget is valid
DisplayDebug Source codelist 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 codeCache update results
GetCameraViewPoint Source codeMaster 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 codereturns camera's current FOV angle
InitializeFor Source codeInitialize Camera for associated PlayerController
@param PC PlayerController attached to this Camera.
ProcessViewRotation Source codeGive each modifier a chance to change view rotation/deltarot
SetDesiredColorScale Source codeSets the new desired color scale and enables interpolation.
SetFOV Source codeLock FOV to a specific value. A value of 0 to beyond 170 will unlock the FOV setting.
SetViewTarget Source codeSet a new ViewTarget with optional BlendTime
UpdateCamera Source codePerforms camera update. Called once per frame after all actors have been ticked.
UpdateViewTarget Source codeQuery 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 | UnrealScript Documentation |
| previous class next class | frames no frames | |||||