UBrushStampIndicator

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/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

UPrimitiveCompo ...

 

AttachedComponent

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

Public variable

bool

 

bDepthTested

Public variable

bool

 

bDrawFalloffCircle

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

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 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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback