#include <EnvironmentSettings.h>

Public Types
enum	VisualQuality { Fast , Fair , Nice }
	Visual quality levels. More...

Public Member Functions
VisualQuality	QualityFromInt (int quality)

	EnvironmentSettings (ISimObjectCreator *creator)

std::string	OceanMaterial ()

std::string	OceansidesMaterial ()

std::string	SeafloorMaterial ()

bool	OceanVertexshaderUsesTime ()

SkyMaterialSpec	SkySpec ()

Public Attributes
std::shared_ptr< marenv::wave::WaveField >	waves
	Wave field for rendering.

std::shared_ptr< marenv::seafloor::BathymetryWaves >	bathymetry
	Sum-of-sines bathymetry (used for visualization; also the seabed for the "SumOfSines" model)

std::shared_ptr< marenv::seafloor::BathymetryField >	seafloor
	Active seabed used for physics queries (may be sum-of-sines or a parametric field)

double	seafloorMinDepth = 0.0
	Minimum seabed depth over the visual domain [m] (sampled from the active field).

double	seafloorMaxDepth = 0.0
	Maximum seabed depth over the visual domain [m] (sampled from the active field).

std::shared_ptr< marenv::current::CurrentField >	currents
	Current field.

std::vector< std::shared_ptr< environment::field::ScalarField > >	scalarFields
	Named scalar fields (temperature, salinity, species concentration). Empty when none are configured.

std::shared_ptr< environment::SeafloorForces >	seafloorForces
	Seafloor forces.

bool	visualizeWaves = false
	Enable wave visualization.

std::vector< int >	vertexCounts = {100, 130}
	Vertex counts [u, v].

double	worldRadius = 1000.0
	World rendering radius [m].

int	randomSeed
	Random seed.

int	visualQuality
	Visual quality level.

Detailed Description

Environment visual settings container.

Holds all visualization parameters and resources for the Environment, including wave rendering, sky, materials, and quality settings.

Member Enumeration Documentation

◆ VisualQuality

enum visual::EnvironmentSettings::VisualQuality

Enumerator
Fast	Fast rendering (low quality)
Fair	Fair rendering (medium quality)
Nice	Nice rendering (high quality)

Constructor & Destructor Documentation

◆ EnvironmentSettings()

visual::EnvironmentSettings::EnvironmentSettings ( ISimObjectCreator * creator )

Construct environment settings.

Parameters

[in] creator Pointer to object creator.

Member Function Documentation

◆ OceanMaterial()

std::string visual::EnvironmentSettings::OceanMaterial ( )

Get ocean material name.

Returns: Material string.

◆ OceansidesMaterial()

std::string visual::EnvironmentSettings::OceansidesMaterial ( )

Get ocean sides material name.

Returns: Material string.

◆ OceanVertexshaderUsesTime()

bool visual::EnvironmentSettings::OceanVertexshaderUsesTime ( )

Check if ocean vertex shader uses time.

Returns: True if time-based animation.

◆ QualityFromInt()

VisualQuality visual::EnvironmentSettings::QualityFromInt ( int quality )

Convert integer to visual quality.

Parameters

[in] quality Integer quality value [0-10].

Returns: VisualQuality enum.

◆ SeafloorMaterial()

std::string visual::EnvironmentSettings::SeafloorMaterial ( )

Get seafloor material name.

Returns: Material string.

◆ SkySpec()

SkyMaterialSpec visual::EnvironmentSettings::SkySpec ( )

Get sky specification.

Returns: SkyMaterialSpec struct.

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

webfhsim/reloadrepos/fhsim_environment/src/environment/util/EnvironmentSettings.h

Public Types

Public Member Functions

Public Attributes