1. Epic GamesDeveloper
  3. UDecalComponent

UDecalComponent

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

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

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

  Type Name Description
Public variable uint8: 1 bDestroyOwnerAfterFade Automatically destroys the owning actor after fully fading out.
Public variable FLinearColor DecalColor Decal color, can be accessed using the material Decal Color node.
Protected variable TObjectPtr< class UMaterialInterface > 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 FadeInDuration  
Public variable float FadeInStartDelay  
Public variable float FadeScreenSize  
Public variable float FadeStartDelay Time in seconds to wait before beginning to fade out the decal.
Public variable FDeferredDecalProxy * 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

  Type Name Description
Public function  

UDecalComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UMaterialInstanceDynamic * Utility to allocate a new Dynamic Material Instance, set its parent to the currently applied material, and assign it
Public function Virtual FDeferredDecalProxy *  
Public function Const UMaterialInterface * Accessor for decal material
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

  
Public function Virtual Const int32  
Public function Const FTransform  
Public function Virtual Const void

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

 Retrieves the materials used in this component
Protected function Virtual void Called when the life span of the decal has been exceeded
Public function void Pushes new selection state to the render thread primitive proxy
Public function void

SetDecalColor ( const FLinearColor& Color
)

 Sets the decal color.
Public function void

SetDecalMaterial ( UMaterialInterface* NewDecalMaterial
)

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

SetFadeIn ( float StartDelay,
float Duration
)

  
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

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

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

GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const const UObject * Give a readable name for this component, including asset name if applicable
Public function Virtual void Begins Play for the component.
Public function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Used to shut down any rendering thread structure for this component
Public 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 Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

See Also

https://docs.unrealengine.com/latest/INT/Engine/Actors/DecalActor

UDecalActor

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page