1. Epic GamesDeveloper
  3. UGizmoHandleGroup

UGizmoHandleGroup

Base class for gizmo handles

API > API/Editor > API/Editor/ViewportInteraction

Base class for gizmo handles

   
Name UGizmoHandleGroup
Type class
Header File /Engine/Source/Editor/ViewportInteraction/Public/VIGizmoHandle.h
Include Path #include "VIGizmoHandle.h"

Syntax

UCLASS (MinimalAPI, Abstract)  
class UGizmoHandleGroup : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UGizmoHandleGroup()

 Default constructor that sets up CDO properties VIGizmoHandle.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bShowOnUniversalGizmo bool If this handlegroup will be visible with the universal gizmo VIGizmoHandle.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual int32 GetDraggedHandleIndex ( UStaticMeshComponent* DraggedMesh
)

 Finds the index of DraggedMesh in HandleMeshes VIGizmoHandle.h  

UViewportDragOperationComponent * GetDragOperationComponent()

   VIGizmoHandle.h  

TArray< FGizmoHandle > & GetHandles()

 Gets all the handles VIGizmoHandle.h  

virtual EGizmoHandleTypes GetHandleType()

 Gets the GizmoType for this Gizmo handle VIGizmoHandle.h  

bool GetShowOnUniversalGizmo()

 Gets if this handlegroup will be visible with the universal gizmo VIGizmoHandle.h  

int32 MakeHandleIndex ( const FTransformGizmoHandlePlacement HandlePlacement
) const

 Makes a unique index for a handle VIGizmoHandle.h  

FString MakeHandleName ( const FTransformGizmoHandlePlacement HandlePlacement
) const

 Makes up a name string for a handle VIGizmoHandle.h  

FTransformGizmoHandlePlacement MakeHandlePlacementForIndex ( const int32 HandleIndex
) const

 Given the unique index, makes a handle VIGizmoHandle.h  

void SetGizmoMaterial ( UMaterialInterface* Material
)

 Sets the Gizmo material VIGizmoHandle.h  

void SetOwningTransformGizmo ( ABaseTransformGizmo* TransformGizmo
)

 Sets the owning transform gizmo for this handle group VIGizmoHandle.h  

void SetShowOnUniversalGizmo ( const bool bShowHandleUniversal
)

 Sets if this handlegroup will be visible with the universal gizmo VIGizmoHandle.h  

void SetTranslucentGizmoMaterial ( UMaterialInterface* Material
)

 Sets the translucent Gizmo material VIGizmoHandle.h  

virtual bool SupportsWorldCoordinateSpace()

 Returns true if this type of handle is allowed with world space gizmos VIGizmoHandle.h  

virtual void UpdateGizmoHandleGroup ( const FTransform& LocalToWorld,
const FBox& LocalBounds,
const FVector ViewLocation,
const bool bAllHandlesVisible,
UActorComponent* DraggingHandle,
const TArray< UActorComponent* >& HoveringOverHandles,
float AnimationAlpha,
float GizmoScale,
const float GizmoHoverScale,
const float GizmoHoverAnimationDuration,
bool& bOutIsHoveringOrDraggingThisHandleGroup
)

 Updates the Gizmo handles, needs to be implemented by derived classes VIGizmoHandle.h  

void UpdateVisibilityAndCollision ( const EGizmoHandleTypes GizmoType,
const ECoordSystem GizmoCoordinateSpace,
const bool bAllHandlesVisible,
const bool bAllowRotationAndScaleHandles,
UActorComponent* DraggingHandle
)

 Default setting the visibility and collision for all the handles in this group VIGizmoHandle.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddMeshToHandles ( UGizmoHandleMeshComponent* HandleMeshComponent,
const FTransformGizmoHandlePlacement& HandlePlacement
)

 Adds the HandleMeshComponent to the Handles list VIGizmoHandle.h  

UGizmoHandleMeshComponent * CreateAndAddMeshHandle ( UStaticMesh* HandleMesh,
const FString& ComponentName,
const FTransformGizmoHandlePlacement& HandlePlacement
)

 Creates handle meshcomponent and adds it to the Handles list VIGizmoHandle.h  

UGizmoHandleMeshComponent * CreateMeshHandle ( UStaticMesh* HandleMesh,
const FString& ComponentName
)

 Helper function to create gizmo handle meshes VIGizmoHandle.h  

FTransformGizmoHandlePlacement GetHandlePlacement ( const int32 X,
const int32 Y,
const int32 Z
) const

 Gets the handleplacement axes VIGizmoHandle.h  

void UpdateHandleColor ( const int32 AxisIndex,
FGizmoHandle& Handle,
UActorComponent* DraggingHandle,
const TArray< UActorComponent* >& HoveringOverHandles
)

 Updates the colors of the dynamic material instances for the handle passed using its axis index VIGizmoHandle.h  

Static

Name Remarks Include Path Unreal Specifiers

static FVector GetAxisVector ( const int32 AxisIndex,
const ETransformGizmoHandleDirection HandleDirection
)

 Static: Given an axis (0-2) and a facing direction, returns the vector normal for that axis VIGizmoHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page