1. Epic GamesDeveloper
  3. UBrushAdjusterInputBehavior

UBrushAdjusterInputBehavior

A behavior that captures a keyboard hotkey to enter a sub-mode "bAdjustingBrush" while the key is pressed.

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseTools

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseTools/BaseBrushTool.h
Include #include "BaseTools/BaseBrushTool.h"

Syntax

UCLASS ()  
class UBrushAdjusterInputBehavior : public UAnyButtonInputBehavior

Remarks

A behavior that captures a keyboard hotkey to enter a sub-mode "bAdjustingBrush" while the key is pressed. The target tool must call OnDragStart() and OnDragUpdate() to feed the screen coordinates of the mouse for the duration of the behavior. And use "GetIsBrushBeingAdjusted" to pause/disable the brush motion while it is being adjusted.

OnDragStart() defines the starting location of an adjustment OnDragUpdate() adjusts the brush strength and radius based on the magnitude of the screen coordinate delta in the vertical and horizontal directions respectively.

Functions

  Type Name Description
Public function void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function void

Initialize ( UBaseBrushTool* InBrushTool
)

  
Public function Const bool  
Public function void

OnDragStart ( FVector2D InScreenPosition
)

  
Public function void

OnDragUpdate ( FVector2D InScreenPosition
)

  
Public function void

SetSizeAdjustSpeed ( float InSizeSpeed
)

  
Public function void

SetStrengthAdjustSpeed ( float InStrengthSpeed
)

  

Overridden from UAnyButtonInputBehavior

  Type Name Description
Public function Virtual bool

IsPressed ( const FInputDeviceState& input
)

  
Public function Virtual bool

IsReleased ( const FInputDeviceState& input
)

  

Overridden from UInputBehavior

  Type Name Description
Public function Virtual FInputCaptureUpdate

BeginCapture ( const FInputDeviceState& InputState,
EInputCaptureSide eSide
)

 Called after WantsCapture() returns a capture request that was accepted
Public function Virtual void

ForceEndCapture ( const FInputCaptureData& CaptureData
)

 If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly
Public function Virtual EInputDevices UAnyButtonInputBehavior.
Public function Virtual FInputCaptureUpdate

UpdateCapture ( const FInputDeviceState& InputState,
const FInputCaptureData& CaptureData
)

 Called for each new input event during a capture sequence.
Public function Virtual FInputCaptureRequest

WantsCapture ( const FInputDeviceState& InputState
)

 Given the input state, does this Behavior want to begin capturing some input devices?

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page