Cesium for Unreal 2.15.0
Loading...
Searching...
No Matches
FCesiumMetadataEnum Struct Reference

Stores information on the values of an enum and the corresponding names of those values. More...

#include <CesiumMetadataEnum.h>

Public Member Functions

 FCesiumMetadataEnum ()
 Constructs an empty enum definition with no values.
 
 FCesiumMetadataEnum (const CesiumGltf::Enum &Enum)
 Constructs an enum definition from a CesiumGltf::Enum.
 
 FCesiumMetadataEnum (const UEnum *UnrealEnum)
 Constructs an enum definition from an Unreal UENUM type.
 
TOptional< FString > GetName (int64_t Value) const
 Attempts to return the name of a given value from this enum definition, returning the name if the value was found or an empty optional if not.
 

Detailed Description

Stores information on the values of an enum and the corresponding names of those values.

Definition at line 20 of file CesiumMetadataEnum.h.

Constructor & Destructor Documentation

◆ FCesiumMetadataEnum() [1/3]

FCesiumMetadataEnum::FCesiumMetadataEnum ( )
inline

Constructs an empty enum definition with no values.

Definition at line 27 of file CesiumMetadataEnum.h.

◆ FCesiumMetadataEnum() [2/3]

FCesiumMetadataEnum::FCesiumMetadataEnum ( const CesiumGltf::Enum & Enum)

Constructs an enum definition from a CesiumGltf::Enum.

◆ FCesiumMetadataEnum() [3/3]

FCesiumMetadataEnum::FCesiumMetadataEnum ( const UEnum * UnrealEnum)

Constructs an enum definition from an Unreal UENUM type.

This can be useful when creating FCesiumMetadataValue items directly from code, to avoid having to create a CesiumGltf::Enum from scratch to create this enum definition from. It can also be useful for testing purposes.

To call this method with an Unreal UENUM from C++, you can use the StaticEnum method like so:

FCesiumMetadataEnum enumDefinition(StaticEnum<EExampleEnumType>());
FCesiumMetadataEnum()
Constructs an empty enum definition with no values.

Member Function Documentation

◆ GetName()

TOptional< FString > FCesiumMetadataEnum::GetName ( int64_t Value) const

Attempts to return the name of a given value from this enum definition, returning the name if the value was found or an empty optional if not.

Parameters
ValueThe value to lookup in this enum definition.

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