1. Epic GamesDeveloper
  3. FToolDataVisualizer

FToolDataVisualizer

[FToolDataVisualizer](API\Runtime\InteractiveToolsFramework\FToolDataVisualizer) is a utility class for Tool and Gizmo implementations to use to draw 3D lines, points, etc.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

FToolDataVisualizer is a utility class for Tool and Gizmo implementations to use to draw 3D lines, points, etc.

Currently uses PDI drawing but may use different back-ends in the future

   
Name FToolDataVisualizer
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolDataVisualizer.h
Include Path #include "ToolDataVisualizer.h"

Syntax

class FToolDataVisualizer

Constructors

Name Remarks Include Path Unreal Specifiers
  ToolDataVisualizer.h  
  ToolDataVisualizer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FToolDataVisualizer()

   ToolDataVisualizer.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrowHeadSize float Default size used for drawing arrow heads ToolDataVisualizer.h  
bDepthTested bool Should lines be clipped by 3D geometry, or should they be drawn with quasi-transparency ToolDataVisualizer.h  
DepthBias float Depth bias applied to lines ToolDataVisualizer.h  
LineColor FLinearColor Default color used for drawing lines ToolDataVisualizer.h  
LineThickness float Default thickness used for drawing lines ToolDataVisualizer.h  
PointColor FLinearColor Default color used for drawing points ToolDataVisualizer.h  
PointSize float Default size used for drawing points ToolDataVisualizer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginFrame ( IToolsContextRenderAPI* RenderAPI,
const FViewCameraState& CameraState
)

 Frame initialization/cleanup This must be called every frame to allow Visualizer to extract necessary rendering data/objects ToolDataVisualizer.h  

void BeginFrame ( IToolsContextRenderAPI* RenderAPI
)

 This must be called every frame to allow Visualizer to extract necessary rendering data/objects ToolDataVisualizer.h  

void DrawArc ( const PointType& Position,
const PointType& Normal,
float Radius,
int Steps,
float MinAngle,
float MaxAngle,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a 3D arc at given position/normal with the given parameters. ToolDataVisualizer.h  

void DrawCircle ( const PointType& Position,
const PointType& Normal,
float Radius,
int Steps,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a 3D circle at given position/normal with the given parameters. ToolDataVisualizer.h  

void DrawDirectionalArrow ( const PointType& A,
const PointType& B,
const FVector& InNormal,
const FLinearColor& Color,
float InArrowHeadSize,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a line with the given parameters ToolDataVisualizer.h  

void DrawDirectionalArrow ( const PointType& A,
const PointType& B,
const FVector& InNormal,
const FLinearColor& Color,
float InArrowHeadSize,
float LineThicknessIn
)

 Draw a line with the given Color and Thickness, otherwise use default parameters ToolDataVisualizer.h  

void DrawDirectionalArrow ( const PointType& A,
const PointType& B,
const FVector& InNormal,
const FLinearColor& Color
)

 Draw a line with the given Color, otherwise use default parameters ToolDataVisualizer.h  

void DrawDirectionalArrow ( const PointType& A,
const PointType& B,
const FVector& InNormal
)

 Draw an arrow with default parameters ToolDataVisualizer.h  

void DrawDisc ( const PointType& Position,
const PointType& Normal,
float Radius,
int Steps,
const FColor& Color,
FMaterialRenderProxy* RenderProxy,
bool bDepthTestedIn
)

 Draw a 3D disc at given position/normal with the given parameters. ToolDataVisualizer.h  

void DrawGrid ( const PointType& Center,
const PointType& Normal,
const PointType& Size,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

   ToolDataVisualizer.h  

void DrawGrid ( const PointType& Center,
const PointType& Normal,
const PointType& Up,
const PointType& Side,
const PointType& Size,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

   ToolDataVisualizer.h  

void DrawLine ( const PointType& A,
const PointType& B
)

 Drawing functions Draw a line with default parameters ToolDataVisualizer.h  

void DrawLine ( const PointType& A,
const PointType& B,
const FLinearColor& Color
)

 Draw a line with the given Color, otherwise use default parameters ToolDataVisualizer.h  

void DrawLine ( const PointType& A,
const PointType& B,
const FLinearColor& Color,
float LineThicknessIn
)

 Draw a line with the given Color and Thickness, otherwise use default parameters ToolDataVisualizer.h  

void DrawLine ( const PointType& A,
const PointType& B,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a line with the given parameters ToolDataVisualizer.h  

void DrawPoint ( const PointType& Position
)

 Draw a point with default parameters ToolDataVisualizer.h  

void DrawPoint ( const PointType& Position,
const FLinearColor& Color,
float PointSizeIn,
bool bDepthTestedIn
)

 Draw a point with the given parameters ToolDataVisualizer.h  

void DrawPoint ( const PointType& Position,
const FLinearColor& Color
)

 Draw a point with the given Color, otherwise use default parameters ToolDataVisualizer.h  

void DrawSquare ( const PointType& Center,
const PointType& SideA,
const PointType& SideB,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

   ToolDataVisualizer.h  

void DrawSquare ( const PointType& Center,
const PointType& SideA,
const PointType& SideB
)

   ToolDataVisualizer.h  

void DrawViewFacingArc ( const PointType& Position,
float Radius,
int Steps,
float MinAngle,
float MaxAngle,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a 3D arc at given position/normal with the given parameters. ToolDataVisualizer.h  

void DrawViewFacingCircle ( const PointType& Position,
float Radius,
int Steps,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a 3D circle at given position/normal with the given parameters. ToolDataVisualizer.h  

void DrawViewFacingX ( const PointType& Position,
float Width,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a world-space X facing the viewer at the given position. ToolDataVisualizer.h  

void DrawViewFacingX ( const PointType& Position,
float Width
)

 Draw a world-space X facing the viewer at the given position. ToolDataVisualizer.h  

void DrawWireBox ( const FBox& Box
)

 Draw a 3D box, parameterized the same as the 3D circle but extruded by Height ToolDataVisualizer.h  

void DrawWireBox ( const FBox& Box,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

   ToolDataVisualizer.h  

void DrawWireCylinder ( const PointType& Position,
const PointType& Normal,
float Radius,
float Height,
int Steps
)

 Draw a 3D cylinder, parameterized the same as the 3D circle but extruded by Height ToolDataVisualizer.h  

void DrawWireCylinder ( const PointType& Position,
const PointType& Normal,
float Radius,
float Height,
int Steps,
const FLinearColor& Color,
float LineThicknessIn,
bool bDepthTestedIn
)

 Draw a 3D cylinder, parameterized the same as the 3D circle but extruded by Height ToolDataVisualizer.h  

void EndFrame()

 This should be called at the end of every frame to allow for necessary cleanup ToolDataVisualizer.h  

void PopAllTransforms()

 Clear the transform stack to identity ToolDataVisualizer.h  

void PopTransform()

 Pop a transform from the transform stack ToolDataVisualizer.h  

void PushTransform ( const FTransform& Transform
)

 Push a Transform onto the transform stack ToolDataVisualizer.h  

void SetLineParameters ( const FLinearColor& Color,
float Thickness,
float InArrowHeadSize
)

 Parameters Update the default line color and thickness ToolDataVisualizer.h  

void SetPointParameters ( const FLinearColor& Color,
float Size
)

 Update the default point color and size ToolDataVisualizer.h  

void SetTransform ( const FTransform& Transform
)

 Transform support Clear transform stack and push the given Transform ToolDataVisualizer.h  

FVector TransformN ( const FVector& Normal
)

   ToolDataVisualizer.h  

FVector TransformP ( const FVector& Point
)

   ToolDataVisualizer.h  

FVector TransformV ( const FVector& Vector
)

   ToolDataVisualizer.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void InternalDrawArc ( const FVector& InPosition,
const FVector& InNormal,
const float InRadius,
int32 InSteps,
const float InMinAngle,
const float InMaxAngle,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the arc drawing ToolDataVisualizer.h  

virtual void InternalDrawCircle ( const FVector& Position,
const FVector& Normal,
float Radius,
int Steps,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the circle drawing ToolDataVisualizer.h  

virtual void InternalDrawDirectionalArrow ( const FVector& A,
const FVector& B,
const FVector& InNormal,
const FLinearColor& Color,
const float InHeadSize,
float LineThickness,
bool bDepthTested
)

 Actually does the arrow drawing; assumes A and B are already transformed ToolDataVisualizer.h  

virtual void InternalDrawDisc ( const FVector& Position,
const FVector& Normal,
float Radius,
int Steps,
const FColor& Color,
FMaterialRenderProxy* RenderProxy,
bool bDepthTested
)

 Actually does the disc drawing ToolDataVisualizer.h  

virtual void InternalDrawGrid ( const FVector& Center,
const FVector& Normal,
const FVector& Up,
const FVector& Side,
const FVector& Size,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the grid drawing ToolDataVisualizer.h  

virtual void InternalDrawGrid ( const FVector& Center,
const FVector& Normal,
const FVector& Size,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the grid drawing ToolDataVisualizer.h  

virtual void InternalDrawSquare ( const FVector& Center,
const FVector& SideA,
const FVector& SideB,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the square drawing ToolDataVisualizer.h  

virtual void InternalDrawTransformedLine ( const FVector& A,
const FVector& B,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the line drawing; assumes A and B are already transformed ToolDataVisualizer.h  

virtual void InternalDrawTransformedPoint ( const FVector& Position,
const FLinearColor& Color,
float PointSize,
bool bDepthTested
)

 Actually does the point drawing; assumes Position is already transformed ToolDataVisualizer.h  

virtual void InternalDrawViewFacingArc ( const FVector& InPosition,
float InRadius,
int32 InSteps,
const float InMinAngle,
const float InMaxAngle,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the arc drawing ToolDataVisualizer.h  

virtual void InternalDrawViewFacingCircle ( const FVector& Position,
float Radius,
int Steps,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the circle drawing ToolDataVisualizer.h  

virtual void InternalDrawViewFacingX ( const FVector& Position,
float Width,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the X drawing ToolDataVisualizer.h  

virtual void InternalDrawWireBox ( const FBox& Box,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the box drawing ToolDataVisualizer.h  

virtual void InternalDrawWireCylinder ( const FVector& Position,
const FVector& Normal,
float Radius,
float Height,
int Steps,
const FLinearColor& Color,
float LineThickness,
bool bDepthTested
)

 Actually does the cylinder drawing ToolDataVisualizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page