UE3:SceneCaptureComponent (UDK)

Object >> Component >> ActorComponent >> SceneCaptureComponent

Package: 

Engine

Direct subclasses:

SceneCapture2DComponent, SceneCapture2DHitMaskComponent, SceneCaptureCubeMapComponent, SceneCapturePortalComponent, SceneCaptureReflectComponent

This class in other games:

UT3

SceneCaptureComponent

Base class for scene recording components

Properties

Property group 'Capture'

bEnabled

Type: bool

Turn the scene capture on/off

Default value: True

bEnableFog

Type: bool

toggle fog

bEnablePostProcess

Type: bool

toggle scene post-processing

bUseMainScenePostProcessSettings

Type: bool

If TRUE then use the main scene's post process settings when capturing

ClearColor

Type: Object.Color

background color

Default value:

Member	Value
A	255
B	0
G	0
R	0

FrameRate

Type: float

Modifiers: const

rate to capture the scene, TimeBetweenCaptures = Max( 1/FrameRate, DeltaTime), if the FrameRate is 0 then the scene is captured only once

Default value: 30.0

MaxStreamingUpdateDist

Type: float

if > 0, skip streaming texture updates for the scene capture if the Owner is further than this many units away from the viewer. if == 0, then view information for this scene capture is not used by texture streaming manager for updates.

MaxUpdateDist

Type: float

if > 0, skip updating the scene capture if the Owner is further than this many units away from the viewer

PostProcess

Type: PostProcessChain

Chain of post process effects for this post process view

SceneLOD

Type: int

NOT IMPLEMENTED! level-of-detail setting

ViewMode

Type: ESceneCaptureViewMode

how to draw the scene

Default value: SceneCapView_LitNoShadows

Internal variables

bNeedsSceneUpdate

Type: bool

Modifiers: private, const, transient, native

TRUE if the scene capture needs to be updated in the scene

bSkipUpdateIfOwnerOccluded

Type: bool

if true, skip updating the scene capture if the Owner of the component has not been rendered recently

CaptureInfo

Type: pointer{FCaptureSceneInfo}

Modifiers: private, const, transient, native

ptr to the scene capture probe

ViewState

Type: pointer{FSceneViewStateInterface}

Modifiers: private, const, transient, native

pointer to the persistent view state for this scene capture

Enums

ESceneCaptureViewMode

SceneCapView_Lit 

SceneCapView_Unlit 

SceneCapView_LitNoShadows 

SceneCapView_Wire 

Functions

Native functions

SetEnabled

simulated native final function SetEnabled (bool bEnable)

Enable or disable this SceneCaptureComponent.

SetFrameRate

native final function SetFrameRate (float NewFrameRate)

modifies the value of FrameRate

Other instance functions

NeedsUpdate

simulated final function bool NeedsUpdate ()