UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCanvasLineItem Class Reference

#include <CanvasItem.h>

+ Inheritance diagram for FCanvasLineItem:

Public Member Functions

 FCanvasLineItem ()
 
 FCanvasLineItem (const FVector2D &InPosition, const FVector2D &InEndPos)
 
 FCanvasLineItem (const FVector &InPosition, const FVector &InEndPos)
 
virtual ENGINE_API void Draw (FCanvas *InCanvas) override
 
virtual void Draw (FCanvas *InCanvas, const FVector2D &InPosition) override
 
virtual void Draw (FCanvas *InCanvas, const FVector2D &InStartPos, const FVector2D &InEndPos)
 
virtual void Draw (FCanvas *InCanvas, float InX, float InY) override
 
virtual void Draw (FCanvas *InCanvas, const FVector &InPosition)
 
virtual void Draw (FCanvas *InCanvas, float X, float Y, float Z)
 
void SetEndPos (const FVector2D &InEndPos)
 
- Public Member Functions inherited from FCanvasItem
 FCanvasItem (const FVector2D &InPosition)
 
virtual ~FCanvasItem ()
 
virtual void SetColor (const FLinearColor &InColor)
 

Public Attributes

FVector Origin
 
FVector EndPos
 
float LineThickness
 
- Public Attributes inherited from FCanvasItem
FVector2D Position
 
uint32 StereoDepth
 
ESimpleElementBlendMode BlendMode
 
bool bFreezeTime
 
FBatchedElementParametersBatchedElementParameters
 

Additional Inherited Members

- Protected Attributes inherited from FCanvasItem
FLinearColor Color
 

Constructor & Destructor Documentation

◆ FCanvasLineItem() [1/3]

FCanvasLineItem::FCanvasLineItem ( )
inline

◆ FCanvasLineItem() [2/3]

FCanvasLineItem::FCanvasLineItem ( const FVector2D InPosition,
const FVector2D InEndPos 
)
inline

A Line.

Parameters
InPositionStart position
InEndPosEnd position

◆ FCanvasLineItem() [3/3]

FCanvasLineItem::FCanvasLineItem ( const FVector InPosition,
const FVector InEndPos 
)
inline

A Line.

Parameters
InPositionStart position
InEndPosEnd position

Member Function Documentation

◆ Draw() [1/6]

void FCanvasLineItem::Draw ( FCanvas InCanvas)
overridevirtual

Draw line at the given coordinates.

Parameters
InCanvasCanvas on which to draw

Implements FCanvasItem.

◆ Draw() [2/6]

virtual void FCanvasLineItem::Draw ( FCanvas InCanvas,
const FVector InPosition 
)
inlinevirtual

Draw line at the given coordinates.

Parameters
InCanvasCanvas on which to draw
InPositionDraw position

◆ Draw() [3/6]

virtual void FCanvasLineItem::Draw ( FCanvas InCanvas,
const FVector2D InPosition 
)
inlineoverridevirtual

Draw line at the given coordinates.

Parameters
InCanvasCanvas on which to draw
InPositionDraw Start position

Reimplemented from FCanvasItem.

◆ Draw() [4/6]

virtual void FCanvasLineItem::Draw ( FCanvas InCanvas,
const FVector2D InStartPos,
const FVector2D InEndPos 
)
inlinevirtual

Draw line using the given coordinates.

Parameters
InCanvasCanvas on which to draw
InStartPosLine start position
InEndPosLine end position

◆ Draw() [5/6]

virtual void FCanvasLineItem::Draw ( FCanvas InCanvas,
float  InX,
float  InY 
)
inlineoverridevirtual

Draw line at the given coordinates.

Parameters
InCanvasCanvas on which to draw
XX Draw position
YY Draw position

Reimplemented from FCanvasItem.

◆ Draw() [6/6]

virtual void FCanvasLineItem::Draw ( FCanvas InCanvas,
float  X,
float  Y,
float  Z 
)
inlinevirtual

Draw line at the given coordinates.

Parameters
InCanvasCanvas on which to draw
XX Draw position
YY Draw position
ZZ Draw position

◆ SetEndPos()

void FCanvasLineItem::SetEndPos ( const FVector2D InEndPos)
inline

Set the line end position.

Parameters
InEndPosEnd position of the line

Member Data Documentation

◆ EndPos

FVector FCanvasLineItem::EndPos

◆ LineThickness

float FCanvasLineItem::LineThickness

◆ Origin

FVector FCanvasLineItem::Origin

The documentation for this class was generated from the following files: