UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FToolContextOptionalToggle Struct Reference

#include <CombinedTransformGizmo.h>

Public Member Functions

 FToolContextOptionalToggle ()
 
 FToolContextOptionalToggle (bool bEnabled, bool bSetInheritFromContext)
 
void UpdateContextValue (bool bNewValue)
 
bool InheritFromContext () const
 
bool IsEnabled () const
 

Public Attributes

bool bEnabledDirectly = false
 
bool bEnabledInContext = false
 
bool bInheritFromContext = false
 

Detailed Description

FToolContextOptionalToggle is used to store a boolean flag where the value of the boolean may either be set directly, or it may be set by querying some external context. This struct does not directly do anything, it just wraps up the multiple flags/states needed to provide such functionality

Constructor & Destructor Documentation

◆ FToolContextOptionalToggle() [1/2]

FToolContextOptionalToggle::FToolContextOptionalToggle ( )
inline

◆ FToolContextOptionalToggle() [2/2]

FToolContextOptionalToggle::FToolContextOptionalToggle ( bool  bEnabled,
bool  bSetInheritFromContext 
)
inline

Member Function Documentation

◆ InheritFromContext()

bool FToolContextOptionalToggle::InheritFromContext ( ) const
inline

◆ IsEnabled()

bool FToolContextOptionalToggle::IsEnabled ( ) const
inline
Returns
true if Toggle is currently set to Enabled/On, under the current configuration

◆ UpdateContextValue()

void FToolContextOptionalToggle::UpdateContextValue ( bool  bNewValue)
inline

Member Data Documentation

◆ bEnabledDirectly

bool FToolContextOptionalToggle::bEnabledDirectly = false

◆ bEnabledInContext

bool FToolContextOptionalToggle::bEnabledInContext = false

◆ bInheritFromContext

bool FToolContextOptionalToggle::bInheritFromContext = false

The documentation for this struct was generated from the following file: