1. Epic GamesDeveloper
  3. FSceneCapturePhotoSet

FSceneCapturePhotoSet

[FSceneCapturePhotoSet](API\Plugins\ModelingComponents\Scene\FSceneCapturePhotoSet) creates a set of render captures for a given World and set of Actors, stored as a SpatialPhotoSet for each desired render buffer type.

API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Scene

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Scene/SceneCapturePhotoSet.h
Include #include "Scene/SceneCapturePhotoSet.h"

Syntax

class FSceneCapturePhotoSet

Remarks

FSceneCapturePhotoSet creates a set of render captures for a given World and set of Actors, stored as a SpatialPhotoSet for each desired render buffer type. Currently the set of buffers are defined by ERenderCaptureType: BaseColor Roughness Metallic Specular PackedMRS (Metallic / Roughness / Specular) Emissive Opacity SubsurfaceColor WorldNormal DeviceDepth

There are various efficiences possible by doing these captures as a group, rather than doing each one individually.

One the capture set is computed, the ComputeSample() function can be used to call SpatialPhotoSet::ComputeSample() on each photo set, ie to estimate the value of the different channels at a given 3D position/normal by raycasting against the photo set. Again, it can be more efficient to do this on the group, rather than each individually.

Variables

  Type Name Description
Protected variable bool bAllowCancel  
Protected variable FSpatialPhotoSet3f BaseColorPhotoSet  
Protected variable bool bEnforceVisibilityViaUnregister  
Protected variable bool bWasCancelled  
Protected variable bool bWriteDebugImages  
Protected variable FString DebugImagesFolderName  
Protected variable FSpatialPhotoSet1f DeviceDepthPhotoSet  
Protected variable FSpatialPhotoSet3f EmissivePhotoSet  
Protected variable FSpatialPhotoSet1f MetallicPhotoSet  
Protected variable FSpatialPhotoSet1f OpacityPhotoSet  
Protected variable FSpatialPhotoSet3f PackedMRSPhotoSet  
Protected variable TArray< FSpatialPhotoParams > PhotoSetParams  
Protected variable FStatus PhotoSetStatus  
Protected variable TRenderCaptureTypeData< FRenderCaptureConfig > RenderCaptureConfig  
Protected variable FSpatialPhotoSet1f RoughnessPhotoSet  
Protected variable FSpatialPhotoSet1f SpecularPhotoSet  
Protected variable FSpatialPhotoSet3f SubsurfaceColorPhotoSet  
Protected variable UWorld * TargetWorld  
Protected variable TArray< AActor * > VisibleActors  
Protected variable TArray< UActorComponent * > VisibleComponents  
Protected variable FSpatialPhotoSet3f WorldNormalPhotoSet  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool  
Public function void

Compute ()

 Render the configured scene, for the configured capture types from the configured viewpoints.
Public function Const bool

ComputeSample ( const FRenderCaptureTypeFlags& SampleChannels,
const FVector3d& Position,
const FVector3d& Normal,
TFunctionRef< bool(const FVector3d&, const FVector3d&)> VisibilityFunction,
FSceneSample& DefaultsInResultsOut
)

 Sample the requested SampleChannels from the available PhotoSets to determine values at the given 3D Position/Normal.
Public function Const bool

ComputeSampleLocation ( const FVector3d& Position,
const FVector3d& Normal,
float ValidSampleDepthThreshold,
TFunctionRef< bool(const FVector3d&, const FVector3d&)> VisibilityFunction,
int& PhotoIndex,
FVector2d& PhotoCoords
)

 If ValidSampleDepthThreshold > 0 then the VisibilityFunction and the DeviceDepthPhotoSet will be used to determine sample validity.
Public function Const FVector4f

ComputeSampleNearest ( const int& PhotoIndex,
const FVector2d& PhotoCoords,
const FSceneSample& DefaultSample
)

  
Public function void Disable all capture types.
Public function const FSpatialPhotoSet3f &  
Public function Const FRenderCaptureConfig

GetCaptureConfig ( ERenderCaptureType CaptureType
)

  
Public function UWorld *  
Public function Const ECaptureTypeStatus

GetCaptureTypeStatus ( ERenderCaptureType CaptureType
)

 Returns the current status of the given capture type
Public function const FSpatialPhotoSet1f &  
Public function const FSpatialPhotoSet3f &  
Public function const FSpatialPhotoSet1f &  
Public function const FSpatialPhotoSet1f &  
Public function const FSpatialPhotoSet3f &  
Public function const FSpatialPhotoSet1f &  
Public function Const FStatus Returns the current status of all capture types
Public function void

GetSceneSamples ( FSceneSamples& OutSamples
)

 Fills in the non-null arrays in OutSamples if the status of the needed captures is Computed
Public function Const const TArray< FSpatialPhotoParams > &  
Public function const FSpatialPhotoSet1f &  
Public function const FSpatialPhotoSet3f &  
Public function const FSpatialPhotoSet3f &  
Public function void Post-process the various PhotoSets after capture, to reduce memory usage and sampling cost.
Public function void

SetAllowCancel ( bool bAllowCancelIn
)

  
Public function void

SetCaptureConfig ( ERenderCaptureType CaptureType,
const FRenderCaptureConfig& Config
)

 Configure the given capture type If Config != the existing capture config the corresponding photo set will be cleared
Public function void

SetCaptureSceneActors ( UWorld* World,
const TArray< AActor* >& Actors
)

 Set the target World and set of Actors/Components If World != this->World or Actors != this->Actors all existing photo sets are cleared Note: The caller must ensure Actors does not contain nullptr
Public function void

SetCaptureSceneActorsAndComponents ( UWorld* World,
const TArray< AActor* >& Actors,
const TArray< UActorComponent* >& Components
)

  
Public function void

SetCaptureSceneComponents ( UWorld* World,
const TArray< UActorComponent* >& Components
)

  
Public function void

SetCaptureTypeEnabled ( ERenderCaptureType CaptureType,
bool bEnabled
)

 Enable/Disable a particular capture type If bEnabled == false the corresponding photo set will be cleared
Public function void If enabled, any Component Scene Proxies in the level that are not meant to be included in the capture (ie not added via SetCaptureSceneActors), will be unregistered to hide them.
Public function void

SetEnableWriteDebugImages ( bool bEnable,
FString FolderName
)

 Enable debug image writing.
Public function void

SetSpatialPhotoParams ( const TArray< FSpatialPhotoParams >& SpatialParams
)

 Set the parameters positioning the virtual cameras used to capture the photo sets If SpatialParams != this->PhotoSetParams all existing photo sets are cleared (TODO clear on a more granular level)

Classes

  Type Name Description
Public struct FSceneSample FSceneSample stores a full sample of all possible channels, some values may be default-values though  
Public struct FSceneSamples FSceneSamples stores samples corresponding to pixels in the DeviceDepth photoset where the values are strictly within the viewing frustum, which corresponds to a camera ray intersecting an actor in VisibleActors.  

Enums

  Type Name Description
Public enum ECaptureTypeStatus Status of a given capture type  

Typedefs

Name Description
FStatus Status of the overall scene capture i.e., the combined status of all capture types

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page