ListComponent Class Reference

#include <listcomponent.h>

Inheritance diagram for ListComponent:

Public Member Functions
	ListComponent (SkyComposite *parent)
virtual	~ListComponent ()
void	clear ()
virtual SkyObject *	findByName (const QString &name)
const QList< SkyObject * > &	objectList () const
virtual SkyObject *	objectNearest (SkyPoint *p, double &maxrad)
virtual void	update (KSNumbers *num=0)
Public Member Functions inherited from SkyComponent
	SkyComponent (SkyComposite *parent)
virtual	~SkyComponent ()
virtual void	draw (SkyPainter *skyp)=0
virtual void	drawTrails (SkyPainter *skyp)
virtual void	emitProgressText (const QString &message)
QHash< int, QStringList > &	objectNames ()
QStringList &	objectNames (int type)
virtual void	objectsInArea (QList< SkyObject * > &list, const SkyRegion &region)
SkyComposite *	parent ()
virtual bool	selected ()
virtual void	updateMoons (KSNumbers *)
virtual void	updatePlanets (KSNumbers *)

Protected Attributes
QList< SkyObject * >	m_ObjectList

Additional Inherited Members
Protected Member Functions inherited from SkyComponent
void	removeFromNames (const SkyObject *obj)

Detailed Description

An abstract parent class, to be inherited by SkyComponents that store a QList of SkyObjects.

Author

Jason Harris

Version

0.1

Definition at line 36 of file listcomponent.h.

Constructor & Destructor Documentation

ListComponent::ListComponent ( SkyComposite *  parent )

explicit

Definition at line 26 of file listcomponent.cpp.

ListComponent::~ListComponent ( )

virtual

Definition at line 30 of file listcomponent.cpp.

Member Function Documentation

void ListComponent::clear

(

)

Definition at line 34 of file listcomponent.cpp.

SkyObject * ListComponent::findByName ( const QString &  name )

virtual

Search the children of this SkyComponent for a SkyObject whose name matches the argument name the name to be matched.

Returns

a pointer to the SkyObject whose name matches the argument, or a NULL pointer if no match was found.

Note

This function simply returns the NULL pointer; it is reimplemented in various sub-classes

Reimplemented from SkyComponent.

Reimplemented in StarComponent, and SupernovaeComponent.

Definition at line 54 of file listcomponent.cpp.

const QList<SkyObject*>& ListComponent::objectList ( ) const

inline

Definition at line 61 of file listcomponent.h.

SkyObject * ListComponent::objectNearest ( SkyPoint *  p, double &  maxrad  )

virtual

Find the SkyObject nearest the given SkyPoint.

Look for a SkyObject that is nearer to point p than maxrad. If one is found, then maxrad is reset to the separation of the new nearest object. p pointer to the SkyPoint to search around maxrad reference to current search radius

Returns

a pointer to the nearest SkyObject

Note

This function simply returns a NULL pointer; it is reimplemented in various sub-classes.

Reimplemented from SkyComponent.

Reimplemented in StarComponent, DeepStarComponent, SupernovaeComponent, and AsteroidsComponent.

Definition at line 65 of file listcomponent.cpp.

void ListComponent::update ( KSNumbers *  num = 0 )

virtual

Update the sky positions of this component.

This function usually just updates the Horizontal (Azimuth/Altitude) coordinates of the objects in this component. If the KSNumbers* argument is not NULL, this function also recomputes precession and nutation for the date in KSNumbers. num Pointer to the KSNumbers object

Note

By default, the num parameter is NULL, indicating that Precession/Nutation computation should be skipped; this computation is only occasionally required.

Reimplemented from SkyComponent.

Reimplemented in StarComponent, ConstellationNamesComponent, CatalogComponent, DeepStarComponent, SupernovaeComponent, and SolarSystemListComponent.

Definition at line 42 of file listcomponent.cpp.

Member Data Documentation

QList<SkyObject*> ListComponent::m_ObjectList

protected

Definition at line 64 of file listcomponent.h.

---

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

• listcomponent.h
• listcomponent.cpp