FAdvancedPreviewScene

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AdvancedPreviewScene

Header

/Engine/Source/Editor/AdvancedPreviewScene/Public/AdvancedPreviewScene.h

Include

#include "AdvancedPreviewScene.h"

Syntax

class FAdvancedPreviewScene :
    public FPreviewScene,
    public FTickableEditorObject

Variables

Name Description

Protected variable

bool

 

bPostProcessing

Protected variable

bool

 

bRotateLighting

Protected variable

bool

 

bSkyChanged

Protected variable

int32

 

CurrentProfileIndex

Protected variable

float

 

CurrentRotationSpeed

Protected variable

UAssetViewerSet...

 

DefaultSettings

Protected variable

UStaticMeshComp...

 

FloorMeshComponent

Protected variable

UMaterialInstan...

 

InstancedSkyMaterial

Protected variable

UPostProcessCom...

 

PostProcessComponent

Protected variable

float

 

PreviousRotation

Protected variable

FDelegateHandle

 

RefreshDelegate

Delegate handle used to refresh the scene when settings change

Protected variable

UStaticMeshComp...

 

SkyComponent

Protected variable

TSharedPtr< FUI...

 

UICommandList

Command list for input handling

Constructors

Name Description

Public function

FAdvancedPreviewScene

(
    ConstructionValues CVS,
    float InFloorOffset
)

Destructors

Name Description

Public function

~FAdvancedPreviewScene()

Functions

Name Description

Protected function

void

 

BindCommands()

Bind our command bindings to handlers

Public function Const

const int32

 

GetCurrentProfileIndex()

Public function Const

const UStati...

 

GetFloorMeshComponent()

Public function Const

const float

 

GetSkyRotation()

Public function

const bool

 

HandleInputKey

(
    FViewport* InViewport,
    int32 ControllerId,
    FKey Key,
    EInputEvent Event,
    float AmountDepressed,
    bool Gamepad
)

Protected function

void

 

HandleToggleEnvironment()

Toggle the sky sphere on and off

Protected function

void

 

HandleToggleFloor()

Toggle the floor mesh on and off

Protected function

void

 

HandleTogglePostProcessing()

Toggle post processing on and off

Public function

const bool

 

HandleViewportInput

(
    FViewport* InViewport,
    int32 ControllerId,
    FKey Key,
    float Delta,
    float DeltaTime,
    int32 NumSamples,
    bool bGamepad
)

Public function Const

const bool

 

IsUsingPostProcessing()

Protected function

void

 

OnAssetViewerSettingsRefresh

(
    const FName& InPropertyName
)

Handle refreshing the scene when settings change

Public function

void

 

SetEnvironmentVisibility

(
    const bool bVisible,
    const bool bDirect
)

Public function

void

 

SetFloorOffset

(
    const float InFloorOffset
)

Public function

void

 

SetFloorVisibility

(
    const bool bVisible,
    const bool bDirect
)

Sets the visiblity state for the floor/environment by storing it in the scene profile and refreshing the scene, in case bDirect is true it sets the visibility directly and leaves the profile untouched.

Public function

void

 

SetProfileIndex

(
    const int32 InProfileIndex
)

Public function

void

 

SetSkyRotation

(
    const float SkyRotation
)

Public function

void

 

UpdateScene

(
    FPreviewSceneProfile& Profile,
    bool bUpdateSkyLight,
    bool bUpdateEnvironment,
    bool bUpdatePostProcessing,
    bool bUpdateDirectionalLight
)

Overridden from FPreviewScene

Overridden from FTickableObjectBase

Name Description

Public function Virtual Const

TStatId

 

GetStatId()

Return the stat id to use for this tickable

Public function Virtual Const

ETickableTic...

 

GetTickableTickType()

Virtual that can be overloaded by the inheriting class.

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

End FPreviewScene Begin FTickableEditorObject

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback