Marine systems simulation
Loading...
Searching...
No Matches
visual::EnvironmentSettings Class Reference

#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::WaveFieldwaves
 Wave field for rendering.
 
std::shared_ptr< marenv::seafloor::BathymetryWavesbathymetry
 Bathymetry with waves.
 
std::shared_ptr< marenv::current::CurrentFieldcurrents
 Current field.
 
std::shared_ptr< environment::SeafloorForcesseafloorForces
 Seafloor forces.
 
bool visualizeWaves = false
 Enable wave visualization.
 
std::vector< int > vertexCounts = {100, 130}
 Vertex counts [u, v].
 
double worldRadius = 3000.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

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]creatorPointer 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]qualityInteger 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: