FPreviewScene | Unreal Engine 5.7 Documentation

Encapsulates a simple scene setup for preview or thumbnail rendering.


Name	FPreviewScene
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/PreviewScene.h
Include Path	#include "PreviewScene.h"

Syntax

class FPreviewScene : public FGCObject

Name	Remarks	Include Path	Unreal Specifiers
FPreviewScene ( ConstructionValues CVS )	For physical correct light computations we multiply diffuse and specular lights by PI (see LABEL_RealEnergy)	PreviewScene.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FPreviewScene()		PreviewScene.h

Name	Remarks
ConstructionValues

Name	Type	Remarks	Include Path	Unreal Specifiers
DirectionalLight	UDirectionalLightComponent *		PreviewScene.h
SkyLight	USkyLightComponent *		PreviewScene.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Components	TArray< TObjectPtr< class UActorComponent > >		PreviewScene.h

Name	Remarks	Include Path
virtual void AddComponent ( UActorComponent* Component, const FTransform& LocalToWorld, bool bAttachToRoot )	Adds a component to the preview scene.	PreviewScene.h
void ClearLineBatcher()	Clean out the line batcher each frame	PreviewScene.h
virtual FLinearColor GetBackgroundColor()	Get the background color we use by default	PreviewScene.h
FRotator GetLightDirection()	Accessor for finding the current direction of the preview scene's DirectionalLight.	PreviewScene.h
ULineBatchComponent * GetLineBatcher()	Access to line drawing	PreviewScene.h
FSceneInterface * GetScene()		PreviewScene.h
UWorld * GetWorld()	Accessors.	PreviewScene.h
bool IsInitialized()		PreviewScene.h
void LoadSettings ( const TCHAR* Section )	Load/Save settings to the config, specifying the key	PreviewScene.h
virtual void RemoveComponent ( UActorComponent* Component )	Removes a component from the preview scene.	PreviewScene.h
void SaveSettings ( const TCHAR* Section )		PreviewScene.h
void SetLightBrightness ( float LightBrightness )		PreviewScene.h
void SetLightColor ( const FColor& LightColor )		PreviewScene.h
void SetLightDirection ( const FRotator& InLightDir )	Function for modifying the current direction of the preview scene's DirectionalLight.	PreviewScene.h
void SetSkyBrightness ( float SkyBrightness )		PreviewScene.h
void SetSkyCubemap ( UTextureCube* Cubemap )		PreviewScene.h
void UpdateCaptureContents()	Update sky and reflection captures	PreviewScene.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void AddReferencedObjects ( FReferenceCollector& Collector )	Serializer.	PreviewScene.h
virtual FString GetReferencerName()		PreviewScene.h