Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > ViewportInteraction > UGizmoHandleGroup

Light Theme

Dark Theme

UGizmoHandleGroup

Base class for gizmo handles

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UGizmoHandleGroup

UAxisGizmoHandleGroup

References

Module	ViewportInteraction
Header	/Engine/Source/Editor/ViewportInteraction/Public/VIGizmoHandle.h
Include	#include "VIGizmoHandle.h"

Syntax

class UGizmoHandleGroup : public USceneComponent

Remarks

Base class for gizmo handles

Variables

	Name	Description
UViewportDragOp...	DragOperationComponent
UMaterialInterf...	GizmoMaterial	Gizmo material (opaque)
TArray< FGizmoH...	Handles	All the StaticMeshes for this handle type
ABaseTransformG...	OwningTransformGizmoActor	The actor transform gizmo owning this handlegroup
UMaterialInterf...	TranslucentGizmoMaterial	Gizmo material (translucent)

Constructors

	Name	Description
	UGizmoHandleGroup()	Default constructor that sets up CDO properties

Functions

	Name	Description
void	AddMeshToHandles ( UGizmoHandleMeshComponent* Han..., const FTransformGizmoHandlePlacemen... )	Adds the HandleMeshComponent to the Handles list
UGizmoHandle...	CreateAndAddMeshHandle ( UStaticMesh* HandleMesh, const FString& ComponentName, const FTransformGizmoHandlePlacemen... )	Creates handle meshcomponent and adds it to the Handles list
UGizmoHandle...	CreateMeshHandle ( UStaticMesh* HandleMesh, const FString& ComponentName )	Helper function to create gizmo handle meshes
FVector	GetAxisVector ( const int32 AxisIndex, const ETransformGizmoHandleDirectio... )	Static: Given an axis (0-2) and a facing direction, returns the vector normal for that axis
int32	GetDraggedHandleIndex ( UStaticMeshComponent* DraggedM... )	Finds the index of DraggedMesh in HandleMeshes
UViewportDra...	GetDragOperationComponent()
FTransformGi...	GetHandlePlacement ( const int32 X, const int32 Y, const int32 Z )	Gets the handleplacement axes
TArray< FGiz...	GetHandles()	Gets all the handles
EGizmoHandle...	GetHandleType()	Gets the GizmoType for this Gizmo handle
bool	GetShowOnUniversalGizmo()	Gets if this handlegroup will be visible with the universal gizmo
int32	MakeHandleIndex ( const FTransformGizmoHandlePlacemen... )	Makes a unique index for a handle
FString	MakeHandleName ( const FTransformGizmoHandlePlacemen... )	Makes up a name string for a handle
FTransformGi...	MakeHandlePlacementForIndex ( const int32 HandleIndex )	Given the unique index, makes a handle
void	SetGizmoMaterial ( UMaterialInterface* Material )	Sets the Gizmo material
void	SetOwningTransformGizmo ( ABaseTransformGizmo* Transform... )	Sets the owning transform gizmo for this handle group
void	SetShowOnUniversalGizmo ( const bool bShowHandleUniversal )	Sets if this handlegroup will be visible with the universal gizmo
void	SetTranslucentGizmoMaterial ( UMaterialInterface* Material )	Sets the translucent Gizmo material
bool	SupportsWorldCoordinateSpace()	Returns true if this type of handle is allowed with world space gizmos
void	UpdateGizmoHandleGroup ( const FTransform& LocalToWorld, const FBox& LocalBounds, const FVector ViewLocation, const bool bAllHandlesVisible, UActorComponent* DraggingHandl..., const TArray< UActorComponent*..., float AnimationAlpha, float GizmoScale, const float GizmoHoverScale, const float GizmoHoverAnimationDura..., bool& bOutIsHoveringOrDraggingThis... )	Updates the Gizmo handles, needs to be implemented by derived classes
void	UpdateHandleColor ( const int32 AxisIndex, FGizmoHandle& Handle, UActorComponent* DraggingHandl..., const TArray< UActorComponent*... )	Updates the colors of the dynamic material instances for the handle passed using its axis index
void	UpdateVisibilityAndCollision ( const EGizmoHandleTypes GizmoType, const ECoordSystem GizmoCoordinateS..., const bool bAllHandlesVisible, const bool bAllowRotationAndScaleHa..., UActorComponent* DraggingHandl... )	Default setting the visibility and collision for all the handles in this group

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss