UBillboardComponent

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Components/BillboardComponent.h"

Syntax

class UBillboardComponent : public UPrimitiveComponent

Remarks

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

Variables

Name Description

Public variable

uint32: 1

 

bIsScreenSizeScaled

Public variable

bool

 

bUseInEditorScaling

Whether to use in-editor arrow scaling (i.e. to be affected by the global arrow scale)

Public variable

float

 

ScreenSize

Public variable

UTexture2D *...

 

Sprite

Public variable

FSpriteCategory...

 

SpriteInfo

Sprite category information regarding the component

Public variable

float

 

U

Public variable

float

 

UL

Public variable

float

 

V

Public variable

float

 

VL

Constructors

Name Description

Public function

UBillboardComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

SetEditorScale

(
    float InEditorScale
)

Set the scale that we use when rendering in-editor

Public function Virtual

void

 

SetSprite

(
    UTexture2D* NewSprite
)

Change the sprite texture used by this component

Public function Virtual

void

 

SetSpriteAndUV

(
    UTexture2D* NewSprite,
    int32 NewU,
    int32 NewUL,
    int32 NewV,
    int32 NewVL
)

Change the sprite texture and the UV's used by this component

Public function Virtual

void

 

SetUV

(
    int32 NewU,
    int32 NewUL,
    int32 NewV,
    int32 NewVL
)

Change the sprite's UVs

Overridden from UPrimitiveComponent

Name Description

Public function Virtual Const

bool

 

ComponentIsTouchingSelectionBox

(
    const FBox& InSelBBox,
    const FEngineShowFlags& ShowFlags,
    const bool bConsiderOnlyBSP,
    const bool bMustEncompassEntireComp...
)

Determines whether the supplied bounding box intersects with the component.

Public function Virtual Const

bool

 

ComponentIsTouchingSelectionFrustum

(
    const FConvexVolume& InFrustum,
    const FEngineShowFlags& ShowFlags,
    const bool bConsiderOnlyBSP,
    const bool bMustEncompassEntireComp...
)

Determines whether the supplied frustum intersects with the component.

Public function Virtual

FPrimitiveSc...

 

CreateSceneProxy()

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

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.

Constants

Name

Description

EditorScale

The scale we use when rendering in-editor

Deprecated Variables

Name Description

Public variable

FName

 

SpriteCategoryName_DEPRECATED

Sprite category that the component belongs to. Value serves as a key into the localization file.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback