1. Epic GamesDeveloper
  3. FSmartObjectVisualizationContext

FSmartObjectVisualizationContext

Helper class used for Smart Object Annotation rendering.

API > API/Plugins > API/Plugins/SmartObjectsModule

Helper class used for Smart Object Annotation rendering.

   
Name FSmartObjectVisualizationContext
Type struct
Header File /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectVisualizationContext.h
Include Path #include "SmartObjectVisualizationContext.h"

Syntax

struct FSmartObjectVisualizationContext

Constructors

Name Remarks Include Path Unreal Specifiers

FSmartObjectVisualizationContext ( const USmartObjectDefinition& InDefinition,
const UWorld& InWorld
)

   SmartObjectVisualizationContext.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnnotationIndex int32 Index of the visualized annotation. SmartObjectVisualizationContext.h  
bIsAnnotationSelected bool True, if the annotation is currently selected SmartObjectVisualizationContext.h  
bIsSlotSelected bool True, if the slot is currently selected SmartObjectVisualizationContext.h  
Canvas FCanvas * Canvas to render to during DrawVisualizationHUD(). SmartObjectVisualizationContext.h  
Definition const USmartObjectDefinition & Pointer to the visualized Smart Object definition. SmartObjectVisualizationContext.h  
Font const UFont * Pointer to valid engine small font. SmartObjectVisualizationContext.h  
OwnerLocalToWorld FTransform Transform of the owner object. SmartObjectVisualizationContext.h  
PDI FPrimitiveDrawInterface * Primitive draw interface to draw with during DrawVisualization(). SmartObjectVisualizationContext.h  
PreviewActor const AActor * Actor used for previewing the Smart Object. SmartObjectVisualizationContext.h  
PreviewValidationFilterClass TSubclassOf< USmartObjectSlotValidationFilter > Validation filter class used for previewing. SmartObjectVisualizationContext.h  
SelectedColor FLinearColor Color for a selection, cached from UEditorStyleSettings. SmartObjectVisualizationContext.h  
SlotIndex int32 Index of the visualized slot, or invalid of the annotation is on the object. SmartObjectVisualizationContext.h  
View const FSceneView * Current view to draw to. SmartObjectVisualizationContext.h  
World const UWorld & World associated with the drawing. SmartObjectVisualizationContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DrawArrow ( const FVector& Start,
const FVector& End,
const FLinearColor& Color,
const float ArrowHeadLength,
const float EndLocationInset,
const uint8 DepthPriorityGroup,
const float Thickness,
const float DepthBias,
bool bScreenSpace
) const

 Draws arrow from Start to End. SmartObjectVisualizationContext.h  

void DrawString ( const FVector& Location,
const TCHAR* Text,
const FLinearColor& Color,
const FLinearColor& ShadowColor
) const

 Draws string on canvas centered at specified world location. SmartObjectVisualizationContext.h  

void DrawString ( const float StartX,
const float StartY,
const TCHAR* Text,
const FLinearColor& Color,
const FLinearColor& ShadowColor
) const

 Draws string on canvas at specified canvas location. SmartObjectVisualizationContext.h  

FVector::FReal GetDistanceToCamera ( const FVector& Location
) const

   SmartObjectVisualizationContext.h  

bool IsLocationVisible ( const FVector& Location
) const

   SmartObjectVisualizationContext.h  

bool IsValidForDraw()

   SmartObjectVisualizationContext.h  

bool IsValidForDrawHUD()

   SmartObjectVisualizationContext.h  

FVector2D Project ( const FVector& Location
) const

 Projects world location into canvas screen space. SmartObjectVisualizationContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page