UE3:CameraModifier (UDK)

Object >> CameraModifier

Package: 

Engine

Direct subclass:

CameraModifier_CameraShake

This class in other games:

UT3

Properties

Property group 'Debug'

bDebug

Type: bool

Internal variables

Alpha

Type: float

Modifiers: protected, transient

Current blend alpha

AlphaInTime

Type: float

Modifiers: protected

When blending in, alpha proceeds from 0 to 1 over this time

AlphaOutTime

Type: float

Modifiers: protected

When blending out, alpha proceeds from 1 to 0 over this time

bDisabled

Type: bool

Modifiers: protected

bExclusive

Type: bool

Modifiers: protected

This modifier can only be used exclusively - no modifiers of same priority allowed

bPendingDisable

Type: bool

CameraOwner

Type: Camera

Camera this object is attached to

Priority

Type: byte

Modifiers: protected

Priority of this modifier - determines where it is added in the modifier list. 0 = highest priority, 255 = lowest

Default value: 127

TargetAlpha

Type: float

Modifiers: protected, transient

Desired alpha we are interpolating towards.

Functions

Native functions

IsDisabled

native function bool IsDisabled () const

Accessor function to check if modifier is inactive

ModifyCamera

native function bool ModifyCamera (Camera Camera, float DeltaTime, out Object.TPOV OutPOV)

Directly modifies variables in the camera actor

Parameters:

• Camera - reference to camera actor we are modifying
• DeltaTime - Change in time since last update
• OutPOV - current Point of View, to be updated.

Returns:

bool TRUE if should STOP looping the chain, FALSE otherwise

UpdateAlpha

native function UpdateAlpha (Camera Camera, float DeltaTime)

Responsible for updating alpha blend value.

Parameters:

• Camera - Camera that is being updated
• DeltaTime - Amount of time since last update

Events

DisableModifier

event DisableModifier (optional bool bImmediate)

Accessor functions for changing disable flag

Parameters:

• bImmediate - TRUE to disable with no blend out, FALSE (default) to allow blend out

Other instance functions

AddCameraModifier

function bool AddCameraModifier (Camera Camera)

Camera modifier evaluates itself vs the given camera's modifier list and decides whether to add itself or not. Handles adding by priority and avoiding adding the same modifier twice.

Parameters:

• Camera - reference to camera actor we want add this modifier to

Returns:

bool - TRUE if modifier added to camera's modifier list, FALSE otherwise

EnableModifier

function EnableModifier ()

Init

function Init ()

Allow anything to happen right after creation

ProcessViewRotation

simulated function bool ProcessViewRotation (Actor ViewTarget, float DeltaTime, out Object.Rotator out_ViewRotation, out Object.Rotator out_DeltaRot)

Allow this modifier a chance to change view rotation and deltarot Default just returns ViewRotation unchanged

Returns:

bool - TRUE if should stop looping modifiers to adjust rotation, FALSE otherwise

RemoveCameraModifier

function bool RemoveCameraModifier (Camera Camera)

Camera modifier removes itself from given camera's modifier list

Parameters:

• Camera - reference to camara actor we want to remove this modifier from

Returns:

bool - TRUE if modifier removed successfully, FALSE otherwise

ToggleModifier

function ToggleModifier ()