FTransformGizmoStyle

Contains all styling properties for TransformGizmo.

API > API/Editor > API/Editor/EditorInteractiveToolsFramework

Contains all styling properties for TransformGizmo.

   
Name FTransformGizmoStyle
Type struct
Header File /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorGizmos/TransformGizmo.h
Include Path #include "EditorGizmos/TransformGizmo.h"

Syntax

USTRUCT (MinimalAPI)  
struct FTransformGizmoStyle

Constructors

Name Remarks Include Path Unreal Specifiers
  EditorGizmos/TransformGizmo.h  
  EditorGizmos/TransformGizmo.h  

Constants

Name Type Remarks Include Path
AxisColorX FLinearColor   EditorGizmos/TransformGizmo.h
AxisColorY FLinearColor   EditorGizmos/TransformGizmo.h
AxisColorZ FLinearColor   EditorGizmos/TransformGizmo.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AxisSizeMultiplier float Applies to axis lengths and radii. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.1f, DisplayPriority=1)
bUsePlatformCursorSize bool Synchronizes the cursor size to that specified for the platform/OS. If false, CursorSize is used. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
bUseShading bool Whether to show shading on the gizmo, or unlit (if false). EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
CurrentColor FLinearColor The current color to use. EditorGizmos/TransformGizmo.h
  • Meta=(HideAlphaChannel, DeprecatedProperty, DeprecationMessage="Use HoverColor instead.")
CursorSize float Defines the size of the custom cursor. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(EditCondition="!bUsePlatformCursorSize")
DeltaTextBackgroundColor FLinearColor Represents the background color for text labels. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
GreyColor FLinearColor   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(HideAlphaChannel)
HandleSizeMultiplier float Applies to arrow heads, planar and uniform handles. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.01f, DisplayPriority=1)
HoverColor FLinearColor The color to use on hover. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(HideAlphaChannel)
HoverLineThicknessMultiplier float   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.01f)
InteractColor FLinearColor The color to use on interact. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(HideAlphaChannel)
LineThicknessMultiplier float   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.01f)
MinimumPixelHitDistanceThreshold float Minimum pixel hit distance threshold. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.0f)
MinLineThickness float Used to prevent sub-pixel line sizes. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.01f)
PixelHitDistanceThreshold float Pixel hit distance threshold - where the default is generally 7px. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.1f)
PlanarAxisOffsetFromOrigin float Applies to both translate and scale planar handles. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(ClampMin=0.01f, DisplayPriority=1)
RotateStyle FGizmoElementRotateStyle   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Rotate"
  • Meta=(ShowOnlyInnerProperties, DisplayPriority=11)
ScaleStyle FGizmoElementScaleStyle   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Scale"
  • Meta=(ShowOnlyInnerProperties, DisplayPriority=12)
SelectColor FLinearColor The color to use on select. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(HideAlphaChannel)
ShadingAmbient float   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(EditCondition="bUseShading", ClampMin=0.0f, ClampMax=2.0f)
ShadingSpecularGlossiness float   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(EditCondition="bUseShading", ClampMin=0.0f, ClampMax=1.0f)
ShowFlags uint32 Sets the fixed visibility of various elements. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(Bitmask, BitmaskEnum="/Script/EditorInteractiveToolsFramework.ETransformGizmoShowFlags")
SubdueColor FLinearColor The color to use on subdue. Depending on the effect, we may only use the alpha value. EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
TranslateStyle FGizmoElementTranslateStyle   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Translate"
  • Meta=(ShowOnlyInnerProperties, DisplayPriority=10)
WhiteColor FLinearColor   EditorGizmos/TransformGizmo.h
  • EditAnywhere
  • Category="Shared"
  • Meta=(HideAlphaChannel)

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetModifiedAxisSizeMultiplier ( const TOptional< TUniqueFunction< float(const float)> >& InModifierOverride
) const

 Gets the AxisSizeMultiplier, modified by project/editor level settings, etc., or the given Modifier if specified. EditorGizmos/TransformGizmo.h  

void MakeValid()

 Clamps and otherwise corrects values within the style. EditorGizmos/TransformGizmo.h  

Operators

Name Remarks Include Path Unreal Specifiers
  EditorGizmos/TransformGizmo.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page