Stellarium 0.14.3
List of all members | Public Slots | Signals | Public Member Functions
Scenery3dMgr Class Reference

Main class of the module, inherits from StelModule. More...

#include <Scenery3dMgr.hpp>

Public Slots

void reloadShaders ()
 Clears the shader cache, forcing a reload of shaders on use. More...
 
void showMessage (const QString &message)
 Display text message on screen, fade out automatically. More...
 
void showStoredViewDialog ()
 Shows the stored view dialog. More...
 
void setEnableScene (const bool val)
 Enables/Disables the plugin. More...
 
bool getEnableScene () const
 
void setEnablePixelLighting (const bool val)
 
bool getEnablePixelLighting (void) const
 
void setEnableShadows (const bool enableShadows)
 Use this to set/get the enableShadows flag. More...
 
bool getEnableShadows (void) const
 
void setUseSimpleShadows (const bool simpleShadows)
 If true, only 1 shadow cascade is used, giving a speedup. More...
 
bool getUseSimpleShadows () const
 
void setEnableBumps (const bool enableBumps)
 Use this to set/get the enableBumps flag. More...
 
bool getEnableBumps (void) const
 
S3DEnum::ShadowFilterQuality getShadowFilterQuality (void) const
 Returns the current shadow filter quality. More...
 
void setShadowFilterQuality (const S3DEnum::ShadowFilterQuality val)
 Sets the shadow filter quality. More...
 
void setEnablePCSS (const bool val)
 
bool getEnablePCSS () const
 
S3DEnum::CubemappingMode getCubemappingMode (void) const
 Returns the current cubemapping mode. More...
 
void setCubemappingMode (const S3DEnum::CubemappingMode val)
 Sets the cubemapping mode. More...
 
bool getUseFullCubemapShadows () const
 
void setUseFullCubemapShadows (const bool useFullCubemapShadows)
 
void setEnableDebugInfo (const bool debugEnabled)
 Set to true to show some rendering debug information. More...
 
bool getEnableDebugInfo () const
 
void setEnableLocationInfo (const bool enableLocationInfo)
 Set to true to show the current standing positin as text on screen. More...
 
bool getEnableLocationInfo () const
 
void setEnableTorchLight (const bool enableTorchLight)
 Set to true to add an additional light source centered at the current position, useful in night scenes. More...
 
bool getEnableTorchLight () const
 
void setTorchStrength (const float torchStrength)
 Sets the strength of the additional illumination that can be toggled when pressing a button. More...
 
float getTorchStrength () const
 
void setTorchRange (const float torchRange)
 Sets the range of the torchlight. More...
 
float getTorchRange () const
 
void setEnableLazyDrawing (const bool val)
 Sets the state of the cubemap lazy-drawing mode. More...
 
bool getEnableLazyDrawing () const
 
void setOnlyDominantFaceWhenMoving (const bool val)
 When true, only the face which currently is most dominantly visible is updated while moving. More...
 
bool getOnlyDominantFaceWhenMoving () const
 
void setSecondDominantFaceWhenMoving (const bool val)
 
bool getSecondDominantFaceWhenMoving () const
 
void forceCubemapRedraw ()
 Forces a redraw of the cubemap. More...
 
void setLazyDrawingInterval (const double val)
 Sets the interval for cubemap lazy-drawing mode. More...
 
double getLazyDrawingInterval () const
 
void setCubemapSize (const uint val)
 Sets the size used for cubemap rendering. More...
 
uint getCubemapSize () const
 
void setShadowmapSize (const uint val)
 Sets the size used for shadowmap rendering. More...
 
uint getShadowmapSize () const
 
bool getIsGeometryShaderSupported () const
 
bool getAreShadowsSupported () const
 
bool getIsShadowFilteringSupported () const
 
bool getIsANGLE () const
 
uint getMaximumFramebufferSize () const
 
SceneInfo getCurrentScene () const
 Gets the SceneInfo of the scene that is currently being displayed. More...
 
SceneInfo getLoadingScene () const
 Gets the SceneInfo of the scene that is currently in the process of being loaded. More...
 
SceneInfo loadScenery3dByName (const QString &name)
 This starts the scene loading process. More...
 
SceneInfo loadScenery3dByID (const QString &id)
 This starts the scene loading process. More...
 
QString getDefaultScenery3dID () const
 
void setDefaultScenery3dID (const QString &id)
 
void setView (const StoredView &view, const bool setDate)
 Changes the current view to the given view. JD is updated only if view contains valid data and setDate is true. More...
 
StoredView getCurrentView ()
 Returns a StoredView that represents the current observer position + view direction. More...
 

Signals

void enableSceneChanged (const bool val)
 
void enablePixelLightingChanged (const bool val)
 
void enableShadowsChanged (const bool val)
 
void useSimpleShadowsChanged (const bool val)
 
void enableBumpsChanged (const bool val)
 
void shadowFilterQualityChanged (const S3DEnum::ShadowFilterQuality val)
 
void enablePCSSChanged (const bool val)
 
void cubemappingModeChanged (const S3DEnum::CubemappingMode val)
 
void useFullCubemapShadowsChanged (const bool val)
 
void enableDebugInfoChanged (const bool val)
 
void enableLocationInfoChanged (const bool val)
 
void enableTorchLightChanged (const bool val)
 
void torchStrengthChanged (const float val)
 
void torchRangeChanged (const float val)
 
void enableLazyDrawingChanged (const bool val)
 
void lazyDrawingIntervalChanged (const double val)
 
void onlyDominantFaceWhenMovingChanged (const bool val)
 
void secondDominantFaceWhenMovingChanged (const bool val)
 
void cubemapSizeChanged (const uint val)
 
void shadowmapSizeChanged (const uint val)
 
void currentSceneChanged (const SceneInfo &sceneInfo)
 
void progressReport (const QString &str, int val, int min, int max)
 This signal is emitted from another thread than this QObject belongs to, so use QueuedConnection. More...
 

Public Member Functions

virtual void init ()
 
virtual void deinit ()
 
virtual void draw (StelCore *core)
 
virtual void update (double deltaTime)
 
virtual double getCallOrder (StelModuleActionName actionName) const
 
virtual bool configureGui (bool show)
 
virtual void handleKeys (QKeyEvent *e)
 
void updateProgress (const QString &str, int val, int min, int max)
 Sends the progressReport() signal, which eventually updates the progress bar. Can be called from another thread. More...
 

Detailed Description

Main class of the module, inherits from StelModule.

Manages initialization, provides an interface to change Scenery3d properties and handles user input

Definition at line 48 of file Scenery3dMgr.hpp.

Member Function Documentation

void Scenery3dMgr::forceCubemapRedraw ( )
slot

Forces a redraw of the cubemap.

S3DEnum::CubemappingMode Scenery3dMgr::getCubemappingMode ( void  ) const
slot

Returns the current cubemapping mode.

SceneInfo Scenery3dMgr::getCurrentScene ( ) const
slot

Gets the SceneInfo of the scene that is currently being displayed.

Check SceneInfo::isValid to determine if a scene is displayed.

StoredView Scenery3dMgr::getCurrentView ( )
slot

Returns a StoredView that represents the current observer position + view direction.

Label and description are empty.

SceneInfo Scenery3dMgr::getLoadingScene ( ) const
inlineslot

Gets the SceneInfo of the scene that is currently in the process of being loaded.

Check SceneInfo::isValid to determine if a scene is loaded.

Definition at line 231 of file Scenery3dMgr.hpp.

S3DEnum::ShadowFilterQuality Scenery3dMgr::getShadowFilterQuality ( void  ) const
slot

Returns the current shadow filter quality.

SceneInfo Scenery3dMgr::loadScenery3dByID ( const QString &  id)
slot

This starts the scene loading process.

This is asynchronous, this method returns after metadata loading.

Parameters
ida valid scene id/folder path
Returns
The loaded SceneInfo. Check SceneInfo::isValid to make sure loading was successful.
SceneInfo Scenery3dMgr::loadScenery3dByName ( const QString &  name)
slot

This starts the scene loading process.

This is asynchronous, this method returns after metadata loading.

Parameters
namea valid scene name
Returns
The loaded SceneInfo. Check SceneInfo::isValid to make sure loading was successful.
void Scenery3dMgr::progressReport ( const QString &  str,
int  val,
int  min,
int  max 
)
signal

This signal is emitted from another thread than this QObject belongs to, so use QueuedConnection.

void Scenery3dMgr::reloadShaders ( )
slot

Clears the shader cache, forcing a reload of shaders on use.

void Scenery3dMgr::setCubemappingMode ( const S3DEnum::CubemappingMode  val)
slot

Sets the cubemapping mode.

void Scenery3dMgr::setCubemapSize ( const uint  val)
slot

Sets the size used for cubemap rendering.

For best compatibility and performance, this should be a power of 2.

void Scenery3dMgr::setEnableBumps ( const bool  enableBumps)
slot

Use this to set/get the enableBumps flag.

If set to true, bump mapping is enabled for the 3D scene.

void Scenery3dMgr::setEnableDebugInfo ( const bool  debugEnabled)
slot

Set to true to show some rendering debug information.

void Scenery3dMgr::setEnableLazyDrawing ( const bool  val)
slot

Sets the state of the cubemap lazy-drawing mode.

void Scenery3dMgr::setEnableLocationInfo ( const bool  enableLocationInfo)
slot

Set to true to show the current standing positin as text on screen.

void Scenery3dMgr::setEnableScene ( const bool  val)
slot

Enables/Disables the plugin.

void Scenery3dMgr::setEnableShadows ( const bool  enableShadows)
slot

Use this to set/get the enableShadows flag.

If set to true, shadow mapping is enabled for the 3D scene.

void Scenery3dMgr::setEnableTorchLight ( const bool  enableTorchLight)
slot

Set to true to add an additional light source centered at the current position, useful in night scenes.

void Scenery3dMgr::setLazyDrawingInterval ( const double  val)
slot

Sets the interval for cubemap lazy-drawing mode.

void Scenery3dMgr::setOnlyDominantFaceWhenMoving ( const bool  val)
slot

When true, only the face which currently is most dominantly visible is updated while moving.

void Scenery3dMgr::setShadowFilterQuality ( const S3DEnum::ShadowFilterQuality  val)
slot

Sets the shadow filter quality.

void Scenery3dMgr::setShadowmapSize ( const uint  val)
slot

Sets the size used for shadowmap rendering.

For best compatibility and performance, this should be a power of 2.

void Scenery3dMgr::setTorchRange ( const float  torchRange)
slot

Sets the range of the torchlight.

void Scenery3dMgr::setTorchStrength ( const float  torchStrength)
slot

Sets the strength of the additional illumination that can be toggled when pressing a button.

void Scenery3dMgr::setUseSimpleShadows ( const bool  simpleShadows)
slot

If true, only 1 shadow cascade is used, giving a speedup.

void Scenery3dMgr::setView ( const StoredView view,
const bool  setDate 
)
slot

Changes the current view to the given view. JD is updated only if view contains valid data and setDate is true.

void Scenery3dMgr::showMessage ( const QString &  message)
slot

Display text message on screen, fade out automatically.

void Scenery3dMgr::showStoredViewDialog ( )
slot

Shows the stored view dialog.

void Scenery3dMgr::updateProgress ( const QString &  str,
int  val,
int  min,
int  max 
)

Sends the progressReport() signal, which eventually updates the progress bar. Can be called from another thread.


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