1. Epic GamesDeveloper
  3. FAvaVisualizerBase

FAvaVisualizerBase

Select shape:

API > API/Plugins > API/Plugins/AvalancheComponentVisualizers

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)
   
Name FAvaVisualizerBase
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheComponentVisualizers/Public/AvaVisBase.h
Include Path #include "AvaVisBase.h"

Syntax

class FAvaVisualizerBase : public FComponentVisualizer

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAvaVisualizerBase()

   AvaVisBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAvaVisualizerBase()

   AvaVisBase.h  

Typedefs

Name Type Remarks Include Path
Super FComponentVisualizer   AvaVisBase.h

Constants

Name Type Remarks Include Path
Active FLinearColor   AvaVisBase.h
ActiveAltMode FLinearColor   AvaVisBase.h
Disabled FLinearColor   AvaVisBase.h
Enabled FLinearColor   AvaVisBase.h
Inactive FLinearColor   AvaVisBase.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   AvaVisBase.h  

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

   AvaVisBase.h  

virtual void EndEditing()

 Editing -> We have a hitproxy selected. AvaVisBase.h  

TMap< UObject *, TArray< FProperty * > > GatherEditableProperties ( UObject* InObject
) const

 Returns a list of objects and the properties being edited on that object. AvaVisBase.h  

virtual bool GetCustomInputCoordinateSystem ( const FEditorViewportClient* InViewportClient,
FMatrix& OutMatrix
) const

   AvaVisBase.h  

virtual const USceneComponent * GetEditedSceneComponent ( const UActorComponent* InComponent
) const

   AvaVisBase.h  
  AvaVisBase.h  

FEditorViewportClient * GetLastUsedViewportClient()

   AvaVisBase.h  

TSharedPtr< FAvaSnapOperation > GetSnapOperation()

   AvaVisBase.h  

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

   AvaVisBase.h  

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

 Used to override the axis used to actually calculate drag. AvaVisBase.h  

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

   AvaVisBase.h  

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

   AvaVisBase.h  

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

   AvaVisBase.h  

virtual bool IsEditing()

   AvaVisBase.h  

bool IsTracking()

   AvaVisBase.h  

virtual bool ResetValue ( FEditorViewportClient* InViewportClient,
HHitProxy* InHitProxy
)

   AvaVisBase.h  

virtual void StartEditing ( FEditorViewportClient* InViewportClient,
UActorComponent* InEditedComponent
)

   AvaVisBase.h  

virtual void TrackingStarted ( FEditorViewportClient* InViewportClient
)

 Tracking -> We are actively dragging a widget. AvaVisBase.h  

virtual void TrackingStopped ( FEditorViewportClient* InViewportClient,
bool bInDidMove
)

   AvaVisBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddSnapDataBinding()

   AvaVisBase.h  

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. AvaVisBase.h  

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

   AvaVisBase.h  

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

   AvaVisBase.h  

void EndTransaction()

   AvaVisBase.h  

virtual void GenerateContextSensitiveSnapPoints()

   AvaVisBase.h  

virtual FBox GetComponentBounds ( const UActorComponent* InComponent
) const

   AvaVisBase.h  

virtual FTransform GetComponentTransform ( const UActorComponent* InComponent
) const

   AvaVisBase.h  

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

 Gets the position and size of icons based on the above ^. AvaVisBase.h  

FVector GetLocalVector ( FEditorViewportClient* InViewport,
const FVector& InVector
) const

 Converts vectors from world space to local space. AvaVisBase.h  

EAxisList::Type GetViewportWidgetAxisList ( FEditorViewportClient* InViewportClient
) const

   AvaVisBase.h  

UE::Widget::EWidgetMode GetViewportWidgetMode ( FEditorViewportClient* InViewportClient
) const

   AvaVisBase.h  

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

   AvaVisBase.h  

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

   AvaVisBase.h  

void ModifyProperty ( UObject* InObject,
FProperty* InProperty,
EPropertyChangeType::Type InPropertyChangeType,
TFunctionRef< void()> InFunction
)

   AvaVisBase.h  

void ModifyProperty ( UObject* InObject,
FName InPropertyName,
EPropertyChangeType::Type InPropertyChangeType,
TFunctionRef< void()> InFunction
)

   AvaVisBase.h  

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

   AvaVisBase.h  

void StartTransaction()

   AvaVisBase.h  

virtual void StoreInitialValues()

   AvaVisBase.h  

virtual void TrackingStartedInternal ( FEditorViewportClient* InViewportClient
)

   AvaVisBase.h  

virtual void TrackingStoppedInternal ( FEditorViewportClient* InViewportClient
)

   AvaVisBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FLinearColor & GetIconColor ( bool bInActive,
bool bInAltMode
)

   AvaVisBase.h  

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

   AvaVisBase.h  

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

 Notify that many component properties have been modified AvaVisBase.h  

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 AvaVisBase.h  

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

 Notify that a component property has been modified AvaVisBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page