1. Epic GamesDeveloper
  3. FPreviewScene

FPreviewScene

Encapsulates a simple scene setup for preview or thumbnail rendering.

Unreal Engine C++ API Reference > Runtime > Engine

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

  Type Name Description
Protected variable 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.
Public variable UDirectionalLightComponent * DirectionalLight  
Protected variable ULineBatchComponent * LineBatcher  
Protected variable TObjectPtr< class UWorld > PreviewWorld  
Public variable USkyLightComponent * SkyLight  

Constructors

  Type Name Description
Public function   For physical correct light computations we multiply diffuse and specular lights by PI (see LABEL_RealEnergy)

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AddComponent ( UActorComponent* Component,
const FTransform& LocalToWorld,
bool bAttachToRoot
)

 Adds a component to the preview scene.
Public function void Clean out the line batcher each frame
Public function Virtual Const FLinearColor Get the background color we use by default
Public function FRotator Accessor for finding the current direction of the preview scene's DirectionalLight.
Public function Const ULineBatchComponent * Access to line drawing
Public function Const FSceneInterface *  
Public function Const UWorld * Accessors.
Public function void

LoadSettings ( const TCHAR* Section
)

 Load/Save settings to the config, specifying the key
Public function Virtual void Removes a component from the preview scene.
Public function void

SaveSettings ( const TCHAR* Section
)

  
Public function void

SetLightBrightness ( float LightBrightness
)

  
Public function void

SetLightColor ( const FColor& LightColor
)

  
Public function void

SetLightDirection ( const FRotator& InLightDir
)

 Function for modifying the current direction of the preview scene's DirectionalLight.
Public function void

SetSkyBrightness ( float SkyBrightness
)

  
Public function void  
Public function void Update sky and reflection captures

Overridden from FGCObject

  Type Name Description
Public function Virtual void Serializer.
Public function Virtual Const FString Overload this method to report a name for your referencer

Classes

  Type Name Description
Public struct ConstructionValues    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page