Stellarium  0.90.0
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...
 
void showImage (const QString &id, bool show)
 Set an image's visible status. More...
 
int getImageWidth (const QString &id)
 
int getImageHeight (const QString &id)
 
void setImageScale (const QString &id, float scaleX, float scaleY, float duration=0.)
 Set the x and y scale for the specified image, relative to size given at load time. More...
 
float getImageScaleX (const QString &id)
 
float getImageScaleY (const QString &id)
 
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 addImageXY (const QString &id, float x, float y, float duration=0.)
 Add x and y coordinate offsets to the specified image. More...
 
void deleteImage (const QString &id)
 Delete an image. More...
 
void deleteAllImages (void)
 Delete all images currently managed by ScreenImageMgr.
 
QStringList getAllImageIDs (void)
 Get a list of currently loaded image IDs.
 

Public Member Functions

 ScreenImageMgr ()
 Construct a LabelMgr object.
 
virtual void init ()
 Initialize itself. More...
 
virtual void draw (StelCore *core)
 Execute all the drawing functions for this module. More...
 
virtual void update (double deltaTime)
 Update time-dependent parts of the module.
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Defines the order in which the various modules are drawn.
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version.
 
virtual QString getAuthorName () const
 Get the name of the module author.
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author.
 
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 handlePinch (qreal scale, bool started)
 Handle pinch gesture 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...
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to slot) to the StelActionMgr object. More...
 
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to own slot) to the StelActionMgr object. More...
 

Detailed Description

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.

Member Function Documentation

void ScreenImageMgr::addImageXY ( const QString &  id,
float  x,
float  y,
float  duration = 0. 
)
slot
Parameters
idthe ID for the desired image.
xThe x-coordinate shift for the image, pixels.
yThe y-coordinate shift for the image, pixels.
durationThe time for the change to take place, in seconds.
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
Parameters
idthe ID to use when referring to this image (an arbitrary string). If an image with this id exists already, it will be deleted first.
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)
scalescale factor for the image. 1 = original size, 0.5 = 50% size etc.
visibleThe initial visible state of the image
alphaThe initial alpha (opacity) value for the image (range 0.0=transparent to 1.0=opaque)
fadeDurationthe time it takes for screen images to fade in/out/change alpha in seconds.
void ScreenImageMgr::deleteImage ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
virtual void ScreenImageMgr::draw ( StelCore core)
virtual
Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

int ScreenImageMgr::getImageHeight ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
Returns
height (unscaled!) in pixels.
float ScreenImageMgr::getImageScaleX ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
Returns
current X scaling factor, relative to loaded size.
float ScreenImageMgr::getImageScaleY ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
Returns
current Y scaling factor, relative to loaded size.
int ScreenImageMgr::getImageWidth ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
Returns
width (unscaled!) in pixels.
bool ScreenImageMgr::getShowImage ( const QString &  id)
slot
Parameters
idthe ID for the desired image.
Returns
true if visible, false if not visible or not loaded.
virtual void ScreenImageMgr::init ( )
virtual

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
Parameters
idthe ID for the desired image.
alphathe new alpha value to set.
void ScreenImageMgr::setImageScale ( const QString &  id,
float  scaleX,
float  scaleY,
float  duration = 0. 
)
slot
Parameters
idthe ID for the desired image.
scaleXThe new x-scale for the image.
scaleYThe new y-scale for the image.
durationThe time for the change to take place, in seconds.
void ScreenImageMgr::setImageXY ( const QString &  id,
float  x,
float  y,
float  duration = 0. 
)
slot
Parameters
idthe ID for the desired image.
xThe new x-coordinate for the image, pixels.
yThe new y-coordinate for the image, pixels.
durationThe time for the change to take place, in seconds.
void ScreenImageMgr::showImage ( const QString &  id,
bool  show 
)
slot
Parameters
idthe ID for the desired image.
showthe new visible state to set.