1. Epic GamesDeveloper
  3. FSubGizmoTransformAdjuster

FSubGizmoTransformAdjuster

An adjuster that can do various transformations common for sub gizmos, which are based off of the parent gizmo transform (in addition to the actual component transform).

API > API/Runtime > API/Runtime/InteractiveToolsFramework

An adjuster that can do various transformations common for sub gizmos, which are based off of the parent gizmo transform (in addition to the actual component transform).

   
Name FSubGizmoTransformAdjuster
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ViewBasedTransformAdjusters.h
Include Path #include "BaseGizmos/ViewBasedTransformAdjusters.h"

Syntax

class FSubGizmoTransformAdjuster :  
    public UE::GizmoRenderingUtil::IViewBasedTransformAdjuster ,  
    public TSharedFromThis< FSubGizmoTransformAdjuster, ESPMode::ThreadSafe >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FSubGizmoTransformAdjuster ( const FTransform& GizmoOriginToComponent,
const FSettings& SettingsIn
)

   BaseGizmos/ViewBasedTransformAdjusters.h  

Structs

Name Remarks
FSettings  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GizmoOriginToComponent_GameThread FTransform   BaseGizmos/ViewBasedTransformAdjusters.h  
GizmoOriginToComponent_RenderThread FTransform   BaseGizmos/ViewBasedTransformAdjusters.h  
Settings FSettings We might decide to have a render thread version of the settings as well, but it's unclear whether it's worth it, since it seems like a brief inconsistency during the update is unlikely to cause much of a problem: a user is unlikely to be changing multiple bools at once, and reading an outdated bool seems fine. BaseGizmos/ViewBasedTransformAdjusters.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetGizmoOriginTransform ( const FTransform& GizmoOriginToComponent
)

 Update the transform of the gizmo origin relative to this component. BaseGizmos/ViewBasedTransformAdjusters.h  

void SetMirrorBasedOnOctant ( bool bOn
)

   BaseGizmos/ViewBasedTransformAdjusters.h  

void SetSettings ( const FSettings& SettingsIn
)

   BaseGizmos/ViewBasedTransformAdjusters.h  

Overridden from IViewBasedTransformAdjuster

Name Remarks Include Path Unreal Specifiers

virtual FTransform GetAdjustedComponentToWorld ( const UE::GizmoRenderingUtil::ISceneViewInterface& View,
const FTransform& CurrentComponentToWorld
)

 IGizmoViewTransformAdjuster. BaseGizmos/ViewBasedTransformAdjusters.h  

virtual FTransform GetAdjustedComponentToWorld_RenderThread ( const ISceneViewInterface& View,
const FTransform& CurrentComponentToWorld
)

 If an adjuster is used by a render proxy, it will use this endpoint for getting the transform. BaseGizmos/ViewBasedTransformAdjusters.h  

virtual FBoxSphereBounds GetViewIndependentBounds ( const FTransform& LocalToWorld,
const FBoxSphereBounds& OriginalBounds
)

 Returns the transform that should be returned by a USceneComponent CalcBounds method, which can't know about the view. BaseGizmos/ViewBasedTransformAdjusters.h  

virtual void UpdateWorldLocalState ( bool bWorldIn
)

 Not every adjuster will care about the world/local setting, but it is useful for the a component that uses it to be able to blindly pass this information down without caring about the type of adjuster. BaseGizmos/ViewBasedTransformAdjusters.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FSubGizmoTransformAdjuster > AddTransformAdjuster ( UViewAdjustedStaticMeshGizmoComponent* ComponentIn,
USceneComponent* GizmoRootComponent,
bool bMirrorBasedOnOctant
)

 Static helper method to create and add this adjuster to a gizmo component for the common case of keeping a constant size gizmo. BaseGizmos/ViewBasedTransformAdjusters.h  

static TSharedPtr< FSubGizmoTransformAdjuster > AddTransformAdjuster ( UViewAdjustedStaticMeshGizmoComponent* ComponentIn,
USceneComponent* GizmoRootComponent,
TFunction< bool()> ShouldMirrorBasedOnOctant
)

   BaseGizmos/ViewBasedTransformAdjusters.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page