1. Epic GamesDeveloper
  3. UBillboardComponent

UBillboardComponent

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

API > API/Runtime > API/Runtime/Engine

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

   
Name UBillboardComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/BillboardComponent.h
Include Path #include "Components/BillboardComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, CollapseCategories,  
       HideCategories=(Object, Activation, "Components|Activation", Physics, Collision, Lighting, Mesh, PhysicsVolume),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UBillboardComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UBillboardComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/BillboardComponent.h  

Constants

Name Type Remarks Include Path
EditorScale float The scale we use when rendering in-editor Components/BillboardComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsScreenSizeScaled uint32   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
bShowLockedLocation bool   Components/BillboardComponent.h  
bUseInEditorScaling bool Whether to use in-editor arrow scaling (i.e. to be affected by the global arrow scale) Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
OpacityMaskRefVal float The billboard is not rendered where texture opacity < OpacityMaskRefVal Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Sprite
ScreenSize float   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
Sprite TObjectPtr< class UTexture2D >   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
SpriteInfo FSpriteCategoryInfo Sprite category information regarding the component Components/BillboardComponent.h  
U float   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
UL float   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
V float   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite
VL float   Components/BillboardComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sprite

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetOpacityMaskRefVal ( float RefVal
)

 Changed the opacity masked used by this component Components/BillboardComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|Sprite"

virtual void SetSprite ( UTexture2D* NewSprite
)

 Change the sprite texture used by this component Components/BillboardComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|Sprite"

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 Components/BillboardComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|Sprite"

virtual void SetUV ( int32 NewU,
int32 NewUL,
int32 NewV,
int32 NewVL
)

 Change the sprite's UVs Components/BillboardComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|Sprite"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual bool ComponentIsTouchingSelectionBox ( const FBox& InSelBBox,
const bool bConsiderOnlyBSP,
const bool bMustEncompassEntireComponent
) const

 Determines whether the supplied bounding box intersects with the component. Components/BillboardComponent.h  

virtual bool ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum,
const bool bConsiderOnlyBSP,
const bool bMustEncompassEntireComponent
) const

 Determines whether the supplied frustum intersects with the component. Components/BillboardComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/BillboardComponent.h  

virtual bool IsShown ( const FEngineShowFlags& ShowFlags
) const

 Would this primitive be shown with these rendering flags. Components/BillboardComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

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

Static

Name Remarks Include Path Unreal Specifiers

static void SetEditorScale ( float InEditorScale
)

 Set the scale that we use when rendering in-editor Components/BillboardComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
SpriteCategoryName_DEPRECATED FName Sprite category that the component belongs to. Value serves as a key into the localization file. Components/BillboardComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page