GizmoElementShared.h File Reference

#include "CoreTypes.h"
#include "GizmoElementShared.generated.h"

Go to the source code of this file.

Enumerations
enum class	EGizmoElementState : uint8 { None = 0x00 , Visible = 1<<1 , Hittable = 1<<2 , VisibleAndHittable = Visible | Hittable }
enum class	EGizmoElementInteractionState {   None , Hovering , Interacting , Selected ,   Subdued , Max }
enum class	EGizmoElementViewDependentType { None , Axis , Plane }
enum class	EGizmoElementViewAlignType {   None , PointOnly , PointEye , PointScreen ,   Axial }
enum class	EGizmoElementPartialType { None , Partial , PartialViewDependent }
enum class	EGizmoElementDrawType : uint8 { None = 0x00 , Fill = 1 << 1 , Line = 1 << 2 , FillAndLine = Fill | Line }
enum class	EGizmoElementHitSortType : uint8 { Closest = 1 << 0 , Priority = 1 << 1 , Surface = 1 << 2 , PriorityThenSurfaceThenClosest = Priority | Surface | Closest }

Functions
	USTRUCT (MinimalAPI, meta=(DisplayName="Per-State Value (Double)")) struct FGizmoPerStateValueDouble

Enumeration Type Documentation

EGizmoElementDrawType

enum class EGizmoElementDrawType : uint8

strong

Enumerator
None
Fill
Line
FillAndLine

EGizmoElementHitSortType

enum class EGizmoElementHitSortType : uint8

strong

Enumerator
Closest
Priority
Surface
PriorityThenSurfaceThenClosest

EGizmoElementInteractionState

enum class EGizmoElementInteractionState

strong

Enumerator
None
Hovering
Interacting
Selected
Subdued
Max

EGizmoElementPartialType

enum class EGizmoElementPartialType

strong

Enumerator
None
Partial
PartialViewDependent

EGizmoElementState

enum class EGizmoElementState : uint8

strong

Enumerator
None
Visible
Hittable
VisibleAndHittable

EGizmoElementViewAlignType

enum class EGizmoElementViewAlignType

strong

Enumerator
None
PointOnly
PointEye
PointScreen
Axial

EGizmoElementViewDependentType

enum class EGizmoElementViewDependentType

strong

Enumerator
None
Axis
Plane

Function Documentation

USTRUCT()

USTRUCT	(	MinimalAPI	,
		meta	= (DisplayName = "Per-State Value (Double)")
	)

Used to store per-state (double) values for gizmo elements. ie. line thickness multipliers.

Used to store per-state (Linear Color) values for gizmo elements. ie. vertex color.

Default value, used when the Interaction State is "None". Optional to allow explicit un-setting, implying inheritance or some other value source.

Value used when hovering.

Value used when interacting.

Value used when selected.

Value used when subdued.

Get the value for the given Interaction State, or Default if not set.

Get the Default value if set, otherwise "ValueDefault"

Get the Hover value, or Default if not set.

Get the Interact value, or Default if not set.

Get the Select value, or Default if not set.

Get the Subdue value, or Default if not set.

Default value, used when the Interaction State is "None". Optional to allow explicit un-setting, implying inheritance or some other value source.

Value used when hovering.

Value used when interacting.

Value used when selected.

Value used when subdued.

Get the value for the given Interaction State, or Default if not set.

Get the Default value if set, otherwise FLinearColor::Transparent.

Get the Hover value, or Default if not set.

Get the Interact value, or Default if not set.

Get the Select value, or Default if not set.

Get the Subdue value, or Default if not set.