UE3:Camera (UT3)

Object >> Actor >> Camera

Package: 

Engine

Direct subclass:

AnimatedCamera

This class in other games:

RTNP, U1, UT, UT2003, UT2004, U2, UE2Runtime, U2XMP, UDK

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

Properties

bCamOverridePostProcess

Type: bool

Indicates if CamPostProcessSettings should be used when using this Camera to view through.

bConstrainAspectRatio

Type: bool

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

bEnableColorScaleInterp

Type: bool

Should interpolate color scale values

bEnableColorScaling

Type: bool

Turn on scaling of color channels in final image using ColorScale property.

bEnableFading

Type: bool

If we should apply FadeColor/FadeAmount to the screen.

BlendParams

Type: ViewTargetTransitionParams

Default value:

Member	Value
BlendExp	2.0
BlendFunction	VTBlend_Cubic

BlendTimeToGo

Type: float

Time left when blending to pending view target

bLockedFOV

Type: bool

true if FOV is locked to a constant value

CameraCache

Type: TCameraCache

Default value:

Member	Value
POV	Member Value FOV 90.0

CameraStyle

Type: name

Camera Mode

CamPostProcessSettings

Type: PostProcessVolume.PostProcessSettings

Post-process settings to use if bCamOverridePostProcess is TRUE.

Default value:

Member	Value
bEnableBloom	True
bEnableSceneEffect	True
Bloom_InterpolationDuration	1.0
Bloom_Scale	1.0
DOF_BlurKernelSize	16.0
DOF_FalloffExponent	4.0
DOF_FocusInnerRadius	2000.0
DOF_InterpolationDuration	1.0
DOF_MaxFarBlurAmount	1.0
DOF_MaxNearBlurAmount	1.0
DOF_ModulateBlurColor	Member Value A 255 B 255 G 255 R 255
MotionBlur_Amount	0.5
MotionBlur_CameraRotationThreshold	45.0
MotionBlur_CameraTranslationThreshold	10000.0
MotionBlur_FullMotionBlur	True
MotionBlur_InterpolationDuration	1.0
MotionBlur_MaxVelocity	1.0
Scene_HighLights	Member Value X 1.0 Y 1.0 Z 1.0
Scene_InterpolationDuration	1.0
Scene_MidTones	Member Value X 1.0 Y 1.0 Z 1.0

ColorScale

Type: Object.Vector

Allows control over scaling individual color channels in the final image.

ColorScaleInterpDuration

Type: float

Total time for color scale interpolation to complete

ColorScaleInterpStartTime

Type: float

Time at which interpolation started

ConstrainedAspectRatio

Type: float

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

DefaultAspectRatio

Type: float

Default aspect ratio

Default value: 1.333333

DefaultFOV

Type: float

default FOV

Default value: 90.0

DesiredColorScale

Type: Object.Vector

Desired color scale which ColorScale will interpolate to

FadeAmount

Type: float

Amount of fading to apply.

FadeColor

Type: Object.Color

Color to fade to.

FreeCamDistance

Type: float

Distance to place free camera from view target

Default value: 256.0

FreeCamOffset

Type: Object.Vector

Offset to Z free camera position

LockedFOV

Type: float

value FOV is locked at

ModifierList

Type: array<CameraModifier>

List of camera modifiers to apply during update of camera position/ rotation

OriginalColorScale

Type: Object.Vector

Color scale value at start of interpolation

PCOwner

Type: PlayerController

PlayerController Owning this Camera Actor

PendingViewTarget

Type: TViewTarget

Pending view target for blending

Default value:

Member	Value
POV	Member Value FOV 90.0

ViewTarget

Type: TViewTarget

Current ViewTarget

Default value:

Member	Value
POV	Member Value FOV 90.0

Default values

Property	Value
bHidden	True
CollisionType	COLLIDE_CustomDefault

Enums

EViewTargetBlendFunction

VTBlend_Linear 

Camera does a simple linear interpolation.

VTBlend_Cubic 

Camera has a slight ease in and ease out, but amount of ease cannot be tweaked.

VTBlend_EaseIn 

Camera immediately accelerates, but smoothly decelerates into the target. Ease amount controlled by BlendExp.

VTBlend_EaseOut 

Camera smoothly accelerates, but does not decelerate into the target. Ease amount controlled by BlendExp.

VTBlend_EaseInOut 

Camera smoothly accelerates and decelerates. Ease amount controlled by BlendExp.

Structs

TCameraCache

Modifiers: native

The actors which the camera shouldn't see. Used to hide actors which the camera penetrates.

float TimeStamp 

Cached Time Stamp

Object.TPOV POV 

cached Point of View

TViewTarget

Modifiers: native

View Target definition A View Target is responsible for providing the Camera with an ideal Point of View (POV)

Actor Target 

Target Actor used to compute ideal POV

Controller Controller 

Controller of Target (only for non Locally controlled Pawns)

Object.TPOV POV 

Point of View

float AspectRatio 

Aspect ratio

PlayerReplicationInfo PRI 

PlayerReplicationInfo (used to follow same player through pawn transitions, etc., when spectating)

ViewTargetTransitionParams

Modifiers: native

A set of parameters to describe how to transition between viewtargets.

float BlendTime 

Total duration of blend to pending view target. 0 means no blending.

EViewTargetBlendFunction BlendFunction 

Function to apply to the blend parameter

float BlendExp 

Exponent, used by certain blend functions to control the shape of the curve.

Default values:

Property	Value
BlendExp	2.0
BlendFunction	VTBlend_Cubic

Functions

Native functions

CheckViewTarget

native function CheckViewTarget (out TViewTarget VT)

Make sure ViewTarget is valid

SetViewTarget

native final function SetViewTarget (Actor NewViewTarget, optional ViewTargetTransitionParams TransitionParams)

Set a new ViewTarget with optional BlendTime

Events

ApplyCameraModifiers

event ApplyCameraModifiers (float DeltaTime, out Object.TPOV OutPOV)

Apply modifiers on Camera.

Parameters:

• DeltaTime - Time is seconds since last update
• OutPOV - Point of View

UpdateCamera

simulated event UpdateCamera (float DeltaTime)

Performs camera update. Called once per frame after all actors have been ticked.

Other instance functions

AllowPawnRotation

function bool AllowPawnRotation ()

BlendViewTargets

final function Object.TPOV BlendViewTargets (const out TViewTarget A, const out TViewTarget B, float Alpha)

Blend 2 viewtargets.

Parameters:

• A - Source view target
• Alpha - Alpha, % of blend from A to B.

Paramn: B destination view target

DisplayDebug

simulated function DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)

Overrides: Actor.DisplayDebug

list important Camera variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used

Parameters:

• HUD - HUD with canvas to draw on
• out_YL - Height of the current font
• out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.

FillCameraCache

final function FillCameraCache (const out Object.TPOV NewPOV)

Cache update results

GetCameraViewPoint

final function GetCameraViewPoint (out Object.Vector OutCamLoc, out Object.Rotator OutCamRot)

Master function to retrieve Camera's actual view point. do not call this directly, call PlayerController::GetPlayerViewPoint() instead.

Parameters:

• OutCamLoc - Camera Location
• OutCamRot - Camera Rotation

GetFOVAngle

function float GetFOVAngle ()

returns camera's current FOV angle

InitializeFor

function InitializeFor (PlayerController PC)

Initialize Camera for associated PlayerController

Parameters:

• PC - PlayerController attached to this Camera.

ProcessViewRotation

function ProcessViewRotation (float DeltaTime, out Object.Rotator OutViewRotation, out Object.Rotator OutDeltaRot)

Give each modifier a chance to change view rotation/deltarot

SetDesiredColorScale

simulated function SetDesiredColorScale (Object.Vector NewColorScale, float InterpTime)

Sets the new desired color scale and enables interpolation.

SetFOV

function SetFOV (float NewFOV)

Lock FOV to a specific value. A value of 0 to beyond 170 will unlock the FOV setting.

UpdateViewTarget

function UpdateViewTarget (out TViewTarget OutVT, float DeltaTime)

Query ViewTarget and outputs Point Of View.

Parameters:

• OutVT - ViewTarget to use.
• DeltaTime - Delta Time since last camera update (in seconds).