Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FPreviewScene

Encapsulates a simple scene setup for preview or thumbnail rendering.

Inheritance Hierarchy

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/PreviewScene.h
Include	#include "PreviewScene.h"

Syntax

class FPreviewScene : public FGCObject

Remarks

Encapsulates a simple scene setup for preview or thumbnail rendering.

Variables

	Name	Description
bool	bForceAllUsedMipsResident	This controls whether or not all mip levels of textures used by UMeshComponents added to this preview window should be loaded and remain loaded.
UDirectionalLig...	DirectionalLight
ULineBatchCompo...	LineBatcher
UWorld *	PreviewWorld
USkyLightCompon...	SkyLight

Constructors

	Name	Description
	FPreviewScene ( ConstructionValues CVS )	For physical correct light computations we multiply diffuse and specular lights by PI (see LABEL_RealEnergy)

Destructors

	Name	Description
	~FPreviewScene()

Functions

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

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Serializer.
	FString	GetReferencerName()	Overload this method to report a name for your referencer

Classes

	Name	Description
	ConstructionValues

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel