Stellarium 0.12.2
List of all members | Public Slots | Public Member Functions
ScreenImageMgr Class Reference

Module for managing images for scripting. More...

#include <ScreenImageMgr.hpp>

Public Slots

void createScreenImage (const QString &id, const QString &filename, float x, float y, float scale=1., bool visible=true, float alpha=1., float fadeDuration=1.)
 Create an image from a file and display on the screen at x,y coordinates. More...
 
bool getShowImage (const QString &id)
 Find out if an image is currently visible. More...
 
int getImageWidth (const QString &id)
 Set an image's visible status. More...
 
int getImageHeight (const QString &id)
 
void showImage (const QString &id, bool show)
 
void setImageAlpha (const QString &id, float alpha)
 Set an image's alpha value when visible. More...
 
void setImageXY (const QString &id, float x, float y, float duration=0.)
 Set the x and y coordinates for the specified image. More...
 
void deleteImage (const QString &id)
 Delete an image. More...
 
void deleteAllImages (void)
 Delete all images currently managed by ScreenImageMgr. More...
 
QStringList getAllImageIDs (void)
 Get a list of currently loaded image IDs. More...
 

Public Member Functions

 ScreenImageMgr ()
 Construct a LabelMgr object. More...
 
virtual void init ()
 Initialize itself. More...
 
virtual void draw (StelCore *core, class StelRenderer *renderer)
 Execute all the drawing functions for this module. More...
 
virtual void update (double deltaTime)
 Update time-dependent parts of the module. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Defines the order in which the various modules are drawn. More...
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be deleted, and before the renderer is destroyed. More...
 
virtual bool drawPartial (StelCore *core, class StelRenderer *renderer)
 Iterate through the drawing sequence. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version. More...
 
virtual QString getAuthorName () const
 Get the name of the module author. More...
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author. More...
 
virtual void handleMouseClicks (class QMouseEvent *)
 Handle mouse clicks. More...
 
virtual void handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual void handleKeys (class QKeyEvent *e)
 Handle key events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Additional Inherited Members

- Public Types inherited from StelModule
enum  StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
 Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
 
enum  StelModuleActionName {
  ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves,
  ActionHandleKeys
}
 Define the possible action for which an order is defined. More...
 

Detailed Description

Module for managing images for scripting.

Images are identified by a string ID which is passed to ScreenImageMgr members when it is necessary to specify an image to work with. Member functions in this class which modify the state of the class are all mediated through the signal/slot mechanism to ensure such operations happen in the main thread where images are drawn, and not in the script thread.

Definition at line 103 of file ScreenImageMgr.hpp.

Constructor & Destructor Documentation

ScreenImageMgr::ScreenImageMgr ( )

Construct a LabelMgr object.

Member Function Documentation

void ScreenImageMgr::createScreenImage ( const QString &  id,
const QString &  filename,
float  x,
float  y,
float  scale = 1.,
bool  visible = true,
float  alpha = 1.,
float  fadeDuration = 1. 
)
slot

Create an image from a file and display on the screen at x,y coordinates.

Parameters
idthe ID to use when referring to this image (an arbitrary string).
filenamethe partial path of the file to load. This will be searched for using StelFileMgr, with "scripts/" prefixed to the filename.
xThe x-coordinate for the image (0 = left of screen)
yThe y-coordinate for the image (0 = bottom of screen)
scaleImage scale multiplier.
visibleThe initial visible state of the image
alphaThe initial alpha (transparancy) value for the image (range 0.0 to 1.0)
fadeDurationthe time it takes for screen images to fade in/out/change alpha in seconds.
void ScreenImageMgr::deleteAllImages ( void  )
slot

Delete all images currently managed by ScreenImageMgr.

void ScreenImageMgr::deleteImage ( const QString &  id)
slot

Delete an image.

Parameters
idthe ID for the desired image.
virtual void ScreenImageMgr::draw ( StelCore core,
class StelRenderer renderer 
)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing
rendererRenderer to draw with.

Reimplemented from StelModule.

QStringList ScreenImageMgr::getAllImageIDs ( void  )
slot

Get a list of currently loaded image IDs.

virtual double ScreenImageMgr::getCallOrder ( StelModuleActionName  actionName) const
virtual

Defines the order in which the various modules are drawn.

Reimplemented from StelModule.

int ScreenImageMgr::getImageWidth ( const QString &  id)
slot

Set an image's visible status.

Parameters
idthe ID for the desired image.
bool ScreenImageMgr::getShowImage ( const QString &  id)
slot

Find out if an image is currently visible.

Parameters
idthe ID for the desired image.
virtual void ScreenImageMgr::init ( )
virtual

Initialize itself.

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

void ScreenImageMgr::setImageAlpha ( const QString &  id,
float  alpha 
)
slot

Set an image's alpha value when visible.

Parameters
idthe ID for the desired image.
alphathe new alpha value to set.
void ScreenImageMgr::setImageXY ( const QString &  id,
float  x,
float  y,
float  duration = 0. 
)
slot

Set the x and y coordinates for the specified image.

Parameters
idthe ID for the desired image.
xThe new x-coordinate for the image.
yThe new y-coordinate for the image.
durationThe time for the change to take place, in seconds.
virtual void ScreenImageMgr::update ( double  deltaTime)
virtual

Update time-dependent parts of the module.

Implements StelModule.


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