1. Epic GamesDeveloper
  3. FWidgetStateBitfield

FWidgetStateBitfield

Expensive to create wrapper for binary and enumerated widget states that supports FName-based interaction and dynamic states populated in an IWidgetStateNameMapper May be used to represent either a target widget state combination, or an actual widgets state

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Binding > API/Runtime/UMG/Binding/States

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Binding/States/WidgetStateBitfield.h
Include #include "Binding/States/WidgetStateBitfield.h"

Syntax

struct FWidgetStateBitfield

Remarks

Expensive to create wrapper for binary and enumerated widget states that supports FName-based interaction and dynamic states populated in an IWidgetStateNameMapper May be used to represent either a target widget state combination, or an actual widgets state

All this does is cache the integer results of dynamic FName state lookup from an IWidgetStateNameMapper So it's prefertable to create these once and reuse. In particular, if broadcasting current state determine the correct bitfield to modify the existing state ahead of time. Save that bitfield and use it when performing state-modifications. Likewise when performing state tests, try to construct the relevant bitfield ahead of time & store that to later be compared against

Constructors

  Type Name Description
Public function   Default, will convert to false as a bool
Public function  

FWidgetStateBitfield ( const FName InStateName
)

 Interprets name as binary state on
Public function  

FWidgetStateBitfield ( const FName InStateName,
const uint8 InValue
)

 Interprets name value pair as enum state

Functions

  Type Name Description
Public function void

ClearEnumState ( const FWidgetStateBitfield& EnumStateBitfield
)

 Clear all existing values for given states & mark the states unused
Public function void

ClearEnumState ( FName EnumStateName
)

 Clear all existing values for given state & mark the state unused, slow version w/ map lookup
Public function void

ClearEnumState ( uint8 EnumStateIndex
)

 Clear all existing values for given state & mark the state unused
Public function Const bool

HasAllBinaryFlags ( const FWidgetStateBitfield& InBitfield
)

 True if all binary state flags are met
Public function Const bool

HasAllEnumFlags ( const FWidgetStateBitfield& InBitfield
)

 True if all enum state flags are met
Public function Const bool

HasAllFlags ( const FWidgetStateBitfield& InBitfield
)

 True if all state flags are met
Public function Const bool

HasAnyBinaryFlags ( const FWidgetStateBitfield& InBitfield
)

 True if any binary state flag is met
Public function Const bool

HasAnyEnumFlags ( const FWidgetStateBitfield& InBitfield
)

 True if any enum state flag is met
Public function Const bool

HasAnyFlags ( const FWidgetStateBitfield& InBitfield
)

 Note: No need for HasNoFlags. Simply call !HasAnyFlags.True if any state flag is met
Public function Const bool True if any binary state is set
Public function Const bool True if any enum used enum states are empty, usually indicating a failed '&' test
Public function Const bool True if any enum state is used, does not indicate if state is actually set.
Public function Const FWidgetStateBitfield Intersection of binary and enum states, with union on enum state usage so enum state mismatches can fail Intersections will remove not allowed enum states, allowing for failure on bool conversion due to empty used states.
Public function void Negate only binary states
Public function void Negate only enum states, does not change usage, but marks existing values as not allowed
Public function void Negate both binary and enum states
Public function void

SetBinaryState ( uint8 BinaryStateIndex,
bool BinaryStateValue
)

 Set binary state to given value
Public function void

SetBinaryState ( const FWidgetStateBitfield& BinaryStateBitfield,
bool BinaryStateValue
)

 Set Binary state to given value, using a bitfield to indicate states that should be changed
Public function void

SetBinaryStateSlow ( FName BinaryStateName,
bool BinaryStateValue
)

 Set Binary state to given value, slow version w/ FName map lookup
Public function void

SetEnumState ( const FWidgetStateBitfield& EnumStateBitfield
)

 Set enum state to given value, clearing all existing values for states in use
Public function void

SetEnumState ( uint8 EnumStateIndex,
uint8 EnumStateValue
)

 Set enum state to given value, clearing all existing values for that state
Public function void

SetEnumStateSlow ( FName EnumStateName,
uint8 EnumStateValue
)

 Set enum state to given value, clearing all existing values for that state, slow version w/ FName map lookup
Public function void

SetState ( const FWidgetStateBitfield& InBitfield
)

 Set state to given value, just calls assignment operator for you
Public function Const FWidgetStateBitfield

Union ( const FWidgetStateBitfield& Rhs
)

 Union of binary and enum states, allows for a single enum state to have multiple values in a bitfield.

Operators

  Type Name Description
Public function Const   True if any binary or enum state is set, and no empty used enum states exist
Public function Const FWidgetStateBitfield Negation of binary and enum states, maintains enum state usage, but marks states as not allowed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page