UBrushStampIndicator

[UBrushStampIndicator](API\Runtime\InteractiveToolsFramework\BaseGizmos\UBrushStampIndicator) is a simple 3D brush indicator.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/BrushStampIndicator.h

Include

#include "BaseGizmos/BrushStampIndicator.h"

Syntax

class UBrushStampIndicator : public UInteractiveGizmo

Remarks

UBrushStampIndicator is a simple 3D brush indicator.

Variables

Name Description

Public variable

TObjectPtr< UPr...

 

AttachedComponent

Optional Component that will be transformed such that it tracks the Radius/Position/Normal

Public variable

bool

 

bDepthTested

Public variable

bool

 

bDrawIndicatorLines

Public variable

bool

 

bDrawRadiusCircle

Public variable

bool

 

bDrawSecondaryLines

Public variable

float

 

BrushFalloff

Public variable

FVector

 

BrushNormal

Public variable

FVector

 

BrushPosition

Public variable

float

 

BrushRadius

Public variable

bool

 

bVisible

Controls whether Gizmo will draw visual elements. Does not currently affect AttachedComponent.

Protected variable

FVector

 

InitialComponentScale

Public variable

FLinearColor

 

LineColor

Public variable

float

 

LineThickness

Public variable

int

 

SampleStepCount

Protected variable

UPrimitiveCompo...

 

ScaleInitializedComponent

Public variable

FLinearColor

 

SecondaryLineColor

Public variable

float

 

SecondaryLineThickness

Functions

Name Description

Public function Virtual

void

 

Update

(
    float Radius,
    const FTransform& WorldTransform,
    float Falloff
)

Update the Radius, Transform and Falloff of the Stamp Indicator

Public function Virtual

void

 

Update

(
    float Radius,
    const FVector& Position,
    const FVector& Normal,
    float Falloff
)

Update the Radius, Position, and Normal of the stamp indicator

Overridden from UInteractiveGizmo

Name Description

Public function Virtual

void

 

Render

(
    IToolsContextRenderAPI* Render...
)

Allow the Gizmo to do any custom drawing (ie via PDI/RHI)

Public function Virtual

void

 

Setup()

Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called

Public function Virtual

void

 

Shutdown()

Called by GizmoManager to shut down the Gizmo

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Allow the Gizmo to do any necessary processing on Tick