UMaterialBillboardComponent

A 2d material that will be rendered always facing the camera.

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/MaterialBillboardComponent.h

Include

#include "Components/MaterialBillboardComponent.h"

Syntax

class UMaterialBillboardComponent : public UPrimitiveComponent

Remarks

A 2d material that will be rendered always facing the camera.

Variables

Name Description

Public variable

TArray< FMateri...

 

Elements

Current array of material billboard elements

Constructors

Name Description

Public function

UMaterialBillboardComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddElement

(
    UMaterialInterface* Material,
    UCurveFloat* DistanceToOpacity...,
    bool bSizeIsInScreenSpace,
    float BaseSizeX,
    float BaseSizeY,
    UCurveFloat* DistanceToSizeCur...
)

Adds an element to the sprite.

Public function

void

 

SetElements

(
    const TArray< FMaterialSpriteElemen...
)

Set all elements of this material billboard component

Overridden from UPrimitiveComponent

Name Description

Public function Virtual

FPrimitiveSc...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual Const

UMaterialInt...

 

GetMaterial

(
    int32 ElementIndex
)

Returns the material used by the element at the specified index

Public function Virtual Const

void

 

GetUsedMaterials

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

Retrieves the materials used in this component

Public function Virtual

void

 

SetMaterial

(
    int32 ElementIndex,
    UMaterialInterface* Material
)

Changes the material applied to an element of the mesh.

Overridden from USceneComponent

Name Description

Public function Virtual Const

FBoxSphereBo...

 

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 UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel