1. Epic GamesDeveloper
  3. UHeterogeneousVolumeComponent

UHeterogeneousVolumeComponent

A component that represents a heterogeneous volume.

API > API/Runtime > API/Runtime/Engine

A component that represents a heterogeneous volume.

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

Syntax

UCLASS (Blueprintable, ClassGroup=(Rendering, Common),  
       HideCategories=(Object, Activation, "Components|Activation"), ShowCategories=(Mobility),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UHeterogeneousVolumeComponent : public UMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UHeterogeneousVolumeComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/HeterogeneousVolumeComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UHeterogeneousVolumeComponent()

   Components/HeterogeneousVolumeComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIssueBlockingRequests uint32   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=SparseVolumeTextureStreaming
bLooping uint32   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Animation
bPivotAtCentroid uint32   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Volume
bPlaying uint32   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Animation
EndFrame float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Animation
Frame float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Animation
  • Meta=(EditCondition="bPlaying == false")
FrameRate float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Animation
FrameTransform FTransform   Components/HeterogeneousVolumeComponent.h
  • VisibleAnywhere
  • BlueprintReadWrite
  • Category=Animation
  • AdvancedDisplay
LightingDownsampleFactor float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Lighting
MaterialInstanceDynamic TObjectPtr< UMaterialInstanceDynamic >   Components/HeterogeneousVolumeComponent.h
  • Transient
ShadowBiasFactor float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Lighting
ShadowStepFactor float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Lighting
StartFrame float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Animation
StepFactor float   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=Lighting
StreamingMipBias float Bias to apply to the calculated mip level to stream at. Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • Category=SparseVolumeTextureStreaming
  • AdvancedDisplay
VolumeResolution FIntVector   Components/HeterogeneousVolumeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Volume

Protected

Name Type Remarks Include Path Unreal Specifiers
PreviousSVT const USparseVolumeTexture *   Components/HeterogeneousVolumeComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Play()

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetEndFrame ( float NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetFrame ( float NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetFrameRate ( float NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetLooping ( bool NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetPlaying ( bool NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetStartFrame ( float NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Animation"

void SetStreamingMipBias ( int32 NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="SparseVolumeTextureStreaming"

void SetVolumeResolution ( FIntVector NewValue
)

   Components/HeterogeneousVolumeComponent.h
  • BlueprintCallable
  • Category="Volume"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/HeterogeneousVolumeComponent.h  

virtual int32 GetMaterialIndex ( FName MaterialSlotName
) const

   Components/HeterogeneousVolumeComponent.h  

virtual int32 GetNumMaterials()

 Return number of material elements in this primitive Components/HeterogeneousVolumeComponent.h  

virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
) const

 Retrieves the materials used in this component Components/HeterogeneousVolumeComponent.h  

virtual bool IsMaterialSlotNameValid ( FName MaterialSlotName
) const

   Components/HeterogeneousVolumeComponent.h  

virtual void SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh. Components/HeterogeneousVolumeComponent.h  

virtual bool ShouldRenderSelected()

 Return true if the owner is selected and this component is selectable Components/HeterogeneousVolumeComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. Components/HeterogeneousVolumeComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent. Components/HeterogeneousVolumeComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/HeterogeneousVolumeComponent.h  

virtual void PostInitProperties()

   Components/HeterogeneousVolumeComponent.h  

virtual void PostLoad()

   Components/HeterogeneousVolumeComponent.h  

virtual void PostReinitProperties()

   Components/HeterogeneousVolumeComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMaterialInstanceDynamic * CreateOrCastToMID ( UMaterialInterface* MaterialInterface
)

   Components/HeterogeneousVolumeComponent.h  

static USparseVolumeTexture * GetSparseVolumeTexture ( UMaterialInterface* MaterialInterface,
int32 ParameterIndex,
FName* OutParamName
)

   Components/HeterogeneousVolumeComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page