Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UBrushStampIndicator is a simple 3D brush indicator.
| Name | UBrushStampIndicator |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/BrushStampIndicator.h |
| Include Path | #include "BaseGizmos/BrushStampIndicator.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UBrushStampIndicator : public UInteractiveGizmo
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveGizmo → UBrushStampIndicator
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttachedComponent | TObjectPtr< UPrimitiveComponent > | Optional Component that will be transformed such that it tracks the Radius/Position/Normal | BaseGizmos/BrushStampIndicator.h | |
| bDepthTested | bool | BaseGizmos/BrushStampIndicator.h | ||
| bDrawIndicatorLines | bool | BaseGizmos/BrushStampIndicator.h | ||
| bDrawRadiusCircle | bool | BaseGizmos/BrushStampIndicator.h | ||
| bDrawSecondaryLines | bool | BaseGizmos/BrushStampIndicator.h | ||
| BrushFalloff | float | BaseGizmos/BrushStampIndicator.h | ||
| BrushNormal | FVector | BaseGizmos/BrushStampIndicator.h | ||
| BrushPosition | FVector | BaseGizmos/BrushStampIndicator.h | ||
| BrushRadius | float | BaseGizmos/BrushStampIndicator.h | ||
| BrushStrength | float | BaseGizmos/BrushStampIndicator.h | ||
| bScaleNormalByStrength | bool | BaseGizmos/BrushStampIndicator.h | ||
| bVisible | bool | Controls whether Gizmo will draw visual elements. Does not currently affect AttachedComponent. | BaseGizmos/BrushStampIndicator.h | |
| LineColor | FLinearColor | BaseGizmos/BrushStampIndicator.h | ||
| LineThickness | float | BaseGizmos/BrushStampIndicator.h | ||
| SampleStepCount | int | BaseGizmos/BrushStampIndicator.h | ||
| SecondaryLineColor | FLinearColor | BaseGizmos/BrushStampIndicator.h | ||
| SecondaryLineThickness | float | BaseGizmos/BrushStampIndicator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Update
(
float Radius, |
Update the Radius, Transform and Falloff of the Stamp Indicator | BaseGizmos/BrushStampIndicator.h | |
virtual void Update
(
float Radius, |
Update the Radius, Position, and Normal of the stamp indicator | BaseGizmos/BrushStampIndicator.h |
Overridden from UInteractiveGizmo
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
Allow the Gizmo to do any custom drawing (ie via PDI/RHI) | BaseGizmos/BrushStampIndicator.h | |
virtual void Setup() |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called | BaseGizmos/BrushStampIndicator.h | |
virtual void Shutdown() |
Called by GizmoManager to shut down the Gizmo | BaseGizmos/BrushStampIndicator.h | |
virtual void Tick
(
float DeltaTime |
Allow the Gizmo to do any necessary processing on Tick | BaseGizmos/BrushStampIndicator.h |