1. Epic GamesDeveloper
  3. UArrowComponent

UArrowComponent

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

API > API/Runtime > API/Runtime/Engine

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

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

Syntax

UCLASS (ClassGroup=Utility,  
       HideCategories=(Object, LOD, Physics, Lighting, TextureStreaming, Activation, "Components|Activation", Collision),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UArrowComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UArrowComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/ArrowComponent.h  

Constants

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrowColor FColor Color to draw arrow Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetArrowFColor
  • Category=ArrowComponent
ArrowLength float Total length of drawn arrow including head Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetArrowLength
  • Category=ArrowComponent
ArrowSize float Relative size to scale drawn arrow by Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetArrowSize
  • Category=ArrowComponent
bIsScreenSizeScaled uint8 Set to limit the screen size of this arrow Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetIsScreenSizeScaled
  • Category=ArrowComponent
bLightAttachment uint32 If true, this arrow component is attached to a light actor Components/ArrowComponent.h  
bTreatAsASprite uint8 If true, don't show the arrow when EngineShowFlags.BillboardSprites is disabled. Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetTreatAsASprite
  • Category=ArrowComponent
bUseInEditorScaling bool Whether to use in-editor arrow scaling (i.e. to be affected by the global arrow scale) Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetUseInEditorScaling
  • Category=ArrowComponent
ScreenSize float The size on screen to limit this arrow to (in screen space) Components/ArrowComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetScreenSize
  • Category=ArrowComponent
SpriteInfo FSpriteCategoryInfo Sprite category information regarding the arrow component, if being treated as a sprite. Components/ArrowComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void SetArrowColor ( FLinearColor NewColor
)

 Updates the arrow's colour, and tells it to refresh Components/ArrowComponent.h
  • BlueprintCallable
  • DisplayName="Set Arrow Color (Linear Color)"
  • Category="Components|Arrow"

void SetArrowFColor ( FColor NewColor
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetArrowLength ( float NewLength
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetArrowSize ( float NewSize
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetIsScreenSizeScaled ( bool bNewValue
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetScreenSize ( float NewScreenSize
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetTreatAsASprite ( bool bNewValue
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

void SetUseInEditorScaling ( bool bNewValue
)

   Components/ArrowComponent.h
  • BlueprintSetter
  • Category=ArrowComponent

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/ArrowComponent.h  

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

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

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/ArrowComponent.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/ArrowComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void SetEditorScale ( float InEditorScale
)

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

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
SpriteCategoryName_DEPRECATED FName Sprite category that the arrow component belongs to, if being treated as a sprite. Components/ArrowComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page