FCanvasLineItem

Line item.

Windows
MacOS
Linux

Inheritance Hierarchy

FCanvasItem

FCanvasLineItem

Syntax

class FCanvasLineItem : public FCanvasItem

Remarks

Line item. Note blend mode will be disregarded for these - only SE_BLEND_Opaque is currently supported.

Variables

Name Description

Public variable

FVector

 

EndPos

The end position of the line.

Public variable

float

 

LineThickness

The thickness of the line.

Public variable

FVector

 

Origin

The origin of the line.

Constructors

Name Description

Public function

FCanvasLineItem()

Public function

FCanvasLineItem

(
    const FVector2D& InPosition,
    const FVector2D& InEndPos
)

A Line.

Public function

FCanvasLineItem

(
    const FVector& InPosition,
    const FVector& InEndPos
)

A Line.

Functions

Name Description

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    const FVector& InPosition
)

Draw line at the given coordinates.

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    const FVector2D& InStartPos,
    const FVector2D& InEndPos
)

Draw line using the given coordinates.

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    float X,
    float Y,
    float Z
)

Draw line at the given coordinates.

Public function

void

 

SetEndPos

(
    const FVector2D& InEndPos
)

Set the line end position.

Overridden from FCanvasItem

Name Description

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas
)

Draw line at the given coordinates.

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    const FVector2D& InPosition
)

Draw line at the given coordinates.

Public function Virtual

void

 

Draw

(
    FCanvas* InCanvas,
    float InX,
    float InY
)

Draw line at the given coordinates.

References

Module

Engine

Header

Runtime/Engine/Public/CanvasItem.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback