Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UHeterogeneousVolumeComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
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 |
|
|
| bLooping | uint32 | Components/HeterogeneousVolumeComponent.h |
|
|
| bPivotAtCentroid | uint32 | Components/HeterogeneousVolumeComponent.h |
|
|
| bPlaying | uint32 | Components/HeterogeneousVolumeComponent.h |
|
|
| EndFrame | float | Components/HeterogeneousVolumeComponent.h |
|
|
| Frame | float | Components/HeterogeneousVolumeComponent.h |
|
|
| FrameRate | float | Components/HeterogeneousVolumeComponent.h |
|
|
| FrameTransform | FTransform | Components/HeterogeneousVolumeComponent.h |
|
|
| LightingDownsampleFactor | float | Components/HeterogeneousVolumeComponent.h |
|
|
| MaterialInstanceDynamic | TObjectPtr< UMaterialInstanceDynamic > | Components/HeterogeneousVolumeComponent.h |
|
|
| ShadowBiasFactor | float | Components/HeterogeneousVolumeComponent.h |
|
|
| ShadowStepFactor | float | Components/HeterogeneousVolumeComponent.h |
|
|
| StartFrame | float | Components/HeterogeneousVolumeComponent.h |
|
|
| StepFactor | float | Components/HeterogeneousVolumeComponent.h |
|
|
| StreamingMipBias | float | Bias to apply to the calculated mip level to stream at. | Components/HeterogeneousVolumeComponent.h |
|
| VolumeResolution | FIntVector | Components/HeterogeneousVolumeComponent.h |
|
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 |
|
|
void SetEndFrame
(
float NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetFrame
(
float NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetFrameRate
(
float NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetLooping
(
bool NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetPlaying
(
bool NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetStartFrame
(
float NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetStreamingMipBias
(
int32 NewValue |
Components/HeterogeneousVolumeComponent.h |
|
|
void SetVolumeResolution
(
FIntVector NewValue |
Components/HeterogeneousVolumeComponent.h |
|
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 |
Components/HeterogeneousVolumeComponent.h | ||
virtual int32 GetNumMaterials() |
Return number of material elements in this primitive | Components/HeterogeneousVolumeComponent.h | |
virtual void GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
Retrieves the materials used in this component | Components/HeterogeneousVolumeComponent.h | |
virtual bool IsMaterialSlotNameValid
(
FName MaterialSlotName |
Components/HeterogeneousVolumeComponent.h | ||
virtual void SetMaterial
(
int32 ElementIndex, |
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 |
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, |
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, |
Components/HeterogeneousVolumeComponent.h |