1. Epic GamesDeveloper
  3. ULocalFogVolumeComponent

ULocalFogVolumeComponent

API > API/Runtime > API/Runtime/Engine

   
Name ULocalFogVolumeComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/LocalFogVolumeComponent.h
Include Path #include "Components/LocalFogVolumeComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ULocalFogVolumeComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/LocalFogVolumeComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~ULocalFogVolumeComponent()

   Components/LocalFogVolumeComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FogAlbedo FLinearColor Controls the albedo of this fog volume. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Shading"
  • Meta=(ClampMin=0.0, ClampMax=1.0)
FogEmissive FLinearColor Controls the emissive color of this fog volume. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Shading"
  • Meta=(ClampMin=0.0, ClampMax=1.0)
FogPhaseG float Controls the phase `G_ parameter, describing the directionality of the scattering within this fog volume. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Shading"
  • Meta=(DisplayName="Scattering Distribution", UIMin="0.0", UIMax="0.999", ClampMin=0.0, ClampMax=0.999)
FogSortPriority int32 The priority can be used as a way to override the sorting by distance. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Sorting"
  • Meta=(UIMin="-127", UIMax="127", ClampMin=127, ClampMax=127)
HeightFogExtinction float The density of the radial fog representing its extinction coefficient at height 0 in the unit sphere. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Height Fog Distribution"
  • Meta=(DisplayName="Height Fog Density", UIMin="0", UIMax="2.0", SliderExponent=2.0, ClampMin=0.0)
HeightFogFalloff float Controls how the density decreases as height increases. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Height Fog Distribution"
  • Meta=(UIMin="1.0", UIMax="5000", SliderExponent=2.0, ClampMin=1.0)
HeightFogOffset float Height offset, relative to the actor Z position. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Height Fog Distribution"
  • Meta=(UIMin="-2.0", UIMax="2.0")
RadialFogExtinction float The density of the radial fog representing its extinction coefficient at the center of the sphere. Components/LocalFogVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Radial Fog Distribution"
  • Meta=(DisplayName="Radial Fog Density", UIMin="0", UIMax="2.0", SliderExponent=2.0, ClampMin=0.0)

Protected

Name Type Remarks Include Path Unreal Specifiers
LocalFogVolumeSceneProxy FLocalFogVolumeSceneProxy *   Components/LocalFogVolumeComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FLocalFogVolumeSceneProxy * CreateSceneProxy()

 Callback to create the rendering thread mirror. Components/LocalFogVolumeComponent.h  

void SetFogAlbedo ( FLinearColor NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetFogEmissive ( FLinearColor NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetFogPhaseG ( float NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Scattering Distribution")

void SetHeightFogExtinction ( float NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Height Fog Density")

void SetHeightFogFalloff ( float NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetHeightFogOffset ( float NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetRadialFogExtinction ( float NewValue
)

   Components/LocalFogVolumeComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Radial Fog Density")

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Components/LocalFogVolumeComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/LocalFogVolumeComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SendRenderTransformCommand()

   Components/LocalFogVolumeComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers
Used to create any rendering thread information for this component Components/LocalFogVolumeComponent.h  
Used to shut down any rendering thread structure for this component Components/LocalFogVolumeComponent.h  
Called to send a transform update for this component to the rendering thread Components/LocalFogVolumeComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static float GetBaseVolumeSize()

   Components/LocalFogVolumeComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page