UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FColorList Class Reference

#include <ColorList.h>

Public Types

typedef TMap< FString, const FColor * > TColorsMap
 
typedef TArray< const FColor * > TColorsLookup
 

Public Member Functions

CORE_API void CreateColorMap ()
 
CORE_API const FColor & GetFColorByName (const TCHAR *ColorName) const
 
CORE_API const FLinearColor GetFLinearColorByName (const TCHAR *ColorName) const
 
CORE_API bool IsValidColorName (const TCHAR *ColorName) const
 
CORE_API int32 GetColorIndex (const TCHAR *ColorName) const
 
CORE_API const FColor & GetFColorByIndex (int32 ColorIndex) const
 
CORE_API const FString & GetColorNameByIndex (int32 ColorIndex) const
 
int32 GetColorsNum () const
 
CORE_API void LogColors ()
 

Static Public Attributes

static CORE_API const FColor White
 
static CORE_API const FColor Red
 
static CORE_API const FColor Green
 
static CORE_API const FColor Blue
 
static CORE_API const FColor Magenta
 
static CORE_API const FColor Cyan
 
static CORE_API const FColor Yellow
 
static CORE_API const FColor Black
 
static CORE_API const FColor Aquamarine
 
static CORE_API const FColor BakerChocolate
 
static CORE_API const FColor BlueViolet
 
static CORE_API const FColor Brass
 
static CORE_API const FColor BrightGold
 
static CORE_API const FColor Brown
 
static CORE_API const FColor Bronze
 
static CORE_API const FColor BronzeII
 
static CORE_API const FColor CadetBlue
 
static CORE_API const FColor CoolCopper
 
static CORE_API const FColor Copper
 
static CORE_API const FColor Coral
 
static CORE_API const FColor CornFlowerBlue
 
static CORE_API const FColor DarkBrown
 
static CORE_API const FColor DarkGreen
 
static CORE_API const FColor DarkGreenCopper
 
static CORE_API const FColor DarkOliveGreen
 
static CORE_API const FColor DarkOrchid
 
static CORE_API const FColor DarkPurple
 
static CORE_API const FColor DarkSlateBlue
 
static CORE_API const FColor DarkSlateGrey
 
static CORE_API const FColor DarkTan
 
static CORE_API const FColor DarkTurquoise
 
static CORE_API const FColor DarkWood
 
static CORE_API const FColor DimGrey
 
static CORE_API const FColor DustyRose
 
static CORE_API const FColor Feldspar
 
static CORE_API const FColor Firebrick
 
static CORE_API const FColor ForestGreen
 
static CORE_API const FColor Gold
 
static CORE_API const FColor Goldenrod
 
static CORE_API const FColor Grey
 
static CORE_API const FColor GreenCopper
 
static CORE_API const FColor GreenYellow
 
static CORE_API const FColor HunterGreen
 
static CORE_API const FColor IndianRed
 
static CORE_API const FColor Khaki
 
static CORE_API const FColor LightBlue
 
static CORE_API const FColor LightGrey
 
static CORE_API const FColor LightSteelBlue
 
static CORE_API const FColor LightWood
 
static CORE_API const FColor LimeGreen
 
static CORE_API const FColor MandarianOrange
 
static CORE_API const FColor Maroon
 
static CORE_API const FColor MediumAquamarine
 
static CORE_API const FColor MediumBlue
 
static CORE_API const FColor MediumForestGreen
 
static CORE_API const FColor MediumGoldenrod
 
static CORE_API const FColor MediumOrchid
 
static CORE_API const FColor MediumSeaGreen
 
static CORE_API const FColor MediumSlateBlue
 
static CORE_API const FColor MediumSpringGreen
 
static CORE_API const FColor MediumTurquoise
 
static CORE_API const FColor MediumVioletRed
 
static CORE_API const FColor MediumWood
 
static CORE_API const FColor MidnightBlue
 
static CORE_API const FColor NavyBlue
 
static CORE_API const FColor NeonBlue
 
static CORE_API const FColor NeonPink
 
static CORE_API const FColor NewMidnightBlue
 
static CORE_API const FColor NewTan
 
static CORE_API const FColor OldGold
 
static CORE_API const FColor Orange
 
static CORE_API const FColor OrangeRed
 
static CORE_API const FColor Orchid
 
static CORE_API const FColor PaleGreen
 
static CORE_API const FColor Pink
 
static CORE_API const FColor Plum
 
static CORE_API const FColor Quartz
 
static CORE_API const FColor RichBlue
 
static CORE_API const FColor Salmon
 
static CORE_API const FColor Scarlet
 
static CORE_API const FColor SeaGreen
 
static CORE_API const FColor SemiSweetChocolate
 
static CORE_API const FColor Sienna
 
static CORE_API const FColor Silver
 
static CORE_API const FColor SkyBlue
 
static CORE_API const FColor SlateBlue
 
static CORE_API const FColor SpicyPink
 
static CORE_API const FColor SpringGreen
 
static CORE_API const FColor SteelBlue
 
static CORE_API const FColor SummerSky
 
static CORE_API const FColor Tan
 
static CORE_API const FColor Thistle
 
static CORE_API const FColor Turquoise
 
static CORE_API const FColor VeryDarkBrown
 
static CORE_API const FColor VeryLightGrey
 
static CORE_API const FColor Violet
 
static CORE_API const FColor VioletRed
 
static CORE_API const FColor Wheat
 
static CORE_API const FColor YellowGreen
 

Protected Member Functions

CORE_API void InitializeColor (const TCHAR *ColorName, const FColor *ColorPtr, int32 &CurrentIndex)
 

Protected Attributes

TColorsMap ColorsMap
 
TColorsLookup ColorsLookup
 

Member Typedef Documentation

◆ TColorsLookup

typedef TArray< const FColor* > FColorList::TColorsLookup

◆ TColorsMap

typedef TMap< FString, const FColor* > FColorList::TColorsMap

Member Function Documentation

◆ CreateColorMap()

void FColorList::CreateColorMap ( )

Initializes list of common colors.

◆ GetColorIndex()

int32 FColorList::GetColorIndex ( const TCHAR *  ColorName) const

Returns index of color based on ColorName. If not found returns 0.

◆ GetColorNameByIndex()

const FString & FColorList::GetColorNameByIndex ( int32  ColorIndex) const

Returns color's name based on index. If index is invalid, returns BadIndex.

◆ GetColorsNum()

int32 FColorList::GetColorsNum ( ) const
inline

Returns the number of colors.

◆ GetFColorByIndex()

const FColor & FColorList::GetFColorByIndex ( int32  ColorIndex) const

Returns a color based on index. If index is invalid, returns White.

◆ GetFColorByName()

const FColor & FColorList::GetFColorByName ( const TCHAR *  ColorName) const

Returns a color based on ColorName. If not found, returns White.

◆ GetFLinearColorByName()

const FLinearColor FColorList::GetFLinearColorByName ( const TCHAR *  ColorName) const

Returns a linear color based on ColorName. If not found, returns White.

◆ InitializeColor()

void FColorList::InitializeColor ( const TCHAR *  ColorName,
const FColor *  ColorPtr,
int32 &  CurrentIndex 
)
protected

◆ IsValidColorName()

bool FColorList::IsValidColorName ( const TCHAR *  ColorName) const

Returns true if color is valid common colors. If not found returns false.

◆ LogColors()

void FColorList::LogColors ( )

Prints to log all colors information.

Member Data Documentation

◆ Aquamarine

const FColor FColorList::Aquamarine
static

◆ BakerChocolate

const FColor FColorList::BakerChocolate
static

◆ Black

const FColor FColorList::Black
static

◆ Blue

const FColor FColorList::Blue
static

◆ BlueViolet

const FColor FColorList::BlueViolet
static

◆ Brass

const FColor FColorList::Brass
static

◆ BrightGold

const FColor FColorList::BrightGold
static

◆ Bronze

const FColor FColorList::Bronze
static

◆ BronzeII

const FColor FColorList::BronzeII
static

◆ Brown

const FColor FColorList::Brown
static

◆ CadetBlue

const FColor FColorList::CadetBlue
static

◆ ColorsLookup

TColorsLookup FColorList::ColorsLookup
protected

Array of colors for fast lookup when using index.

◆ ColorsMap

TColorsMap FColorList::ColorsMap
protected

List of common colors.

◆ CoolCopper

const FColor FColorList::CoolCopper
static

◆ Copper

const FColor FColorList::Copper
static

◆ Coral

const FColor FColorList::Coral
static

◆ CornFlowerBlue

const FColor FColorList::CornFlowerBlue
static

◆ Cyan

const FColor FColorList::Cyan
static

◆ DarkBrown

const FColor FColorList::DarkBrown
static

◆ DarkGreen

const FColor FColorList::DarkGreen
static

◆ DarkGreenCopper

const FColor FColorList::DarkGreenCopper
static

◆ DarkOliveGreen

const FColor FColorList::DarkOliveGreen
static

◆ DarkOrchid

const FColor FColorList::DarkOrchid
static

◆ DarkPurple

const FColor FColorList::DarkPurple
static

◆ DarkSlateBlue

const FColor FColorList::DarkSlateBlue
static

◆ DarkSlateGrey

const FColor FColorList::DarkSlateGrey
static

◆ DarkTan

const FColor FColorList::DarkTan
static

◆ DarkTurquoise

const FColor FColorList::DarkTurquoise
static

◆ DarkWood

const FColor FColorList::DarkWood
static

◆ DimGrey

const FColor FColorList::DimGrey
static

◆ DustyRose

const FColor FColorList::DustyRose
static

◆ Feldspar

const FColor FColorList::Feldspar
static

◆ Firebrick

const FColor FColorList::Firebrick
static

◆ ForestGreen

const FColor FColorList::ForestGreen
static

◆ Gold

const FColor FColorList::Gold
static

◆ Goldenrod

const FColor FColorList::Goldenrod
static

◆ Green

const FColor FColorList::Green
static

◆ GreenCopper

const FColor FColorList::GreenCopper
static

◆ GreenYellow

const FColor FColorList::GreenYellow
static

◆ Grey

const FColor FColorList::Grey
static

◆ HunterGreen

const FColor FColorList::HunterGreen
static

◆ IndianRed

const FColor FColorList::IndianRed
static

◆ Khaki

const FColor FColorList::Khaki
static

◆ LightBlue

const FColor FColorList::LightBlue
static

◆ LightGrey

const FColor FColorList::LightGrey
static

◆ LightSteelBlue

const FColor FColorList::LightSteelBlue
static

◆ LightWood

const FColor FColorList::LightWood
static

◆ LimeGreen

const FColor FColorList::LimeGreen
static

◆ Magenta

const FColor FColorList::Magenta
static

◆ MandarianOrange

const FColor FColorList::MandarianOrange
static

◆ Maroon

const FColor FColorList::Maroon
static

◆ MediumAquamarine

const FColor FColorList::MediumAquamarine
static

◆ MediumBlue

const FColor FColorList::MediumBlue
static

◆ MediumForestGreen

const FColor FColorList::MediumForestGreen
static

◆ MediumGoldenrod

const FColor FColorList::MediumGoldenrod
static

◆ MediumOrchid

const FColor FColorList::MediumOrchid
static

◆ MediumSeaGreen

const FColor FColorList::MediumSeaGreen
static

◆ MediumSlateBlue

const FColor FColorList::MediumSlateBlue
static

◆ MediumSpringGreen

const FColor FColorList::MediumSpringGreen
static

◆ MediumTurquoise

const FColor FColorList::MediumTurquoise
static

◆ MediumVioletRed

const FColor FColorList::MediumVioletRed
static

◆ MediumWood

const FColor FColorList::MediumWood
static

◆ MidnightBlue

const FColor FColorList::MidnightBlue
static

◆ NavyBlue

const FColor FColorList::NavyBlue
static

◆ NeonBlue

const FColor FColorList::NeonBlue
static

◆ NeonPink

const FColor FColorList::NeonPink
static

◆ NewMidnightBlue

const FColor FColorList::NewMidnightBlue
static

◆ NewTan

const FColor FColorList::NewTan
static

◆ OldGold

const FColor FColorList::OldGold
static

◆ Orange

const FColor FColorList::Orange
static

◆ OrangeRed

const FColor FColorList::OrangeRed
static

◆ Orchid

const FColor FColorList::Orchid
static

◆ PaleGreen

const FColor FColorList::PaleGreen
static

◆ Pink

const FColor FColorList::Pink
static

◆ Plum

const FColor FColorList::Plum
static

◆ Quartz

const FColor FColorList::Quartz
static

◆ Red

const FColor FColorList::Red
static

◆ RichBlue

const FColor FColorList::RichBlue
static

◆ Salmon

const FColor FColorList::Salmon
static

◆ Scarlet

const FColor FColorList::Scarlet
static

◆ SeaGreen

const FColor FColorList::SeaGreen
static

◆ SemiSweetChocolate

const FColor FColorList::SemiSweetChocolate
static

◆ Sienna

const FColor FColorList::Sienna
static

◆ Silver

const FColor FColorList::Silver
static

◆ SkyBlue

const FColor FColorList::SkyBlue
static

◆ SlateBlue

const FColor FColorList::SlateBlue
static

◆ SpicyPink

const FColor FColorList::SpicyPink
static

◆ SpringGreen

const FColor FColorList::SpringGreen
static

◆ SteelBlue

const FColor FColorList::SteelBlue
static

◆ SummerSky

const FColor FColorList::SummerSky
static

◆ Tan

const FColor FColorList::Tan
static

◆ Thistle

const FColor FColorList::Thistle
static

◆ Turquoise

const FColor FColorList::Turquoise
static

◆ VeryDarkBrown

const FColor FColorList::VeryDarkBrown
static

◆ VeryLightGrey

const FColor FColorList::VeryLightGrey
static

◆ Violet

const FColor FColorList::Violet
static

◆ VioletRed

const FColor FColorList::VioletRed
static

◆ Wheat

const FColor FColorList::Wheat
static

◆ White

const FColor FColorList::White
static

◆ Yellow

const FColor FColorList::Yellow
static

◆ YellowGreen

const FColor FColorList::YellowGreen
static
The documentation for this class was generated from the following files: