1. Epic GamesDeveloper
  3. ULocalFogVolumeComponent

ULocalFogVolumeComponent

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/LocalFogVolumeComponent.h
Include #include "Components/LocalFogVolumeComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, CollapseCategories,  
       HideCategories=(Object, Mobility, Activation, "Components|Activation"), EditInlineNew,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class ULocalFogVolumeComponent : public USceneComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor FogAlbedo Controls the albedo of this fog volume.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor FogEmissive Controls the emissive color of this fog volume.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float FogPhaseG Controls the phase `G_ parameter, describing the directionality of the scattering within this fog volume.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 FogSortPriority The priority can be used as a way to override the sorting by distance.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float HeightFogExtinction The density of the radial fog representing its extinction coefficient at height 0 in the unit sphere.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float HeightFogFalloff Controls how the density decreases as height increases.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float HeightFogOffset Height offset, relative to the actor Z position.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float RadialFogExtinction The density of the radial fog representing its extinction coefficient at the center of the sphere.

Constructors

  Type Name Description
Public function  

ULocalFogVolumeComponent ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FLocalFogVolumeSceneProxy * Callback to create the rendering thread mirror.
Public function Static float  
Protected function void  
Public function UFunction BlueprintCallable, Category void

SetFogAlbedo ( FLinearColor NewValue
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category, Meta void

SetFogPhaseG ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetHeightFogExtinction ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHeightFogFalloff ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHeightFogOffset ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetRadialFogExtinction ( float NewValue
)

  

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Used to create any rendering thread information for this component
Protected function Virtual void Used to shut down any rendering thread structure for this component
Protected function Virtual void Called to send a transform update for this component to the rendering thread

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page