1. Epic GamesDeveloper
  3. UArrowComponent

UArrowComponent

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

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/ArrowComponent.h
Include #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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FColor ArrowColor Color to draw arrow
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter float ArrowLength Total length of drawn arrow including head
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter float ArrowSize Relative size to scale drawn arrow by
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter uint8: 1 bIsScreenSizeScaled Set to limit the screen size of this arrow
Public variable UProperty uint32: 1 bLightAttachment If true, this arrow component is attached to a light actor
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter uint8: 1 bTreatAsASprite If true, don't show the arrow when EngineShowFlags.BillboardSprites is disabled.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter bool bUseInEditorScaling Whether to use in-editor arrow scaling (i.e. to be affected by the global arrow scale)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter float ScreenSize The size on screen to limit this arrow to (in screen space)
Public variable UProperty FSpriteCategoryInfo SpriteInfo Sprite category information regarding the arrow component, if being treated as a sprite.

Constructors

  Type Name Description
Public function  

UArrowComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category displayname void Updates the arrow's colour, and tells it to refresh
Public function UFunction Category blueprintsetter void

SetArrowFColor ( FColor NewColor
)

  
Public function UFunction Category blueprintsetter void

SetArrowLength ( float NewLength
)

  
Public function UFunction Category blueprintsetter void

SetArrowSize ( float NewSize
)

  
Public function Static void

SetEditorScale ( float InEditorScale
)

 Set the scale that we use when rendering in-editor
Public function UFunction Category blueprintsetter void

SetIsScreenSizeScaled ( bool bNewValue
)

  
Public function UFunction Category blueprintsetter void

SetScreenSize ( float NewScreenSize
)

  
Public function UFunction Category blueprintsetter void

SetTreatAsASprite ( bool bNewValue
)

  
Public function UFunction Category blueprintsetter void

SetUseInEditorScaling ( bool bNewValue
)

  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual Const bool

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

 Determines whether the supplied bounding box intersects with the component.
Public function Virtual Const bool

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

 Determines whether the supplied frustum intersects with the component.
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

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

  Type Name Description
Public variable UProperty FName SpriteCategoryName_DEPRECATED Sprite category that the arrow component belongs to, if being treated as a sprite.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page