1. Epic GamesDeveloper
  3. ULineBatchComponent

ULineBatchComponent

The line batch component buffers and draws lines (and some other line-based shapes) in a scene.

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

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/LineBatchComponent.h
Include #include "Components/LineBatchComponent.h"

Syntax

class ULineBatchComponent : public UPrimitiveComponent

Remarks

The line batch component buffers and draws lines (and some other line-based shapes) in a scene. This can be useful for debug drawing, but is not very performant for runtime use.

Variables

  Type Name Description
Public variable TArray< FBatchedLine > BatchedLines Buffer of lines to draw
Public variable TArray< FBatchedMesh > BatchedMeshes Buffer of simple meshes to draw
Public variable TArray< FBatchedPoint > BatchedPoints Buffer or points to draw
Public variable uint32: 1 bCalculateAccurateBounds Whether to calculate a tight accurate bounds (encompassing all points), or use a giant bounds that is fast to compute.
Public variable float DefaultLifeTime Default time that lines/points will draw for

Constructors

  Type Name Description
Public function  

ULineBatchComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void

AddCircle ( const FVector& Base,
const FVector& X,
const FVector& Y,
const FLinearColor& Color,
const float Radius,
int32 NumSides,
const float LifeTime,
uint8 DepthPriority,
const float Thickness,
const uint32 BatchID
)

  
Protected function void

AddHalfCircle ( const FVector& Base,
const FVector& X,
const FVector& Y,
const FLinearColor& Color,
const float Radius,
int32 NumSides,
const float LifeTime,
uint8 DepthPriority,
const float Thickness,
const uint32 BatchID
)

  
Public function void

ClearBatch ( uint32 InBatchID
)

 Remove batched lines, points and meshes with given ID
Public function void

DrawBox ( const FVector& Center,
const FVector& Box,
const FQuat& Rotation,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a box
Public function void

DrawBox ( const FVector& Center,
const FVector& Box,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a box
Public function void

DrawBox ( const FBox& Box,
const FMatrix& TM,
FLinearColor Color,
uint8 InDepthPriorityGroup,
uint32 BatchID
)

 Draw a box
Public function void

DrawCapsule ( const FVector& Center,
float HalfHeight,
float Radius,
const FQuat& Rotation,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a cone
Public function void

DrawCircle ( const FVector& Base,
const FVector& X,
const FVector& Y,
FLinearColor Color,
float Radius,
int32 NumSides,
uint8 DepthPriority,
uint32 BatchID
)

 Draw a circle
Public function void

DrawCone ( const FVector& Origin,
const FVector& Direction,
float Length,
float AngleWidth,
float AngleHeight,
int32 NumSides,
FLinearColor DrawColor,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a cone
Public function void

DrawCylinder ( const FVector& Start,
const FVector& End,
float Radius,
int32 Segments,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a cylinder
Public function void

DrawDirectionalArrow ( const FVector& LineStart,
const FVector& LineEnd,
float ArrowSize,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw an arrow
Public function void

DrawDirectionalArrow ( const FMatrix& ArrowToWorld,
FLinearColor InColor,
float Length,
float ArrowSize,
uint8 DepthPriority,
uint32 BatchID
)

 Draw an arrow
Public function Virtual void

DrawLine ( const FVector& Start,
const FVector& End,
const FLinearColor& Color,
uint8 DepthPriority,
float Thickness,
float LifeTime,
uint32 BatchID
)

  
Public function void Provide many lines to draw - faster than calling DrawLine many times.
Public function void

DrawMesh ( TArray< FVector > const& Verts,
TArray< int32 > const& Indices,
FColor const& Color,
uint8 DepthPriority,
float LifeTime,
uint32 BatchID
)

 Draw a mesh
Public function Virtual void

DrawPoint ( const FVector& Position,
const FLinearColor& Color,
float PointSize,
uint8 DepthPriority,
float LifeTime,
uint32 BatchID
)

  
Public function void

DrawSolidBox ( FBox const& Box,
FTransform const& Xform,
const FColor& Color,
uint8 DepthPriority,
float LifeTime,
uint32 BatchID
)

 Draw a box
Public function void

DrawSphere ( const FVector& Center,
float Radius,
int32 Segments,
FLinearColor Color,
float LifeTime,
uint8 DepthPriority,
float Thickness,
uint32 BatchID
)

 Draw a sphere
Public function void

Flush ()

 Clear all batched lines, points and meshes

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a new scene proxy for the line batcher component.

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.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Constants

Name Description
INVALID_ID Defines the value for an invalid id

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page