PrimitiveDrawingUtils.cpp File Reference

#include "PrimitiveDrawingUtils.h"
#include "Math/RandomStream.h"
#include "MaterialShared.h"
#include "Materials/Material.h"
#include "Materials/MaterialRenderProxy.h"
#include "CanvasItem.h"
#include "CanvasTypes.h"
#include "Rendering/SkeletalMeshLODRenderData.h"
#include "SceneView.h"
#include "UnrealEngine.h"
#include "DynamicMeshBuilder.h"
#include "PrimitiveSceneProxy.h"
#include "Engine/LightMapTexture2D.h"
#include "SceneInterface.h"
#include "UnrealClient.h"
#include "Materials/MaterialInstance.h"
#include "Materials/MaterialInstanceDynamic.h"

Functions
void	DrawPlane10x10 (class FPrimitiveDrawInterface *PDI, const FMatrix &ObjectToWorld, float Radii, FVector2D UVMin, FVector2D UVMax, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriorityGroup)
void	DrawTriangle (class FPrimitiveDrawInterface *PDI, const FVector &A, const FVector &B, const FVector &C, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriorityGroup)
void	GetBoxMesh (const FMatrix &BoxToWorld, const FVector &Radii, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriorityGroup, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	DrawBox (FPrimitiveDrawInterface *PDI, const FMatrix &BoxToWorld, const FVector &Radii, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriorityGroup)
void	GetOrientedHalfSphereMesh (const FVector &Center, const FRotator &Orientation, const FVector &Radii, int32 NumSides, int32 NumRings, float StartAngle, float EndAngle, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling, int32 ViewIndex, FMeshElementCollector &Collector, bool bUseSelectionOutline, HHitProxy *HitProxy)
void	GetHalfSphereMesh (const FVector &Center, const FVector &Radii, int32 NumSides, int32 NumRings, float StartAngle, float EndAngle, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling, int32 ViewIndex, FMeshElementCollector &Collector, bool bUseSelectionOutline, HHitProxy *HitProxy)
void	GetSphereMesh (const FVector &Center, const FVector &Radii, int32 NumSides, int32 NumRings, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling, int32 ViewIndex, FMeshElementCollector &Collector)
ENGINE_API void	GetSphereMesh (const FVector &Center, const FVector &Radii, int32 NumSides, int32 NumRings, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling, int32 ViewIndex, FMeshElementCollector &Collector, bool bUseSelectionOutline, HHitProxy *HitProxy)
void	DrawSphere (FPrimitiveDrawInterface *PDI, const FVector &Center, const FRotator &Orientation, const FVector &Radii, int32 NumSides, int32 NumRings, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling)
FVector	CalcConeVert (float Angle1, float Angle2, float AzimuthAngle)
void	BuildConeVerts (float Angle1, float Angle2, float Scale, float XOffset, uint32 NumSides, TArray< FDynamicMeshVertex > &OutVerts, TArray< uint32 > &OutIndices)
void	DrawCone (FPrimitiveDrawInterface *PDI, const FMatrix &ConeToWorld, float Angle1, float Angle2, uint32 NumSides, bool bDrawSideLines, const FLinearColor &SideLineColor, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority)
void	BuildDiscVerts (const FVector &Center, const FVector &XAxis, const FVector &YAxis, double Radius, uint32 Sides, TArray< FDynamicMeshVertex > &OutVerts, TArray< uint32 > &OutIndices)
void	GetDiscMesh (const FVector &Center, const FVector &XAxis, const FVector &YAxis, double Radius, int32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	GetDiscMesh (const FMatrix &ToWorld, const FVector &Center, const FVector &XAxis, const FVector &YAxis, double Radius, int32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	BuildCylinderVerts (const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double Radius, double HalfHeight, uint32 Sides, TArray< FDynamicMeshVertex > &OutVerts, TArray< uint32 > &OutIndices)
void	BuildTaperedCylinderVerts (const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double BaseRadius, double TopRadius, double HalfHeight, uint32 Sides, TArray< FDynamicMeshVertex > &OutVerts, TArray< uint32 > &OutIndices)
void	GetCylinderMesh (const FVector &Start, const FVector &End, double Radius, int32 Sides, const FMaterialRenderProxy *MaterialInstance, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	GetCylinderMesh (const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double Radius, double HalfHeight, int32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	GetCylinderMesh (const FMatrix &CylToWorld, const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double Radius, double HalfHeight, uint32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	GetConeMesh (const FMatrix &LocalToWorld, float AngleWidth, float AngleHeight, uint32 NumSides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	GetCapsuleMesh (const FVector &Origin, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, const FLinearColor &Color, double Radius, double HalfHeight, int32 NumSides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bDisableBackfaceCulling, int32 ViewIndex, FMeshElementCollector &Collector, HHitProxy *HitProxy)
void	DrawCylinder (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double Radius, double HalfHeight, uint32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority)
void	DrawCylinder (FPrimitiveDrawInterface *PDI, const FMatrix &CylToWorld, const FVector &Base, const FVector &XAxis, const FVector &YAxis, const FVector &ZAxis, double Radius, double HalfHeight, uint32 Sides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority)
void	DrawCylinder (class FPrimitiveDrawInterface *PDI, const FVector &Start, const FVector &End, double Radius, int32 Sides, const FMaterialRenderProxy *MaterialInstance, uint8 DepthPriority)
void	DrawTorus (FPrimitiveDrawInterface *PDI, const FMatrix &Transform, const FVector &XAxis, const FVector &YAxis, double OuterRadius, double InnerRadius, int32 OuterSegments, int32 InnerSegments, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bPartial, float Angle, bool bEndCaps)
void	DrawTorus (FPrimitiveDrawInterface *PDI, const FMatrix &Transform, const FVector &XAxis, const FVector &YAxis, FColor Color, double OuterRadius, double InnerRadius, int32 OuterSegments, int32 InnerSegments, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, bool bPartial, float Angle, bool bEndCaps)
void	DrawDisc (class FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &XAxis, const FVector &YAxis, FColor Color, double Radius, int32 NumSides, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority)
void	DrawFlatArrow (class FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &XAxis, const FVector &YAxis, FColor Color, float Length, int32 Width, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority, float Thickness)
void	DrawWireBox (FPrimitiveDrawInterface *PDI, const FBox &Box, const FLinearColor &Color, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireBox (FPrimitiveDrawInterface *PDI, const FMatrix &Matrix, const FBox &Box, const FLinearColor &Color, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawCircle (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &X, const FVector &Y, const FLinearColor &Color, double Radius, int32 NumSides, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawArc (FPrimitiveDrawInterface *PDI, const FVector Base, const FVector X, const FVector Y, const float MinAngle, const float MaxAngle, const double Radius, const int32 Sections, const FLinearColor &Color, uint8 DepthPriority)
void	DrawRectangleMesh (FPrimitiveDrawInterface *PDI, const FVector &Center, const FVector &XAxis, const FVector &YAxis, FColor Color, float Width, float Height, const FMaterialRenderProxy *MaterialRenderProxy, uint8 DepthPriority)
void	DrawRectangle (class FPrimitiveDrawInterface *PDI, const FVector &Center, const FVector &XAxis, const FVector &YAxis, FColor Color, float Width, float Height, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireSphere (class FPrimitiveDrawInterface *PDI, const FVector &Base, const FLinearColor &Color, double Radius, int32 NumSides, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireSphereAutoSides (class FPrimitiveDrawInterface *PDI, const FVector &Base, const FLinearColor &Color, double Radius, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireSphere (class FPrimitiveDrawInterface *PDI, const FTransform &Transform, const FLinearColor &Color, double Radius, int32 NumSides, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireSphereAutoSides (class FPrimitiveDrawInterface *PDI, const FTransform &Transform, const FLinearColor &Color, double Radius, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireCylinder (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &X, const FVector &Y, const FVector &Z, const FLinearColor &Color, double Radius, double HalfHeight, int32 NumSides, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireCapsule (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &X, const FVector &Y, const FVector &Z, const FLinearColor &Color, double Radius, double HalfHeight, int32 NumSides, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireCone (FPrimitiveDrawInterface *PDI, TArray< FVector > &Verts, const FTransform &Transform, double ConeLength, double ConeAngle, int32 ConeSides, const FLinearColor &Color, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireCone (FPrimitiveDrawInterface *PDI, TArray< FVector > &Verts, const FMatrix &Transform, double ConeLength, double ConeAngle, int32 ConeSides, const FLinearColor &Color, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawWireSphereCappedCone (FPrimitiveDrawInterface *PDI, const FTransform &Transform, double ConeLength, double ConeAngle, int32 ConeSides, int32 ArcFrequency, int32 CapSegments, const FLinearColor &Color, uint8 DepthPriority)
void	DrawWireChoppedCone (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &X, const FVector &Y, const FVector &Z, const FLinearColor &Color, double Radius, double TopRadius, double HalfHeight, int32 NumSides, uint8 DepthPriority)
void	DrawOrientedWireBox (FPrimitiveDrawInterface *PDI, const FVector &Base, const FVector &X, const FVector &Y, const FVector &Z, FVector Extent, const FLinearColor &Color, uint8 DepthPriority, float Thickness, float DepthBias, bool bScreenSpace)
void	DrawCoordinateSystem (FPrimitiveDrawInterface *PDI, FVector const &AxisLoc, FRotator const &AxisRot, float Scale, uint8 DepthPriority, float Thickness)
void	DrawCoordinateSystem (FPrimitiveDrawInterface *PDI, FVector const &AxisLoc, FRotator const &AxisRot, float Scale, const FLinearColor &InColor, uint8 DepthPriority, float Thickness)
void	DrawDirectionalArrow (FPrimitiveDrawInterface *PDI, const FMatrix &ArrowToWorld, const FLinearColor &InColor, float Length, float ArrowSize, uint8 DepthPriority, float Thickness)
void	DrawConnectedArrow (class FPrimitiveDrawInterface *PDI, const FMatrix &ArrowToWorld, const FLinearColor &Color, float ArrowHeight, float ArrowWidth, uint8 DepthPriority, float Thickness, int32 NumSpokes)
void	DrawWireStar (FPrimitiveDrawInterface *PDI, const FVector &Position, float Size, const FLinearColor &Color, uint8 DepthPriority)
void	DrawDashedLine (FPrimitiveDrawInterface *PDI, const FVector &Start, const FVector &End, const FLinearColor &Color, double DashSize, uint8 DepthPriority, float DepthBias)
void	DrawWireDiamond (FPrimitiveDrawInterface *PDI, const FMatrix &DiamondMatrix, float Size, const FLinearColor &InColor, uint8 DepthPriority, float Thickness)
FLinearColor	GetSelectionColor (const FLinearColor &BaseColor, bool bSelected, bool bHovered, bool bUseOverlayIntensity)
FLinearColor	GetViewSelectionColor (const FLinearColor &BaseColor, const FSceneView &View, bool bSelected, bool bHovered, bool bUseOverlayIntensity, bool bIndividuallySelected)
bool	IsRichView (const FSceneViewFamily &ViewFamily)
void	ApplyViewModeOverrides (int32 ViewIndex, const FEngineShowFlags &EngineShowFlags, ERHIFeatureLevel::Type FeatureLevel, const FPrimitiveSceneProxy *PrimitiveSceneProxy, bool bSelected, FMeshBatch &Mesh, FMeshElementCollector &Collector)
bool	IsUVOutOfBounds (FVector2D UV)
template<class VertexBufferType , class IndexBufferType >
void	DrawUVsInternal (FViewport *InViewport, FCanvas *InCanvas, int32 InTextYPos, const int32 LODLevel, int32 UVChannel, TArray< FVector2D > SelectedEdgeTexCoords, VertexBufferType &VertexBuffer, IndexBufferType &Indices)
void	DrawUVs (FViewport *InViewport, FCanvas *InCanvas, int32 InTextYPos, const int32 LODLevel, int32 UVChannel, TArray< FVector2D > SelectedEdgeTexCoords, FStaticMeshRenderData *StaticMeshRenderData, FSkeletalMeshLODRenderData *SkeletalMeshRenderData)

Function Documentation

ApplyViewModeOverrides()

void ApplyViewModeOverrides	(	int32	ViewIndex,
		const FEngineShowFlags &	EngineShowFlags,
		ERHIFeatureLevel::Type	FeatureLevel,
		const FPrimitiveSceneProxy *	PrimitiveSceneProxy,
		bool	bSelected,
		FMeshBatch &	Mesh,
		FMeshElementCollector &	Collector
	)

BuildConeVerts()

void BuildConeVerts	(	float	Angle1,
		float	Angle2,
		float	Scale,
		float	XOffset,
		uint32	NumSides,
		TArray< FDynamicMeshVertex > &	OutVerts,
		TArray< uint32 > &	OutIndices
	)

BuildCylinderVerts()

void BuildCylinderVerts	(	const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	Radius,
		double	HalfHeight,
		uint32	Sides,
		TArray< FDynamicMeshVertex > &	OutVerts,
		TArray< uint32 > &	OutIndices
	)

BuildDiscVerts()

void BuildDiscVerts	(	const FVector &	Center,
		const FVector &	XAxis,
		const FVector &	YAxis,
		double	Radius,
		uint32	Sides,
		TArray< FDynamicMeshVertex > &	OutVerts,
		TArray< uint32 > &	OutIndices
	)

BuildTaperedCylinderVerts()

void BuildTaperedCylinderVerts	(	const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	BaseRadius,
		double	TopRadius,
		double	HalfHeight,
		uint32	Sides,
		TArray< FDynamicMeshVertex > &	OutVerts,
		TArray< uint32 > &	OutIndices
	)

Build tapered cylinder vertices with a separate base and top radius.

CalcConeVert()

FVector CalcConeVert	(	float	Angle1,
		float	Angle2,
		float	AzimuthAngle
	)

DrawArc()

void DrawArc	(	FPrimitiveDrawInterface *	PDI,
		const FVector	Base,
		const FVector	X,
		const FVector	Y,
		const float	MinAngle,
		const float	MaxAngle,
		const double	Radius,
		const int32	Sections,
		const FLinearColor &	Color,
		uint8	DepthPriority
	)

Draws an arc using lines.

Parameters

PDI	Draw interface.
Base	Center of the circle.
X	Normalized axis from one point to the center
Y	Normalized axis from other point to the center
MinAngle	The minimum angle
MaxAngle	The maximum angle
Radius	Radius of the arc
Sections	Numbers of sides that the circle has.
Color	Color of the circle.
DepthPriority	Depth priority for the circle.

DrawBox()

void DrawBox	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	BoxToWorld,
		const FVector &	Radii,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriorityGroup
	)

DrawCircle()

void DrawCircle	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	X,
		const FVector &	Y,
		const FLinearColor &	Color,
		double	Radius,
		int32	NumSides,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a wireframe circle.

Parameters

PDI	Draw interface.
Center	Center of the circle.
X	X alignment axis to draw along.
Y	Y alignment axis to draw along.
Color	Color of the cylinder.
Radius	Radius of the cylinder.
NumSides	Numbers of sides that the cylinder has.
DepthPriority	Depth priority for the cylinder.
Thickness	Thickness of the lines comprising the circle

DrawCone()

void DrawCone	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	ConeToWorld,
		float	Angle1,
		float	Angle2,
		uint32	NumSides,
		bool	bDrawSideLines,
		const FLinearColor &	SideLineColor,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority
	)

DrawConnectedArrow()

void DrawConnectedArrow	(	class FPrimitiveDrawInterface *	PDI,
		const FMatrix &	ArrowToWorld,
		const FLinearColor &	Color,
		float	ArrowHeight,
		float	ArrowWidth,
		uint8	DepthPriority,
		float	Thickness = 0.5f,
		int32	NumSpokes = 6
	)

Draws a directional arrow with connected spokes.

Parameters

PDI	Draw interface.
ArrowToWorld	Transform matrix for the arrow.
Color	Color of the arrow.
ArrowHeight	Height of the the arrow head.
ArrowWidth	Width of the arrow head.
DepthPriority	Depth priority for the arrow.
Thickness	Thickness of the lines used to draw the arrow.
NumSpokes	Number of spokes used to make the arrow head.

DrawCoordinateSystem() [1/2]

void DrawCoordinateSystem	(	FPrimitiveDrawInterface *	PDI,
		FVector const &	AxisLoc,
		FRotator const &	AxisRot,
		float	Scale,
		const FLinearColor &	InColor,
		uint8	DepthPriority,
		float	Thickness = 0.0f
	)

Draws a coordinate system with a fixed color.

Parameters

PDI	Draw interface.
AxisLoc	Location of the coordinate system.
AxisRot	Location of the coordinate system.
Scale	Scale for the axis lines.
InColor	Color of the axis lines.
DepthPriority	Depth priority coordinate system.
Thickness	How thick to draw the axis lines

DrawCoordinateSystem() [2/2]

void DrawCoordinateSystem	(	FPrimitiveDrawInterface *	PDI,
		FVector const &	AxisLoc,
		FRotator const &	AxisRot,
		float	Scale,
		uint8	DepthPriority,
		float	Thickness = 0.0f
	)

Draws a coordinate system (Red for X axis, Green for Y axis, Blue for Z axis).

Parameters

PDI	Draw interface.
AxisLoc	Location of the coordinate system.
AxisRot	Location of the coordinate system.
Scale	Scale for the axis lines.
DepthPriority	Depth priority coordinate system.
Thickness	How thick to draw the axis lines

DrawCylinder() [1/3]

void DrawCylinder	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Start,
		const FVector &	End,
		double	Radius,
		int32	Sides,
		const FMaterialRenderProxy *	MaterialInstance,
		uint8	DepthPriority
	)

DrawCylinder() [2/3]

void DrawCylinder	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	CylToWorld,
		const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	Radius,
		double	HalfHeight,
		uint32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority
	)

DrawCylinder() [3/3]

void DrawCylinder	(	FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	Radius,
		double	HalfHeight,
		uint32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority
	)

DrawDashedLine()

void DrawDashedLine	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Start,
		const FVector &	End,
		const FLinearColor &	Color,
		double	DashSize,
		uint8	DepthPriority,
		float	DepthBias = 0.0f
	)

Draws a dashed line.

Parameters

PDI	Draw interface.
Start	Start position of the line.
End	End position of the line.
Color	Color of the arrow.
DashSize	Size of each of the dashes that makes up the line.
DepthPriority	Depth priority for the line.

DrawDirectionalArrow()

void DrawDirectionalArrow	(	class FPrimitiveDrawInterface *	PDI,
		const FMatrix &	ArrowToWorld,
		const FLinearColor &	InColor,
		float	Length,
		float	ArrowSize,
		uint8	DepthPriority,
		float	Thickness = 0.0f
	)

Draws a directional arrow (starting at ArrowToWorld.Origin and continuing for Length units in the X direction of ArrowToWorld).

Parameters

PDI	Draw interface.
ArrowToWorld	Transform matrix for the arrow.
InColor	Color of the arrow.
Length	Length of the arrow
ArrowSize	Size of the arrow head.
DepthPriority	Depth priority for the arrow.
Thickness	Thickness of the lines comprising the arrow

DrawDisc()

void DrawDisc	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		FColor	Color,
		double	Radius,
		int32	NumSides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority
	)

Draws a circle using triangles.

Parameters

PDI	Draw interface.
Base	Center of the circle.
XAxis	X alignment axis to draw along.
YAxis	Y alignment axis to draw along.
Color	Color of the circle.
Radius	Radius of the circle.
NumSides	Numbers of sides that the circle has.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the circle.

DrawFlatArrow()

void DrawFlatArrow	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		FColor	Color,
		float	Length,
		int32	Width,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		float	Thickness = 0.0f
	)

Draws a flat arrow with an outline.

Parameters

PDI	Draw interface.
Base	Base of the arrow.
XAxis	X alignment axis to draw along.
YAxis	Y alignment axis to draw along.
Color	Color of the circle.
Length	Length of the arrow, from base to tip.
Width	Width of the base of the arrow, head of the arrow will be 2x.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the circle.
Thickness	Thickness of the lines comprising the arrow

DrawOrientedWireBox()

void DrawOrientedWireBox	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	X,
		const FVector &	Y,
		const FVector &	Z,
		FVector	Extent,
		const FLinearColor &	Color,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws an oriented box.

Parameters

PDI	Draw interface.
Base	Center point of the box.
X	X alignment axis to draw along.
Y	Y alignment axis to draw along.
Z	Z alignment axis to draw along.
Color	Color of the box.
Extent	Vector with the half-sizes of the box.
DepthPriority	Depth priority for the cone.
Thickness	Thickness of the lines comprising the box

DrawPlane10x10()

void DrawPlane10x10	(	class FPrimitiveDrawInterface *	PDI,
		const FMatrix &	ObjectToWorld,
		float	Radii,
		FVector2D	UVMin,
		FVector2D	UVMax,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriorityGroup
	)

DrawRectangle()

void DrawRectangle	(	FPrimitiveDrawInterface *	PDI,
		const FVector &	Center,
		const FVector &	XAxis,
		const FVector &	YAxis,
		FColor	Color,
		float	Width,
		float	Height,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a rectangle using lines.

Parameters

PDI	Draw interface.
Center	Center of the rectangle.
XAxis	Normalized X alignment axis.
YAxis	Normalized Y alignment axis.
Color	Color of the circle.
Width	Width of rectangle along the X dimension.
Height	Height of rectangle along the Y dimension.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the rectangle.
Thickness	Thickness of the lines comprising the rectangle.

DrawRectangleMesh()

void DrawRectangleMesh	(	FPrimitiveDrawInterface *	PDI,
		const FVector &	Center,
		const FVector &	XAxis,
		const FVector &	YAxis,
		FColor	Color,
		float	Width,
		float	Height,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority
	)

Draws a rectangle using triangles.

Parameters

PDI	Draw interface.
Center	Center of the rectangle.
XAxis	Normalized X alignment axis.
YAxis	Normalized Y alignment axis.
Color	Color of the circle.
Width	Width of rectangle along the X dimension.
Height	Height of rectangle along the Y dimension.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the rectangle.

DrawSphere()

void DrawSphere	(	FPrimitiveDrawInterface *	PDI,
		const FVector &	Center,
		const FRotator &	Orientation,
		const FVector &	Radii,
		int32	NumSides,
		int32	NumRings,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bDisableBackfaceCulling
	)

DrawTorus() [1/2]

void DrawTorus	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	Transform,
		const FVector &	XAxis,
		const FVector &	YAxis,
		double	OuterRadius,
		double	InnerRadius,
		int32	OuterSegments,
		int32	InnerSegments,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bPartial,
		float	Angle,
		bool	bEndCaps
	)

Draws a torus using triangles.

Parameters

PDI	Draw interface.
Transform	Generic transform to apply (ex. a local-to-world transform).
XAxis	Normalized X alignment axis.
YAxis	Normalized Y alignment axis.
OuterRadius	Radius of the torus center-line. Viewed from above, the outside of the torus has a radius of OuterRadius + InnerRadius and the hole of the torus has a radius of OuterRadius - InnerRadius.
InnerRadius	Radius of the torus's cylinder.
OuterSegments	Numbers of segment divisions for outer circle.
InnerSegments	Numbers of segment divisions for inner circle.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the circle.
bPartial	Whether full or partial torus should be rendered.
Angle	If partial, angle in radians of the arc clockwise beginning at the XAxis.
bEndCaps	If partial, whether the ends should be capped with triangles.

DrawTorus() [2/2]

void DrawTorus	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	Transform,
		const FVector &	XAxis,
		const FVector &	YAxis,
		FColor	Color,
		double	OuterRadius,
		double	InnerRadius,
		int32	OuterSegments,
		int32	InnerSegments,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bPartial,
		float	Angle,
		bool	bEndCaps
	)

Draws a torus using triangles.

Parameters

PDI	Draw interface.
Transform	Generic transform to apply (ex. a local-to-world transform).
XAxis	Normalized X alignment axis.
YAxis	Normalized Y alignment axis.
Color	Color of the circle.
OuterRadius	Radius of the torus center-line. Viewed from above, the outside of the torus has a radius of OuterRadius + InnerRadius and the hole of the torus has a radius of OuterRadius - InnerRadius.
InnerRadius	Radius of the torus's cylinder.
OuterSegments	Numbers of segment divisions for outer circle.
InnerSegments	Numbers of segment divisions for inner circle.
MaterialRenderProxy	Material to use for render
DepthPriority	Depth priority for the circle.
bPartial	Whether full or partial torus should be rendered.
Angle	If partial, angle in radians of the arc clockwise beginning at the XAxis.
bEndCaps	If partial, whether the ends should be capped with triangles.

DrawTriangle()

void DrawTriangle	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	A,
		const FVector &	B,
		const FVector &	C,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriorityGroup
	)

DrawUVs()

void DrawUVs	(	FViewport *	InViewport,
		FCanvas *	InCanvas,
		int32	InTextYPos,
		const int32	LODLevel,
		int32	UVChannel,
		TArray< FVector2D >	SelectedEdgeTexCoords,
		class FStaticMeshRenderData *	StaticMeshRenderData,
		class FSkeletalMeshLODRenderData *	SkeletalMeshRenderData
	)

Draws the UV layout of the supplied asset (either StaticMeshRenderData OR SkeletalMeshRenderData, not both!)

DrawUVsInternal()

template<class VertexBufferType , class IndexBufferType >

void DrawUVsInternal	(	FViewport *	InViewport,
		FCanvas *	InCanvas,
		int32	InTextYPos,
		const int32	LODLevel,
		int32	UVChannel,
		TArray< FVector2D >	SelectedEdgeTexCoords,
		VertexBufferType &	VertexBuffer,
		IndexBufferType &	Indices
	)

DrawWireBox() [1/2]

void DrawWireBox	(	class FPrimitiveDrawInterface *	PDI,
		const FBox &	Box,
		const FLinearColor &	Color,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a wireframe box.

Parameters

PDI	Draw interface.
Box	The FBox to use for drawing.
Color	Color of the box.
DepthPriority	Depth priority for the circle.
Thickness	Thickness of the lines comprising the box

DrawWireBox() [2/2]

void DrawWireBox	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	Matrix,
		const FBox &	Box,
		const FLinearColor &	Color,
		uint8	DepthPriority,
		float	Thickness,
		float	DepthBias,
		bool	bScreenSpace
	)

DrawWireCapsule()

void DrawWireCapsule	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	X,
		const FVector &	Y,
		const FVector &	Z,
		const FLinearColor &	Color,
		double	Radius,
		double	HalfHeight,
		int32	NumSides,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a wireframe capsule.

Parameters

PDI	Draw interface.
Base	Center pointer of the base of the cylinder.
X	X alignment axis to draw along.
Y	Y alignment axis to draw along.
Z	Z alignment axis to draw along.
Color	Color of the cylinder.
Radius	Radius of the cylinder.
HalfHeight	Half of the height of the cylinder.
NumSides	Numbers of sides that the cylinder has.
DepthPriority	Depth priority for the cylinder.
Thickness	Thickness of the lines comprising the cylinder

DrawWireChoppedCone()

void DrawWireChoppedCone	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	X,
		const FVector &	Y,
		const FVector &	Z,
		const FLinearColor &	Color,
		double	Radius,
		double	TopRadius,
		double	HalfHeight,
		int32	NumSides,
		uint8	DepthPriority
	)

Draws a wireframe chopped cone (cylinder with independent top and bottom radius).

Parameters

PDI	Draw interface.
Base	Center pointer of the base of the cone.
X	X alignment axis to draw along.
Y	Y alignment axis to draw along.
Z	Z alignment axis to draw along.
Color	Color of the cone.
Radius	Radius of the cone at the bottom.
TopRadius	Radius of the cone at the top.
HalfHeight	Half of the height of the cone.
NumSides	Numbers of sides that the cone has.
DepthPriority	Depth priority for the cone.

DrawWireCone() [1/2]

void DrawWireCone	(	class FPrimitiveDrawInterface *	PDI,
		TArray< FVector > &	Verts,
		const FMatrix &	Transform,
		double	ConeLength,
		double	ConeAngle,
		int32	ConeSides,
		const FLinearColor &	Color,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a wireframe cone

Parameters

PDI	Draw interface.
Transform	Generic transform to apply (ex. a local-to-world transform).
ConeLength	Pre-transform distance from apex to the perimeter of the cone base. The Radius of the base is ConeLength * sin(ConeAngle).
ConeAngle	Angle of the cone in degrees. This is 1/2 the cone aperture.
ConeSides	Numbers of sides that the cone has.
Color	Color of the cone.
DepthPriority	Depth priority for the cone.
Verts	Out param, the positions of the verts at the cone base.
Thickness	Thickness of the lines comprising the cone

DrawWireCone() [2/2]

void DrawWireCone	(	FPrimitiveDrawInterface *	PDI,
		TArray< FVector > &	Verts,
		const FTransform &	Transform,
		double	ConeLength,
		double	ConeAngle,
		int32	ConeSides,
		const FLinearColor &	Color,
		uint8	DepthPriority,
		float	Thickness,
		float	DepthBias,
		bool	bScreenSpace
	)

DrawWireCylinder()

void DrawWireCylinder	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FVector &	X,
		const FVector &	Y,
		const FVector &	Z,
		const FLinearColor &	Color,
		double	Radius,
		double	HalfHeight,
		int32	NumSides,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a wireframe cylinder.

Parameters

PDI	Draw interface.
Base	Center pointer of the base of the cylinder.
X	X alignment axis to draw along.
Y	Y alignment axis to draw along.
Z	Z alignment axis to draw along.
Color	Color of the cylinder.
Radius	Radius of the cylinder.
HalfHeight	Half of the height of the cylinder.
NumSides	Numbers of sides that the cylinder has.
DepthPriority	Depth priority for the cylinder.
Thickness	Thickness of the lines comprising the cylinder

DrawWireDiamond()

void DrawWireDiamond	(	class FPrimitiveDrawInterface *	PDI,
		const FMatrix &	DiamondMatrix,
		float	Size,
		const FLinearColor &	InColor,
		uint8	DepthPriority,
		float	Thickness = 0.0f
	)

Draws a wireframe diamond.

Parameters

PDI	Draw interface.
DiamondMatrix	Transform Matrix for the diamond.
Size	Size of the diamond.
InColor	Color of the diamond.
DepthPriority	Depth priority for the diamond.
Thickness	How thick to draw diamond lines

DrawWireSphere() [1/2]

void DrawWireSphere	(	class FPrimitiveDrawInterface *	PDI,
		const FTransform &	Transform,
		const FLinearColor &	Color,
		double	Radius,
		int32	NumSides,
		uint8	DepthPriority,
		float	Thickness,
		float	DepthBias,
		bool	bScreenSpace
	)

DrawWireSphere() [2/2]

void DrawWireSphere	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FLinearColor &	Color,
		double	Radius,
		int32	NumSides,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a sphere using circles.

Parameters

PDI	Draw interface.
Base	Center of the sphere.
Color	Color of the sphere.
Radius	Radius of the sphere.
NumSides	Numbers of sides that the circle has.
DepthPriority	Depth priority for the circle.
Thickness	Thickness of the lines comprising the sphere

DrawWireSphereAutoSides() [1/2]

void DrawWireSphereAutoSides	(	class FPrimitiveDrawInterface *	PDI,
		const FTransform &	Transform,
		const FLinearColor &	Color,
		double	Radius,
		uint8	DepthPriority,
		float	Thickness,
		float	DepthBias,
		bool	bScreenSpace
	)

DrawWireSphereAutoSides() [2/2]

void DrawWireSphereAutoSides	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Base,
		const FLinearColor &	Color,
		double	Radius,
		uint8	DepthPriority,
		float	Thickness = 0.0f,
		float	DepthBias = 0.0f,
		bool	bScreenSpace = false
	)

Draws a sphere using circles, automatically calculating a reasonable number of sides

Parameters

PDI	Draw interface.
Base	Center of the sphere.
Color	Color of the sphere.
Radius	Radius of the sphere.
DepthPriority	Depth priority for the circle.
Thickness	Thickness of the lines comprising the sphere

DrawWireSphereCappedCone()

void DrawWireSphereCappedCone	(	FPrimitiveDrawInterface *	PDI,
		const FTransform &	Transform,
		double	ConeLength,
		double	ConeAngle,
		int32	ConeSides,
		int32	ArcFrequency,
		int32	CapSegments,
		const FLinearColor &	Color,
		uint8	DepthPriority
	)

Draws a wireframe cone with a arcs on the cap

Parameters

PDI	Draw interface.
Transform	Generic transform to apply (ex. a local-to-world transform).
ConeLength	Pre-transform distance from apex to the perimeter of the cone base. The Radius of the base is ConeLength * sin(ConeAngle).
ConeAngle	Angle of the cone in degrees. This is 1/2 the cone aperture.
ConeSides	Numbers of sides that the cone has.
ArcFrequency	How frequently to draw an arc (1 means every vertex, 2 every 2nd etc.)
CapSegments	How many lines to use to make the arc
Color	Color of the cone.
DepthPriority	Depth priority for the cone.

DrawWireStar()

void DrawWireStar	(	class FPrimitiveDrawInterface *	PDI,
		const FVector &	Position,
		float	Size,
		const FLinearColor &	Color,
		uint8	DepthPriority
	)

Draws a axis-aligned 3 line star.

Parameters

PDI	Draw interface.
Position	Position of the star.
Size	Size of the star
InColor	Color of the arrow.
DepthPriority	Depth priority for the star.

GetBoxMesh()

void GetBoxMesh	(	const FMatrix &	BoxToWorld,
		const FVector &	Radii,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriorityGroup,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetCapsuleMesh()

void GetCapsuleMesh	(	const FVector &	Origin,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		const FLinearColor &	Color,
		double	Radius,
		double	HalfHeight,
		int32	NumSides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bDisableBackfaceCulling,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetConeMesh()

void GetConeMesh	(	const FMatrix &	LocalToWorld,
		float	AngleWidth,
		float	AngleHeight,
		uint32	NumSides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetCylinderMesh() [1/3]

void GetCylinderMesh	(	const FMatrix &	CylToWorld,
		const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	Radius,
		double	HalfHeight,
		uint32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetCylinderMesh() [2/3]

void GetCylinderMesh	(	const FVector &	Base,
		const FVector &	XAxis,
		const FVector &	YAxis,
		const FVector &	ZAxis,
		double	Radius,
		double	HalfHeight,
		int32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetCylinderMesh() [3/3]

void GetCylinderMesh	(	const FVector &	Start,
		const FVector &	End,
		double	Radius,
		int32	Sides,
		const FMaterialRenderProxy *	MaterialInstance,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetDiscMesh() [1/2]

void GetDiscMesh	(	const FMatrix &	ToWorld,
		const FVector &	Center,
		const FVector &	XAxis,
		const FVector &	YAxis,
		double	Radius,
		int32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetDiscMesh() [2/2]

void GetDiscMesh	(	const FVector &	Center,
		const FVector &	XAxis,
		const FVector &	YAxis,
		double	Radius,
		int32	Sides,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		HHitProxy *	HitProxy
	)

GetHalfSphereMesh()

void GetHalfSphereMesh	(	const FVector &	Center,
		const FVector &	Radii,
		int32	NumSides,
		int32	NumRings,
		float	StartAngle,
		float	EndAngle,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bDisableBackfaceCulling,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		bool	bUseSelectionOutline,
		HHitProxy *	HitProxy
	)

GetOrientedHalfSphereMesh()

void GetOrientedHalfSphereMesh	(	const FVector &	Center,
		const FRotator &	Orientation,
		const FVector &	Radii,
		int32	NumSides,
		int32	NumRings,
		float	StartAngle,
		float	EndAngle,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bDisableBackfaceCulling,
		int32	ViewIndex,
		FMeshElementCollector &	Collector,
		bool	bUseSelectionOutline,
		HHitProxy *	HitProxy
	)

GetSelectionColor()

FLinearColor GetSelectionColor	(	const FLinearColor &	BaseColor,
		bool	bSelected,
		bool	bHovered,
		bool	bUseOverlayIntensity = true
	)

Given a base color and a selection state, returns a color which accounts for the selection state.

Parameters

BaseColor	- The base color of the object.
bSelected	- The selection state of the object.
bHovered	- True if the object has hover focus
bUseOverlayIntensity	- True if the selection color should be modified by the selection intensity

Returns

The color to draw the object with, accounting for the selection state

GetSphereMesh() [1/2]

void GetSphereMesh	(	const FVector &	Center,
		const FVector &	Radii,
		int32	NumSides,
		int32	NumRings,
		const FMaterialRenderProxy *	MaterialRenderProxy,
		uint8	DepthPriority,
		bool	bDisableBackfaceCulling,
		int32	ViewIndex,
		FMeshElementCollector &	Collector
	)

GetSphereMesh() [2/2]

ENGINE_API void GetSphereMesh ( const FVector &  Center, const FVector &  Radii, int32  NumSides, int32  NumRings, const FMaterialRenderProxy *  MaterialRenderProxy, uint8  DepthPriority, bool  bDisableBackfaceCulling, int32  ViewIndex, FMeshElementCollector &  Collector, bool  bUseSelectionOutline, HHitProxy *  HitProxy  )

extern

GetViewSelectionColor()

FLinearColor GetViewSelectionColor	(	const FLinearColor &	BaseColor,
		const FSceneView &	View,
		bool	bSelected,
		bool	bHovered,
		bool	bUseOverlayIntensity,
		bool	bIndividuallySelected
	)

IsRichView()

bool IsRichView

(

const FSceneViewFamily &

ViewFamily

)

Returns true if the given view is "rich", and all primitives should be forced down the dynamic drawing path so that ApplyViewModeOverrides can implement the rich view feature. A view is rich if is missing the EngineShowFlags.Materials showflag, or has any of the render mode affecting showflags.

IsUVOutOfBounds()

bool IsUVOutOfBounds

(

FVector2D

UV

)