Global settings for CARLA. 更多...

#include <CarlaSettings.h>

类 UCarlaSettings 继承关系图:

UCarlaSettings 的协作图:

Public 成员函数
EQualityLevel	GetQualityLevel () const

void	LoadSettings ()
	Load the settings based on the command-line arguments and the INI file if provided.

void	LoadSettingsFromString (const FString &INIFileContents)
	Load the settings from the given string (formatted as INI).

void	LogSettings () const
	Log settings values.

void	SetQualityLevel (EQualityLevel InQualityLevel)
	Sets the new quality settings level and make changes in the game related to it.

Public 属性
CARLA Server
uint32	RPCPort = 2000u
	World port to listen for client connections.

uint32	StreamingPort = 2001u
	setting for the streaming port.

uint32	SecondaryPort = 2002u
	setting for the secondary servers port.

std::string	PrimaryIP = ""
	setting for the IP and Port of the primary server to connect.

uint32	PrimaryPort = 2002u

bool	bSynchronousMode = false
	In synchronous mode, CARLA waits every tick until the control from the client is received.

bool	bDisableRendering = false
	Enable or disable the viewport rendering of the world.

静态 Public 属性
static const FName	CARLA_ROAD_TAG = FName("CARLA_ROAD")
	CARLA_ROAD name to tag road mesh actors.

static const FName	CARLA_SKY_TAG = FName("CARLA_SKY")
	CARLA_SKY name to tag the sky sphere (BPS) actors in the scenes.

Private 成员函数
void	LoadSettingsFromFile (const FString &FilePath, bool bLogOnFailure)

Private 属性
FString	CurrentFileName
	File name of the settings file used to load this settings.

Quality Settings
EQualityLevel	QualityLevel = EQualityLevel::Epic
	Quality Settings level.

float	LowLightFadeDistance = 1000.0f
	Distance at which the light function should be completely faded to DisabledBrightness.

	UPROPERTY (Category="Quality Settings/Low", BlueprintReadOnly, EditAnywhere, config, DisplayName="Road Materials List for Low Quality") TArray< FStaticMaterial > LowRoadMaterials
	Low quality Road Materials.

	UPROPERTY (Category="Quality Settings/Low", BlueprintReadOnly, EditAnywhere, config, meta=(ClampMin="5000.0", ClampMax="20000.0", UIMin="5000.0", UIMax="20000.0")) float LowStaticMeshMaxDrawDistance
	Default low distance for all primitive components.

	UPROPERTY (Category="Quality Settings/Low", BlueprintReadOnly, EditAnywhere, config, meta=(ClampMin="5000.0", ClampMax="20000.0", UIMin="5000.0", UIMax="20000.0")) float LowRoadPieceMeshMaxDrawDistance
	Default low distance for roads meshes.

	UPROPERTY (Category="Quality Settings/Epic", BlueprintReadOnly, EditAnywhere, config, DisplayName="Road Materials List for EPIC Quality") TArray< FStaticMaterial > EpicRoadMaterials
	EPIC quality Road Materials.

	UPROPERTY (Category="Quality Settings/ROS2", BlueprintReadOnly, EditAnywhere, config, DisplayName="Enable ROS2") bool ROS2
	Enable ROS2

详细描述

Global settings for CARLA.

Setting object used to hold both config settings and editable ones in one place. To ensure the settings are saved to the specified config file make sure to add props using the globalconfig or config meta.

在文件 CarlaSettings.h 第 21 行定义.

成员函数说明

◆ GetQualityLevel()

EQualityLevel UCarlaSettings::GetQualityLevel ( ) const

inline

返回: current quality settings level (could not have been applied yet).

在文件 CarlaSettings.h 第 41 行定义.

被这些函数引用 UCarlaSettingsDelegate::ApplyQualityLevelPostRestart() , 以及 UCarlaSettingsDelegate::OnActorSpawned().

这是这个函数的调用关系图:

◆ LoadSettings()

void UCarlaSettings::LoadSettings ( )

Load the settings based on the command-line arguments and the INI file if provided.

在文件 CarlaSettings.cpp 第 107 行定义.

引用了 bDisableRendering, CurrentFileName, Epic, GetSettingsFilePathFromCommandLine(), LoadSettingsFromFile(), PrimaryIP, PrimaryPort, QualityLevel, QualityLevelFromString(), RPCPort, SecondaryPort , 以及 StreamingPort.

被这些函数引用 UCarlaGameInstance::UCarlaGameInstance().

函数调用图:

这是这个函数的调用关系图:

◆ LoadSettingsFromFile()

void UCarlaSettings::LoadSettingsFromFile	(	const FString &	FilePath,
		bool	bLogOnFailure )

private

在文件 CarlaSettings.cpp 第 196 行定义.

引用了 CurrentFileName , 以及 LoadSettingsFromConfig().

被这些函数引用 LoadSettings().

函数调用图:

这是这个函数的调用关系图:

◆ LoadSettingsFromString()

void UCarlaSettings::LoadSettingsFromString ( const FString & INIFileContents )

Load the settings from the given string (formatted as INI).

CarlaServer section is ignored.

在文件 CarlaSettings.cpp 第 165 行定义.

引用了 CurrentFileName, LoadSettingsFromConfig() , 以及 FIniFile::ProcessInputFileContents().

函数调用图:

◆ LogSettings()

void UCarlaSettings::LogSettings ( ) const

Log settings values.

在文件 CarlaSettings.cpp 第 175 行定义.

引用了 bDisableRendering, bSynchronousMode, CurrentFileName, QualityLevel, QualityLevelToString(), RPCPort, S_CARLA_QUALITYSETTINGS, S_CARLA_SERVER, SecondaryPort , 以及 StreamingPort.

被这些函数引用 UCarlaGameInstance::UCarlaGameInstance().

函数调用图:

这是这个函数的调用关系图:

◆ SetQualityLevel()

void UCarlaSettings::SetQualityLevel ( EQualityLevel InQualityLevel )

inline

Sets the new quality settings level and make changes in the game related to it.

注解: This will not apply the quality settings. Use ApplyQualitySettings functions instead

参数

InQualityLevel Store the new quality.

在文件 CarlaSettings.h 第 34 行定义.

被这些函数引用 LoadSettingsFromConfig().

这是这个函数的调用关系图:

◆ UPROPERTY() [1/5]

UCarlaSettings::UPROPERTY	(	Category	= "Quality Settings/Epic",
		BlueprintReadOnly	,
		EditAnywhere	,
		config	,
		DisplayName	= "Road Materials List for EPIC Quality" )

EPIC quality Road Materials.

Uses slots name to set material for each part of the road for Epic quality.

◆ UPROPERTY() [2/5]

UCarlaSettings::UPROPERTY	(	Category	= "Quality Settings/Low",
		BlueprintReadOnly	,
		EditAnywhere	,
		config	,
		DisplayName	= "Road Materials List for Low Quality" )

Low quality Road Materials.

Uses slots name to set material for each part of the road for low quality.

待办事项: Move Low quality vars to a generic map of structs with the quality level as key.

◆ UPROPERTY() [3/5]

UCarlaSettings::UPROPERTY	(	Category	= "Quality Settings/Low",
		BlueprintReadOnly	,
		EditAnywhere	,
		config	,
		meta	= (ClampMin="5000.0", ClampMax="20000.0", UIMin="5000.0", UIMax="20000.0") )

Default low distance for roads meshes.

◆ UPROPERTY() [4/5]

UCarlaSettings::UPROPERTY	(	Category	= "Quality Settings/Low",
		BlueprintReadOnly	,
		EditAnywhere	,
		config	,
		meta	= (ClampMin="5000.0", ClampMax="20000.0", UIMin="5000.0", UIMax="20000.0") )

Default low distance for all primitive components.

◆ UPROPERTY() [5/5]

UCarlaSettings::UPROPERTY	(	Category	= "Quality Settings/ROS2",
		BlueprintReadOnly	,
		EditAnywhere	,
		config	,
		DisplayName	= "Enable ROS2" )

Enable ROS2

类成员变量说明

◆ bDisableRendering

bool UCarlaSettings::bDisableRendering = false

Enable or disable the viewport rendering of the world.

Disabled by default.

在文件 CarlaSettings.h 第 103 行定义.

被这些函数引用 UCarlaSettingsDelegate::ApplyQualityLevelPreRestart(), LoadSettings(), LoadSettingsFromConfig() , 以及 LogSettings().

◆ bSynchronousMode

bool UCarlaSettings::bSynchronousMode = false

In synchronous mode, CARLA waits every tick until the control from the client is received.

在文件 CarlaSettings.h 第 98 行定义.

被这些函数引用 LoadSettingsFromConfig() , 以及 LogSettings().

◆ CARLA_ROAD_TAG

const FName UCarlaSettings::CARLA_ROAD_TAG = FName("CARLA_ROAD")

static

CARLA_ROAD name to tag road mesh actors.

在文件 CarlaSettings.h 第 60 行定义.

被这些函数引用 ACityMapMeshHolder::AddInstance(), ACityMapMeshHolder::DeletePieces(), UCarlaSettingsDelegate::OnActorSpawned(), UCarlaSettingsDelegate::SetAllActorsDrawDistance() , 以及 UCarlaSettingsDelegate::SetAllRoads().

◆ CARLA_SKY_TAG

const FName UCarlaSettings::CARLA_SKY_TAG = FName("CARLA_SKY")

static

CARLA_SKY name to tag the sky sphere (BPS) actors in the scenes.

在文件 CarlaSettings.h 第 63 行定义.

被这些函数引用 UCarlaSettingsDelegate::OnActorSpawned() , 以及 UCarlaSettingsDelegate::SetAllActorsDrawDistance().

◆ CurrentFileName

FString UCarlaSettings::CurrentFileName

private

File name of the settings file used to load this settings.

Empty if none used.

在文件 CarlaSettings.h 第 72 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromFile(), LoadSettingsFromString() , 以及 LogSettings().

◆ LowLightFadeDistance

float UCarlaSettings::LowLightFadeDistance = 1000.0f

Distance at which the light function should be completely faded to DisabledBrightness.

This is useful for hiding aliasing from light functions applied in the distance.

在文件 CarlaSettings.h 第 134 行定义.

被这些函数引用 UCarlaSettingsDelegate::ApplyQualityLevelPostRestart().

◆ PrimaryIP

std::string UCarlaSettings::PrimaryIP = ""

setting for the IP and Port of the primary server to connect.

在文件 CarlaSettings.h 第 92 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromConfig() , 以及 FCarlaEngine::NotifyInitGame().

◆ PrimaryPort

uint32 UCarlaSettings::PrimaryPort = 2002u

在文件 CarlaSettings.h 第 93 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromConfig() , 以及 FCarlaEngine::NotifyInitGame().

◆ QualityLevel

EQualityLevel UCarlaSettings::QualityLevel = EQualityLevel::Epic

private

Quality Settings level.

在文件 CarlaSettings.h 第 114 行定义.

被这些函数引用 LoadSettings() , 以及 LogSettings().

◆ RPCPort

uint32 UCarlaSettings::RPCPort = 2000u

World port to listen for client connections.

在文件 CarlaSettings.h 第 83 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromConfig(), LogSettings() , 以及 FCarlaEngine::NotifyInitGame().

◆ SecondaryPort

uint32 UCarlaSettings::SecondaryPort = 2002u

setting for the secondary servers port.

在文件 CarlaSettings.h 第 89 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromConfig(), LogSettings() , 以及 FCarlaEngine::NotifyInitGame().

◆ StreamingPort

uint32 UCarlaSettings::StreamingPort = 2001u

setting for the streaming port.

在文件 CarlaSettings.h 第 86 行定义.

被这些函数引用 LoadSettings(), LoadSettingsFromConfig(), LogSettings() , 以及 FCarlaEngine::NotifyInitGame().

该类的文档由以下文件生成:

Public 成员函数

Public 属性

静态 Public 属性

Private 成员函数

Private 属性

Quality Settings

详细描述

成员函数说明

◆ GetQualityLevel()

◆ LoadSettings()

◆ LoadSettingsFromFile()

◆ LoadSettingsFromString()

◆ LogSettings()

◆ SetQualityLevel()

◆ UPROPERTY() [1/5]

◆ UPROPERTY() [2/5]

◆ UPROPERTY() [3/5]

◆ UPROPERTY() [4/5]

◆ UPROPERTY() [5/5]

类成员变量说明

◆ bDisableRendering

◆ bSynchronousMode

◆ CARLA_ROAD_TAG

◆ CARLA_SKY_TAG

◆ CurrentFileName

◆ LowLightFadeDistance

◆ PrimaryIP

◆ PrimaryPort

◆ QualityLevel

◆ RPCPort

◆ SecondaryPort

◆ StreamingPort