1. Epic GamesDeveloper
  3. UGizmoHandleGroup

UGizmoHandleGroup

Base class for gizmo handles

Unreal Engine C++ API Reference > Editor > ViewportInteraction

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract)  
class UGizmoHandleGroup : public USceneComponent

Remarks

Base class for gizmo handles

Variables

  Type Name Description
Protected variable UProperty TObjectPtr< class UViewportDragOperationComponent > DragOperationComponent  
Protected variable UProperty TObjectPtr< UMaterialInterface > GizmoMaterial Gizmo material (opaque)
Protected variable UProperty TArray< FGizmoHandle > Handles All the StaticMeshes for this handle type
Protected variable UProperty TObjectPtr< class ABaseTransformGizmo > OwningTransformGizmoActor The actor transform gizmo owning this handlegroup
Protected variable UProperty TObjectPtr< UMaterialInterface > TranslucentGizmoMaterial Gizmo material (translucent)

Constructors

  Type Name Description
Public function   Default constructor that sets up CDO properties

Functions

  Type Name Description
Protected function void

AddMeshToHandles ( UGizmoHandleMeshComponent* HandleMeshComponent,
const FTransformGizmoHandlePlacement& HandlePlacement
)

 Adds the HandleMeshComponent to the Handles list
Protected function UGizmoHandleMeshComponent *

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

 Creates handle meshcomponent and adds it to the Handles list
Protected function UGizmoHandleMeshComponent *

CreateMeshHandle ( UStaticMesh* HandleMesh,
const FString& ComponentName
)

 Helper function to create gizmo handle meshes
Public function 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
Public function Virtual int32

GetDraggedHandleIndex ( UStaticMeshComponent* DraggedMesh
)

 Finds the index of DraggedMesh in HandleMeshes
Public function UViewportDragOperationComponent *  
Protected function Const FTransformGizmoHandlePlacement

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

 Gets the handleplacement axes
Public function TArray< FGizmoHandle > & Gets all the handles
Public function Virtual Const EGizmoHandleTypes Gets the GizmoType for this Gizmo handle
Public function Const bool Gets if this handlegroup will be visible with the universal gizmo
Public function Const int32 Makes a unique index for a handle
Public function Const FString Makes up a name string for a handle
Public function Const FTransformGizmoHandlePlacement

MakeHandlePlacementForIndex ( const int32 HandleIndex
)

 Given the unique index, makes a handle
Public function void

SetGizmoMaterial ( UMaterialInterface* Material
)

 Sets the Gizmo material
Public function void Sets the owning transform gizmo for this handle group
Public function void

SetShowOnUniversalGizmo ( const bool bShowHandleUniversal
)

 Sets if this handlegroup will be visible with the universal gizmo
Public function void

SetTranslucentGizmoMaterial ( UMaterialInterface* Material
)

 Sets the translucent Gizmo material
Public function Virtual Const bool Returns true if this type of handle is allowed with world space gizmos
Public function 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
Protected function 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
Public function 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page