Language:
Discover
By Skill Level
By Category

UDecalComponent

Choose your OS:

Inheritance Hierarchy

Syntax

class UDecalComponent : public USceneComponent

Remarks

A material that is rendered onto the surface of a mesh. A kind of 'bumper sticker' for a model.

Variables

Name Description

Public variable

uint8 : 1

 

bDestroyOwnerAfterFade

Automatically destroys the owning actor after fully fading out.

Public variable

UMaterialInterf ...

 

DecalMaterial

Decal material.

Public variable

FVector

 

DecalSize

Decal size in local space (does not include the component scale), technically redundant but there for convenience

Public variable

float

 

FadeDuration

Time in seconds for the decal to fade out.

Public variable

float

 

FadeScreenSize

Public variable

float

 

FadeStartDelay

Time in seconds to wait before beginning to fade out the decal.

Public variable

FDeferredDecalP ...

 

SceneProxy

The decal proxy.

Public variable

int32

 

SortOrder

Controls the order in which decal elements are rendered.

Protected variable

FTimerHandle

 

TimerHandle_DestroyDecalComponent

Handle for efficient management of DestroyDecalComponent timer

Constructors

Name Description

Public function

UDecalComponent

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function Virtual

UMaterialIns ...

 

CreateDynamicMaterialInstance()

Utility to allocate a new Dynamic Material Instance, set its parent to the currently applied material, and assign it

Public function Virtual

FDeferredDec ...

 

CreateSceneProxy()

Public function

UMaterialInt ...

 

GetDecalMaterial()

Accessor for decal material

Public function

float

 

GetFadeDuration()

Public function

float

 

GetFadeStartDelay()

Public function Virtual

UMaterialInt ...

 

GetMaterial

(
    int32 ElementIndex
)

Public function Virtual

int32

 

GetNumMaterials()

Public function

FTransform

 

GetTransformIncludingDecalSize()

Public function Virtual

void

 

GetUsedMaterials

(
    TArray < UMaterialInterface * > ...,
    bool bGetDebugMaterials
)

Retrieves the materials used in this component

Protected function

void

 

LifeSpanCallback()

Called when the life span of the decal has been exceeded

Public function

void

 

PushSelectionToProxy()

Pushes new selection state to the render thread primitive proxy

Public function

void

 

SetDecalMaterial

(
    UMaterialInterface * NewDecalMa...
)

Setting decal material on decal component. This will force the decal to reattach

Public function

void

 

SetFadeOut

(
    float StartDelay,
    float Duration,
    bool DestroyOwnerAfterFade
)

Sets the decal's fade start time, duration and if the owning actor should be destroyed after the decal is fully faded out.

Public function

void

 

SetFadeScreenSize

(
    float NewFadeScreenSize
)

Set the FadeScreenSize for this decal component

Public function

void

 

SetLifeSpan

(
    const float LifeSpan
)

Public function Virtual

void

 

SetMaterial

(
    int32 ElementIndex,
    UMaterialInterface * InMaterial
)

Public function

void

 

SetSortOrder

(
    int32 Value
)

Sets the sort order for the decal component.

Overridden from USceneComponent

Name Description

Public function Virtual

FBoxSphereBo ...

 

CalcBounds

(
    const FTransform & LocalToWorld
)

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

Overridden from UActorComponent

Name Description

Public function Virtual

const UObjec ...

 

AdditionalStatObject()

Give a readable name for this component, including asset name if applicable

Public function Virtual

void

 

BeginPlay()

BeginsPlay for the component.

Public function Virtual

void

 

CreateRenderState_Concurrent()

Used to create any rendering thread information for this component

Public function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Public function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

UObject serializer.

See Also

References

Module

Engine

Header

Runtime/Engine/Classes/Components/DecalComponent.h