1. Epic GamesDeveloper
  3. FAvaVisualizerBase

FAvaVisualizerBase

Select shape:

API > API/Plugins > API/Plugins/AvalancheComponentVisualizers

Inheritance Hierarchy

References

   
Module AvalancheComponentVisualizers
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheComponentVisualizers/Public/AvaVisBase.h
Include #include "AvaVisBase.h"

Syntax

class FAvaVisualizerBase : public FComponentVisualizer

Remarks

Select shape:

  • DrawVisualization

Select HitProxy:

  • VisProxyHandleClick |- EndEditing | |- EndTransaction | - Update ST that no Vis is active. - StartEditing |- Store component & HP settings - Update ST that we are active.

Mouse down on widget:

  • Viewport: TrackingStarted (not used)

Drag mouse

  • HandleInputDelta |- (Not tracking) | - StartTracking | |- TrackingStarted | - StoreInitialValues - HandleInputDeltaInternal

Release mouse

  • Viewport: TrackingStopped - TrackingStopped - EndTransaction (see above)

Variables

  Type Name Description
Protected variable FRotator AccumulatedRotation  
Protected variable FVector AccumulatedScale  
Protected variable FVector AccumulatedTranslation  
Protected variable bool bHasBeenModified  
Protected variable bool bHasInitialWidgetLocation Delta sums.
Protected variable bool bTracking  
Protected variable FVector IconStartPosition Top icons.
Protected variable FVector InitialWidgetLocation  
Protected variable FEditorViewportClient * LastUsedViewportClient Last used viewport client.
Protected variable TSharedPtr< FAvaSnapOperation > SnapOperation Snapping stuff.
Protected variable int32 TransactionIdx Tracking info.

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Protected function Virtual void  
Protected function bool

CalcIconLocation ( const USceneComponent* InComponent,
const FSceneView* InView
)

 Calculates the location of the first top-of-shape icon in world space Uses the shape's bounding box to do this.
Protected function Virtual void

DrawVisualizationEditing ( const UActorComponent* InComponent,
const FSceneView* InView,
FPrimitiveDrawInterface* InPDI,
int32& InOutIconIndex
)

  
Protected function Virtual void

DrawVisualizationNotEditing ( const UActorComponent* InComponent,
const FSceneView* InView,
FPrimitiveDrawInterface* InPDI,
int32& InOutIconIndex
)

  
Protected function void  
Public function Const TMap< UObject *, TArray< FProperty * > > Returns a list of objects and the properties being edited on that object.
Protected function Virtual void  
Protected function Virtual Const FBox

GetComponentBounds ( const UActorComponent* InComponent
)

  
Protected function Virtual Const FTransform

GetComponentTransform ( const UActorComponent* InComponent
)

  
Public function Virtual Const const USceneComponent *  
Public function Virtual Const const USceneComponent *

GetEditedSceneComponent ( const UActorComponent* InComponent
)

  
Protected function Static const FLinearColor &

GetIconColor ( bool bInActive,
bool bInAltMode
)

  
Protected function Const void

GetIconMetrics ( const FSceneView* InView,
int32 InIconIndex,
FVector& InOutPosition,
float& InOutSize
)

 Gets the position and size of icons based on the above ^.
Protected function Static float

GetIconSizeScale ( const FSceneView* InView,
const FVector& InWorldPosition
)

  
Public function Const FEditorViewportClient *  
Protected function Const FVector

GetLocalVector ( FEditorViewportClient* InViewport,
const FVector& InVector
)

 Converts vectors from world space to local space.
Public function Const TSharedPtr< FAvaSnapOperation >  
Protected function Const EAxisList::Type  
Protected function Const UE::Widget::EWidgetMode  
Public function Virtual Const bool

GetWidgetAxisList ( const FEditorViewportClient* InViewportClient,
UE::Widget::EWidgetMode InWidgetMode,
EAxisList::Type& OutAxisList
)

  
Public function Virtual Const bool

GetWidgetAxisListDragOverride ( const FEditorViewportClient* InViewportClient,
UE::Widget::EWidgetMode InWidgetMode,
EAxisList::Type& OutAxisList
)

 Used to override the axis used to actually calculate drag.
Public function Virtual Const bool

GetWidgetMode ( const FEditorViewportClient* InViewportClient,
UE::Widget::EWidgetMode& OutMode
)

  
Protected function Virtual bool

HandleInputDeltaInternal ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
const FVector& InAccumulatedTranslation,
const FRotator& InAccumulatedRotation,
const FVector& InAccumulatedScale
)

  
Public function Virtual Const bool  
Protected function Const bool

IsMouseOverComponent ( const UActorComponent* InComponent,
const FSceneView* InView
)

  
Public function Const bool  
Protected function Static void

NotifyPropertiesModified ( UObject* InObject,
const TArray< FProperty* >& InProperties,
EPropertyChangeType::Type InPropertyChangeType,
FProperty* InMemberProperty
)

 Notify that many component properties have been modified
Protected function Static void

NotifyPropertyChainModified ( UObject* InObject,
FProperty* InProperty,
EPropertyChangeType::Type InPropertyChangeType,
int32 InContainerIdx,
TArray< FProperty* > InMemberChainProperties
)

 Notify that a component property has been modified inside a container
Protected function Static void

NotifyPropertyModified ( UObject* InObject,
FProperty* InProperty,
EPropertyChangeType::Type InPropertyChangeType,
FProperty* InMemberProperty
)

 Notify that a component property has been modified
Public function Virtual bool

ResetValue ( FEditorViewportClient* InViewportClient,
HHitProxy* InHitProxy
)

  
Protected function Const bool

ShouldDrawExtraHandles ( const UActorComponent* InComponent,
const FSceneView* InView
)

  
Public function Virtual void

StartEditing ( FEditorViewportClient* InViewportClient,
UActorComponent* InEditedComponent
)

  
Protected function void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  

Overridden from FComponentVisualizer

  Type Name Description
Public function Virtual void

DrawVisualization ( const UActorComponent* InComponent,
const FSceneView* InView,
FPrimitiveDrawInterface* InPDI
)

 Draw visualization for the supplied component
Public function Virtual void

DrawVisualizationHUD ( const UActorComponent* InComponent,
const FViewport* InViewport,
const FSceneView* InView,
FCanvas* InCanvas
)

 Draw HUD on viewport for the supplied component
Public function Virtual void Editing -> We have a hitproxy selected.
Public function Virtual Const bool

GetCustomInputCoordinateSystem ( const FEditorViewportClient* InViewportClient,
FMatrix& OutMatrix
)

  
Public function Virtual bool

HandleInputDelta ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FVector& InDeltaTranslate,
FRotator& InDeltaRotate,
FVector& InDeltaScale
)

  
Public function Virtual bool

HandleModifiedClick ( FEditorViewportClient* InViewportClient,
HHitProxy* InHitProxy,
const FViewportClick& InClick
)

 Handle click modified by Alt, Ctrl and/or Shift. The input HitProxy may not be on this component.
Public function Virtual void

TrackingStarted ( FEditorViewportClient* InViewportClient
)

 Tracking -> We are actively dragging a widget.
Public function Virtual void

TrackingStopped ( FEditorViewportClient* InViewportClient,
bool bInDidMove
)

 Gets called when the mouse tracking has stopped (dragging behavior)

Typedefs

Name Description
Super  

Constants

Name Description
Active  
ActiveAltMode  
Disabled  
Enabled  
Inactive  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page