Stellarium 0.15.1
List of all members | Public Slots | Public Member Functions
CustomObjectMgr Class Reference
+ Inheritance diagram for CustomObjectMgr:
+ Collaboration diagram for CustomObjectMgr:

Public Slots

CustomObjectP searchByEnglishName (QString customObjectEnglishName) const
 Get a pointer to a custom object. More...
 
void addCustomObject (QString designation, Vec3d coordinates, bool isVisible=false)
 Add custom object on the sky. More...
 
void addCustomObject (QString designation, const QString &ra, const QString &dec, bool isVisible=false)
 Add custom object on the sky. More...
 
void addCustomObjectRaDec (QString designation, const QString &ra, const QString &dec, bool isVisible=false)
 Add custom object on the sky. More...
 
void addCustomObjectAltAzi (QString designation, const QString &alt, const QString &azi, bool isVisible=false)
 Add custom object on the sky. More...
 
void removeCustomObjects ()
 Remove all custom objects. More...
 
void setMarkersColor (const Vec3f &c)
 Set the color used to draw custom object markers. More...
 
const Vec3fgetMarkersColor (void) const
 Get the current color used to draw custom object markers. More...
 
void setMarkersSize (const float size)
 Set the size of custom object markers. More...
 
float getMarkersSize (void) const
 Get the current size used to custom object markers. More...
 

Public Member Functions

virtual void init ()
 Initialize itself. More...
 
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual void update (double)
 Update the module with respect to the time. More...
 
virtual void draw (StelCore *core)
 Execute all the drawing functions for this module. More...
 
virtual void drawPointer (StelCore *core, StelPainter &painter)
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
 
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Used to get a list of objects which are near to some position. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching satellite object's pointer if exists or NULL. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching satellite if exists or NULL. More...
 
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...
 
virtual QStringList listAllObjects (bool inEnglish) const
 List all StelObjects. More...
 
virtual QString getName () const
 
virtual void handleMouseClicks (class QMouseEvent *e)
 Handle mouse clicks. More...
 
- Public Member Functions inherited from StelObjectModule
virtual QStringList listAllObjectsByType (const QString &objType, bool inEnglish) const
 List all StelObjects by type. More...
 
bool matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
 Auxiliary method of listMatchingObjects() More...
 
- Public Member Functions inherited from StelModule
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 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

Definition at line 35 of file CustomObjectMgr.hpp.

Member Function Documentation

void CustomObjectMgr::addCustomObject ( QString  designation,
Vec3d  coordinates,
bool  isVisible = false 
)
slot

Add custom object on the sky.

Parameters
designation- designation of custom object
coordinates- coordinates of custom object
isVisible- flag of visibility of custom object
void CustomObjectMgr::addCustomObject ( QString  designation,
const QString &  ra,
const QString &  dec,
bool  isVisible = false 
)
slot

Add custom object on the sky.

Parameters
designation- designation of custom object
ra- right ascension angle (J2000.0) of custom object
dec- declination angle (J2000.0) of custom object
isVisible- flag of visibility of custom object
// example of usage in scripts
CustomObjectMgr.addCustomObject("Marker", "2h10m15s", "60d01m15s", true);
void CustomObjectMgr::addCustomObjectAltAzi ( QString  designation,
const QString &  alt,
const QString &  azi,
bool  isVisible = false 
)
slot

Add custom object on the sky.

Parameters
designation- designation of custom object
alt- altitude of custom object
azi- azimuth of custom object
isVisible- flag of visibility of custom object
// example of usage in scripts
CustomObjectMgr.addCustomObjectAltAzi("Marker", "2d10m15s", "60d01m15s", true);
void CustomObjectMgr::addCustomObjectRaDec ( QString  designation,
const QString &  ra,
const QString &  dec,
bool  isVisible = false 
)
slot

Add custom object on the sky.

Parameters
designation- designation of custom object
ra- right ascension angle (on date) of custom object
dec- declination angle (on date) of custom object
isVisible- flag of visibility of custom object
// example of usage in scripts
CustomObjectMgr.addCustomObjectRaDec("Marker", "2h10m15s", "60d01m15s", true);
virtual void CustomObjectMgr::deinit ( )
virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void CustomObjectMgr::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

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

Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations.

Parameters
actionNamethe name of the action for which we want the call order
Returns
the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

const Vec3f& CustomObjectMgr::getMarkersColor ( void  ) const
slot

Get the current color used to draw custom object markers.

Returns
current color
float CustomObjectMgr::getMarkersSize ( void  ) const
slot

Get the current size used to custom object markers.

Returns
current size
virtual void CustomObjectMgr::handleMouseClicks ( class QMouseEvent *  e)
virtual

Handle mouse clicks.

Please note that most of the interactions will be done through the GUI module.

Returns
set the event as accepted if it was intercepted

Reimplemented from StelModule.

virtual void CustomObjectMgr::init ( )
virtual

Initialize itself.

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

Implements StelModule.

virtual QStringList CustomObjectMgr::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

Parameters
inEnglishlist names in English (true) or translated (false)
Returns
a list of matching object name by order of relevance, or an empty list if nothing matches

Implements StelObjectModule.

virtual QStringList CustomObjectMgr::listMatchingObjects ( const QString &  objPrefix,
int  maxNbItem = 5,
bool  useStartOfWords = false,
bool  inEnglish = false 
) const
virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object name.

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe autofill mode for returned objects names
Returns
a list of matching object name by order of relevance, or an empty list if nothing match

Reimplemented from StelObjectModule.

void CustomObjectMgr::removeCustomObjects ( )
slot

Remove all custom objects.

virtual QList<StelObjectP> CustomObjectMgr::searchAround ( const Vec3d v,
double  limitFov,
const StelCore core 
) const
virtual

Used to get a list of objects which are near to some position.

Parameters
va vector representing the position in th sky around which to search for nebulae.
limitFovthe field of view around the position v in which to search for satellites.
corethe StelCore to use for computations.
Returns
an list containing the satellites located inside the limitFov circle around position v.

Implements StelObjectModule.

CustomObjectP CustomObjectMgr::searchByEnglishName ( QString  customObjectEnglishName) const
slot

Get a pointer to a custom object.

Parameters
customObjectEnglishNamethe English name of the desired object.
Returns
The matching custom object pointer if exists or NULL.
virtual StelObjectP CustomObjectMgr::searchByName ( const QString &  name) const
virtual

Return the matching satellite if exists or NULL.

Parameters
nameThe case in-sensistive standard program name

Implements StelObjectModule.

virtual StelObjectP CustomObjectMgr::searchByNameI18n ( const QString &  nameI18n) const
virtual

Return the matching satellite object's pointer if exists or NULL.

Parameters
nameI18nThe case in-sensistive satellite name

Implements StelObjectModule.

void CustomObjectMgr::setMarkersColor ( const Vec3f c)
slot

Set the color used to draw custom object markers.

Parameters
cThe color of the custom object markers (R,G,B)
// example of usage in scripts
void CustomObjectMgr::setMarkersSize ( const float  size)
slot

Set the size of custom object markers.

Parameters
cThe size of the custom object markers
// example of usage in scripts
virtual void CustomObjectMgr::update ( double  deltaTime)
inlinevirtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.

Definition at line 47 of file CustomObjectMgr.hpp.


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