![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include <TypeBitSetBuilder.h>
Inheritance diagram for TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >:Public Types | |
| using | Super = TTypeBitSetBase< TTypeBitSetBuilder, TBaseStruct, TUStructType, TContainer &, bTestInheritanceAtRuntime > |
| using | FUStructType = TUStructType |
| using | FBaseStruct = TBaseStruct |
| using | FTraits = TTypeBitSetTraits< TBaseStruct > |
| using | FConstBitSet = const FBitSet |
Public Types inherited from TTypeBitSetBase< TImplementation, TBaseStruct, TStructType, TBitSetContainer, bTestInheritanceAtRuntime > | |
| using | FUStructType = TStructType |
| using | FBaseStruct = TBaseStruct |
| using | FContainer = TBitSetContainer |
Static Public Member Functions | |
| static int32 | GetTypeIndex (const FStructTracker &InStructTracker, const TUStructType &InStructType) |
| template<typename T > | |
| static int32 | GetTypeIndex (FStructTracker &InStructTracker) |
| template<typename T > | |
| static TTypeBitSetBuilder | GetTypeBitSet (const TUStructType &InStructType) |
| static int32 | GetMaxNum (const FStructTracker &StructTracker) |
| static const UStruct * | GetBaseUStruct () |
Static Public Member Functions inherited from TTypeBitSetBase< TImplementation, TBaseStruct, TStructType, TBitSetContainer, bTestInheritanceAtRuntime > | |
| static const UStruct * | GetBaseUStruct () |
Public Attributes | |
| friend | Super |
| FContainer | StructTypesBitArray |
Protected Member Functions | |
| FStructTracker & | GetStructTracker () const |
Protected Member Functions inherited from TTypeBitSetBase< TImplementation, TBaseStruct, TStructType, TBitSetContainer, bTestInheritanceAtRuntime > | |
| TTypeBitSetBase ()=default | |
| TTypeBitSetBase (FContainer &InContainer) | |
Additional Inherited Members | |
Protected Attributes inherited from TTypeBitSetBase< TImplementation, TBaseStruct, TStructType, TBitSetContainer, bTestInheritanceAtRuntime > | |
| FContainer | StructTypesBitArray |
TTypeBitSetBuilder is a template class for building and managing type-specific bitsets. It extends TTypeBitSetBase to provide functionalities specific to bitset building.
| TBaseStruct | the base struct type that all stored types must derive from. |
| TUStructType | Unreal's struct type, typically UScriptStruct or UClass. |
| bTestInheritanceAtRuntime | flag to enable runtime inheritance checks. |
| TContainer | the container type for storing bitsets (default is FStructTypeBitSet::FBitSetContainer). |
| using TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::FBaseStruct = TBaseStruct |
Alias for the base struct type
| using TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::FConstBitSet = const FBitSet |
Alias for a const bitset, this is the type to use to represent the stored bit set
| using TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::FTraits = TTypeBitSetTraits<TBaseStruct> |
Traits for compile-time checks
| using TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::FUStructType = TUStructType |
Alias for Unreal's struct type
| using TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::Super = TTypeBitSetBase<TTypeBitSetBuilder, TBaseStruct, TUStructType, TContainer&, bTestInheritanceAtRuntime> |
Define the base class for easier reference
|
inline |
Constructor that initializes the builder with a struct tracker and a source bitset.
| InStructTracker | he struct tracker to use. |
| Source | the source bitset to initialize from. |
|
inline |
Template method to add a struct type to the bitset.
| T | the C++ type to add. |
|
inline |
Adds a struct type to the bitset.
| InStructType | - The struct type to add. |
|
inline |
Template method to check if a struct type is contained in the bitset.
| T | the C++ type to check. |
|
inline |
Checks if the bitset contains a specific struct type.
| InStructType | - The struct type to check for. |
|
inline |
Counts the number of set bits in the bitset.
|
inline |
Provides a debug string description of the bitset contents.
|
inline |
Exports types stored in the bitset to an output array. Note: This method can be slow due to the use of weak pointers in the struct tracker.
| OutTypes | - The array to populate with struct types. |
|
inline |
Exports the types stored in the bitset to an output array. Note: This method can be slow due to the use of weak pointers in the struct tracker.
| TOutStructType | the output struct type. |
| Allocator | the allocator for the output array. |
| OutTypes | the array to populate with struct types. |
|
inline |
Lists all types used by this bitset, calling the provided callback for each one. Returning false from the callback will early-out of iterating over the types. Note: This method can be slow due to the use of weak pointers in the struct tracker.
| Callback | the callback function to call for each type. |
|
inline |
Retrieves the allocated size of the bitset.
|
inlinestatic |
|
inline |
Retrieves the maximum number of types tracked by the struct tracker.
|
inlinestatic |
Static method to get the maximum number of types from a struct tracker.
| StructTracker | the struct tracker to query. |
|
inline |
Gets the overlap between this builder's bitset and another's.
| Other | the other builder. |
|
inlineprotected |
Retrieves the struct tracker used by this builder.
|
inline |
Retrieves the struct type at a given index from the struct tracker.
| Index | the index of the struct type. |
|
inlinestatic |
Template method to create a bitset for a specific C++ type.
| T | the C++ type. |
| InStructType | the Unreal struct type. |
|
inline |
Template method to get the type index for a specific C++ type. Ensures at compile-time that the type is valid.
| T | the C++ type to get the index for. |
|
inlinestatic |
Static method to get the type index for a given struct type.
| InStructTracker | the struct tracker to use. |
| InStructType | the struct type to get the index for. |
|
inline |
Retrieves the index of a struct type within the struct tracker. If the type is not registered, it will be added.
| InStructType | the struct type to get the index for. |
|
inlinestatic |
Template method to get the type index for a specific C++ type. Ensures at compile-time that the type is valid.
| T | the C++ type to get the index for. |
|
inline |
Checks if this builder's bitset has all bits set in another's.
| Other | the other builder. |
|
inline |
Checks if this builder's bitset has any bits set in another's.
| Other | the other builder. |
|
inline |
Checks if this builder's bitset has none of the bits set in another's.
| Other | the other builder. |
|
inline |
Checks if a specific bit is set in the bitset.
| BitIndex | the index of the bit to check. |
|
inline |
Checks if the bitset is empty.
|
inline |
Checks if this builder's bitset is equivalent to another's.
| Other | the other builder. |
|
inline |
Conversion operator to a const bitset.
|
inline |
Inequality operator to compare two builders.
| Other | the other builder to compare. |
|
inline |
Performs a bitwise AND with another builder's bitset.
| Other | the other builder. |
|
inline |
Adds a struct type to the bitset, returning a new bitset.
| NewElement | - The struct type to add. |
|
inline |
Adds another builder's bitset to this builder's bitset.
| Other | the other builder. |
|
inline |
Adds the bits from another bitset to this one (union).
| Other | - The other bitset to add. |
|
inline |
Removes a struct type from the bitset, returning a new bitset.
| NewElement | - The struct type to remove. |
|
inline |
Subtracts another builder's bitset from this builder's bitset.
| Other | the other builder. |
|
inline |
Removes the bits from another bitset from this one (difference).
| Other | - The other bitset to subtract. |
|
inline |
Assignment operator to copy the bitset from another builder. Ensures that both builders use the same struct tracker.
| Source | the other builder to copy from. |
|
inline |
Equality operator to compare two builders.
| Other | the other builder to compare. |
|
inline |
Performs a bitwise OR with another builder's bitset.
| Other | the other builder. |
|
inline |
Template method to remove a struct type from the bitset.
| T | the C++ type to remove. |
|
inline |
Removes a struct type from the bitset.
| InStructType | - The struct type to remove. |
|
inline |
Removes all bits set in another builder's bitset from this builder's bitset.
| Other | the other builder whose bits to remove. |
| FContainer TTypeBitSetBase< TImplementation, TBaseStruct, TStructType, TBitSetContainer, bTestInheritanceAtRuntime >::StructTypesBitArray |
Bring base class methods into scope
| friend TTypeBitSetBuilder< TBaseStruct, TUStructType, bTestInheritanceAtRuntime, TContainer >::Super |
Friend declaration to allow base class access