UArrowComponent

A simple arrow rendered using lines. Useful for indicating which way an object is facing.

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Components/ArrowComponent.h"

Syntax

class UArrowComponent : public UPrimitiveComponent

Remarks

A simple arrow rendered using lines. Useful for indicating which way an object is facing.

Variables

Name Description

Public variable

FColor

 

ArrowColor

Color to draw arrow

Public variable

float

 

ArrowLength

Total length of drawn arrow including head

Public variable

float

 

ArrowSize

Relative size to scale drawn arrow by

Public variable

uint8: 1

 

bIsScreenSizeScaled

Set to limit the screen size of this arrow

Public variable

uint32: 1

 

bLightAttachment

If true, this arrow component is attached to a light actor

Public variable

uint8: 1

 

bTreatAsASprite

If true, don't show the arrow when EngineShowFlags.BillboardSprites is disabled.

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

The size on screen to limit this arrow to (in screen space)

Public variable

FSpriteCategory...

 

SpriteInfo

Sprite category information regarding the arrow component, if being treated as a sprite.

Constructors

Name Description

Public function

UArrowComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

SetArrowColor

(
    FLinearColor NewColor
)

Updates the arrow's colour, and tells it to refresh

Public function

void

 

SetArrowFColor

(
    FColor NewColor
)

Public function

void

 

SetArrowLength

(
    float NewLength
)

Public function

void

 

SetArrowSize

(
    float NewSize
)

Public function Static

void

 

SetEditorScale

(
    float InEditorScale
)

Set the scale that we use when rendering in-editor

Public function

void

 

SetIsScreenSizeScaled

(
    bool bNewValue
)

Public function

void

 

SetScreenSize

(
    float NewScreenSize
)

Public function

void

 

SetTreatAsASprite

(
    bool bNewValue
)

Public function

void

 

SetUseInEditorScaling

(
    bool bNewValue
)

Overridden from UPrimitiveComponent

Name Description

Public function Virtual Const

bool

 

ComponentIsTouchingSelectionBox

(
    const FBox& InSelBBox,
    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 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 arrow component belongs to, if being treated as a sprite.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel