GameFramework.GameThirdPersonCamera

Extends

GameCameraBase

Modifiers

config ( Camera ) native ( Camera )

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- GameFramework.GameCameraBase
   |   
   +-- GameFramework.GameThirdPersonCamera

Functions Summary
		AdjustFocusPointInterpolation (rotator Delta))
		AdjustTurn (int AngleOffset))
		BeginTurn (int StartAngle, int EndAngle, float TimeSec, optional float DelaySec, optional bool bAlignTargetWhenFinished))
		ClearFocusPoint (optional bool bLeaveCameraRotation))
	GameThirdPersonCameraMode	CreateCameraMode (class<GameThirdPersonCameraMode> ModeClass))
		EndTurn ()
	GameThirdPersonCameraMode	FindBestCameraMode (Pawn P))
	vector	GetActualFocusLocation ()))
	float	GetDesiredFOV (Pawn ViewedPawn ))
	Actor	GetFocusActor ()))
		Init ()))
		ModifyPostProcessSettings (out PostProcessSettings PP))
		OnBecomeActive (GameCameraBase OldCamera ))
		PlayerUpdateCamera (Pawn P, GamePlayerCamera CameraActor, float DeltaTime, out TViewTarget OutVT)
		ProcessViewRotation (float DeltaTime, Actor ViewTarget, out Rotator out_ViewRotation, out Rotator out_DeltaRot ))
		Reset ()))
		ResetInterpolation ()))
		SetFocusOnActor (Actor FocusActor, Name FocusBoneName, Vector2d InterpSpeedRange, Vector2d InFocusFOV, optional float CameraFOV, optional bool bAlwaysFocus, optional bool bAdjustCamera, optional bool bIgnoreTrace, optional float FocusPitchOffsetDeg ))
		SetFocusOnLoc (vector FocusWorldLoc, Vector2d InterpSpeedRange, Vector2d InFocusFOV, optional float CameraFOV, optional bool bAlwaysFocus, optional bool bAdjustCamera, optional bool bIgnoreTrace, optional float FocusPitchOffsetDeg ))
		UpdateCamera (Pawn P, GamePlayerCamera CameraActor, float DeltaTime, out TViewTarget OutVT))
		UpdateCameraMode (Pawn P))
		UpdateFocusPoint (Pawn P ))

ActualFocusPointWorldLoc Source code

bDoingACameraTurn Source code

bDoingDirectLook Source code

bDoSeamlessPivotTransition Source code

Set to TRUE when the Pivot makes a big jump if you want to keep the camera in place across that transition.

bFocusPointSet Source code

do we have a focus point set?

bFocusPointSuccessful Source code

Internal. TRUE if the focus point was good and the camera looked at it, FALSE otherwise (e.g. failed the trace).

bTurnAlignTargetWhenFinished Source code

DirectLookYaw Source code

direct look vars

LastActualCameraOrigin Source code

Last actual camera origin position, for lazy cam interpolation. It's only applied to player's origin, not view offsets, for faster/smoother response

LastActualCameraOriginRot Source code

Last actual camera origin rotation, for lazy cam interpolation. It's only applied to player's origin, not view offsets, for faster/smoother response

LastActualOriginOffset Source code

Last pawn relative offset, for slow offsets interpolation. This is because this offset is relative to the Pawn's rotation, which can change abruptly (when snapping to cover). Used to adjust the camera origin (evade, lean, pop up, blind fire, reload..)

LastCamFOV Source code

last CamFOV for war cam interpolation

LastFocusChangeTime Source code

Last time focus point changed (location)

LastFocusPointLoc Source code

Last focus point location

LastHeightAdjustment Source code

last offset adjustment, for smooth blend out

LastIdealCameraOrigin Source code

Cached ideal pivot loc

LastIdealCameraOriginRot Source code

Cached ideal pivot rot

LastOffsetAdjustment Source code

Offset adjustment from last tick, used for interpolation.

LastPitchAdjustment Source code

last adjusted pitch, for smooth blend out

LastPostCamTurnYaw Source code

Saved data for camera turn "align when finished" functionality

LastPreModifierCameraLoc Source code

Last location and rotation of the camera, cached before camera modifiers are applied.

LastPreModifierCameraRot Source code

LastViewOffset Source code

View relative offset. This offset is relative to Controller's rotation, mainly used for Pitch positioning.

LastWorstLocationLocal Source code

LastYawAdjustment Source code

last adjusted Yaw, for smooth blend out

LeftoverPitchAdjustment Source code

pitch adjustment when keeping target is done in 2 parts. this is the amount to pitch in part 2 (post view offset application)

PenetrationBlockedPct Source code

Percentage of distance blocked by collision. From worst location, to desired location.

TurnCurTime Source code

Vars for code-driven camera turns

TurnDelay Source code

TurnEndAngle Source code

TurnStartAngle Source code

TurnTotalTime Source code

WorstLocBlockedPct Source code

obstruction pct from origin to worstloc origin

Debug

bDebugChangedCameraMode Source code

Change in camera mode happened this frame - reset on first call to PlayerUpdateCamera

Focus

FocusPoint Source code

current focus point

Focus_BackOffStrength Source code

move back pct based on move up

Focus_FastAdjustKickInTime Source code

time it takes for fast interpolation speed to kick in

Focus_MaxTries Source code

number of tries to have focus in view

Focus_StepHeightAdjustment Source code

Z offset step for every try

GameThirdPersonCamera

bDrawDebug Source code

toggles debug mode

CurrentCamMode Source code

Current GearCam Mode

DirectLookInterpSpeed Source code

OriginOffsetInterpSpeed Source code

origin offset interpolation speed

PenetrationAvoidanceFeelers Source code

PenetrationBlendInTime Source code

Time to transition from ideal location to blocked position, after camera collision with geometry. (used only by predictive feelers)

PenetrationBlendOutTime Source code

Time to transition from blocked location to ideal position, after camera collision with geometry.

PenetrationExtentScale Source code

camera extent scale to use when calculating penetration for this segment

ThirdPersonCamDefault Source code

Base camera position when walking

ThirdPersonCamDefaultClass Source code

WorstLocInterpSpeed Source code

WorstLocPenetrationExtentScale Source code

camera extent scale to use when calculating penetration for this segment

CamFocusPointParams Source code

Camera focus point definition
bAdjustCamera:

If TRUE, camera adjusts to keep player in view, if FALSE the camera remains fixed and just rotates in place

bAlwaysFocus:

If FALSE, focus only if point roughly in view; if TRUE, focus no matter where player is looking

bIgnoreTrace:

If TRUE, ignore world trace to find a good spot

CameraFOV:

If >0, FOV to force upon camera while looking at this point (degrees)

FocusActor:

Actor to focus on.

FocusBoneName:

Bone name to focus on. Ignored if FocusActor is None or has no SkeletalMeshComponent

FocusPitchOffsetDeg:

Offsets the pitch. e.g. 20 will look 20 degrees above the target

FocusWorldLoc:

Focus point location in world space. Ignored if FocusActor is not None.

InFocusFOV:

FOV where target is considered in focus, no correction is made. X is yaw tolerance, Y is pitch tolerance.

InterpSpeedRange:

Interpolation speed (X=slow/focus loc moving, Y=fast/focus loc steady/blending out)

PenetrationAvoidanceFeeler Source code

Struct defining a feeler ray used for camera penetration avoidance.
AdjustmentRot:

rotator describing deviance from main ray

Extent:

extent to use for collision when firing this ray

FramesUntilNextTrace:

number of frames since this feeler was used

PawnWeight:

how much this feeler affects the final position if it hits a Pawn (setting to 0 will not attempt to collide with pawns at all)

TraceInterval:

minimum frame interval between traces with this feeler if nothing was hit last frame

WorldWeight:

how much this feeler affects the final position if it hits the world

AdjustFocusPointInterpolation Source code

Use this if you keep the same focus point, but move the camera basis around underneath it e.g. you want the camera to hold steady focus, but the camera target is rotating

AdjustTurn Source code

Adjusts a camera rotation. Useful for situations where the basis of the rotation changes.
@param AngleOffset Yaw adjustment to apply (in Rotator units)

BeginTurn Source code

Initiates a forced camera rotation.
@param StartAngle Starting Yaw offset (in Rotator units)
@param EndAngle Finishing Yaw offset (in Rotator units)
@param TimeSec How long the rotation should take
@param DelaySec How long to wait before starting the rotation

ClearFocusPoint Source code

Clear focus point

CreateCameraMode Source code

Internal.

EndTurn Source code

Stops a camera rotation.

FindBestCameraMode Source code

Evaluates the game state and returns the proper camera mode.
@return new camera mode to use

GetActualFocusLocation Source code

Internal. Returns the world space position of the current focus point.

GetDesiredFOV Source code

returns camera mode desired FOV

GetFocusActor Source code

Returns ref to the actor currently being used as a focus point, if any.

Init Source code

ModifyPostProcessSettings Source code

OnBecomeActive Source code

Called when Camera mode becomes active

PlayerUpdateCamera Source code

Internal camera updating code

ProcessViewRotation Source code

Gives cameras a chance to change player view rotation

Reset Source code

ResetInterpolation Source code

SetFocusOnActor Source code

Tells camera to focus on the given actor.

SetFocusOnLoc Source code

Tells camera to focus on the given world position.

UpdateCamera Source code

Player Update Camera code

UpdateCameraMode Source code

Update current camera modes. Pick Best, handle transitions, etc.

UpdateFocusPoint Source code

Per-tick focus point processing, for polling gamestate and adjusting as desired. Override if you want other systems or criteria to set focus points.

defaultproperties
{
	PenetrationBlendOutTime=0.15f
	PenetrationBlendInTime=0.1f
	PenetrationBlockedPct=1.f
	PenetrationExtentScale=1.f

	WorstLocPenetrationExtentScale=1.f
	WorstLocInterpSpeed=8

	bResetCameraInterpolation=TRUE	

	OriginOffsetInterpSpeed=8

	Focus_BackOffStrength=0.33f
	Focus_StepHeightAdjustment= 64
	Focus_MaxTries=4
	Focus_FastAdjustKickInTime=0.5

	bDoingACameraTurn=FALSE

	DirectLookInterpSpeed=6.f

	
	PenetrationAvoidanceFeelers(0)=(AdjustmentRot=(Pitch=0,Yaw=0,Roll=0),WorldWeight=1.f,PawnWeight=1.f,Extent=(X=14,Y=14,Z=14))

	
	PenetrationAvoidanceFeelers(1)=(AdjustmentRot=(Pitch=0,Yaw=3072,Roll=0),WorldWeight=0.75f,PawnWeight=0.75f,Extent=(X=0,Y=0,Z=0), TraceInterval=3)
	PenetrationAvoidanceFeelers(2)=(AdjustmentRot=(Pitch=0,Yaw=-3072,Roll=0),WorldWeight=0.75f,PawnWeight=0.75f,Extent=(X=0,Y=0,Z=0), TraceInterval=3)
	PenetrationAvoidanceFeelers(3)=(AdjustmentRot=(Pitch=0,Yaw=6144,Roll=0),WorldWeight=0.5f,PawnWeight=0.5f,Extent=(X=0,Y=0,Z=0), TraceInterval=5)
	PenetrationAvoidanceFeelers(4)=(AdjustmentRot=(Pitch=0,Yaw=-6144,Roll=0),WorldWeight=0.5f,PawnWeight=0.5f,Extent=(X=0,Y=0,Z=0), TraceInterval=5)

	
	PenetrationAvoidanceFeelers(5)=(AdjustmentRot=(Pitch=3640,Yaw=0,Roll=0),WorldWeight=1.f,PawnWeight=1.f,Extent=(X=0,Y=0,Z=0), TraceInterval=4)
	PenetrationAvoidanceFeelers(6)=(AdjustmentRot=(Pitch=-3640,Yaw=0,Roll=0),WorldWeight=0.5f,PawnWeight=0.5f,Extent=(X=0,Y=0,Z=0), TraceInterval=4)

	ThirdPersonCamDefaultClass=class'GameThirdPersonCameraMode_Default'
}