SolarSystemSingleComponent

Search for usage in LXR

SolarSystemSingleComponent Class Reference

#include <solarsystemsinglecomponent.h>

Inheritance diagram for SolarSystemSingleComponent:

Public Member Functions

 SolarSystemSingleComponent (SolarSystemComposite *, KSPlanetBase *kspb, bool(*visibleMethod)(), bool isMoon=false)
 
void draw (SkyPainter *skyp) override
 
SkyObjectfindByName (const QString &name, bool exact=true) override
 
SkyObjectobjectNearest (SkyPoint *p, double &maxrad) override
 
KSPlanetBaseplanet ()
 
bool selected () override
 
void update (KSNumbers *num) override
 
void updateMoons (KSNumbers *num) override
 
void updateSolarSystemBodies (KSNumbers *num) override
 
- Public Member Functions inherited from SkyComponent
 SkyComponent (SkyComposite *parent=nullptr)
 
virtual void emitProgressText (const QString &message)
 
QHash< int, QVector< QPair< QString, const SkyObject * > > > & objectLists ()
 
QVector< QPair< QString, const SkyObject * > > & objectLists (int type)
 
QHash< int, QStringList > & objectNames ()
 
QStringListobjectNames (int type)
 
virtual void objectsInArea (QList< SkyObject * > &list, const SkyRegion &region)
 
SkyCompositeparent ()
 
void removeFromLists (const SkyObject *obj)
 
void removeFromNames (const SkyObject *obj)
 

Protected Member Functions

void drawTrails (SkyPainter *skyp) override
 

Detailed Description

This class encapsulates some methods which are shared between all single-object solar system components (Sun, Moon, Planet, Pluto)

Author
Thomas Kabelmann
Version
0.1

Definition at line 28 of file solarsystemsinglecomponent.h.

Constructor & Destructor Documentation

◆ SolarSystemSingleComponent()

SolarSystemSingleComponent::SolarSystemSingleComponent ( SolarSystemComposite parent,
KSPlanetBase kspb,
bool(*)()  visibleMethod,
bool  isMoon = false 
)

Initialize visible method, minimum size and sizeScale.

Definition at line 29 of file solarsystemsinglecomponent.cpp.

Member Function Documentation

◆ draw()

void SolarSystemSingleComponent::draw ( SkyPainter skyp)
overridevirtual

Draw the object on the SkyMap skyp a pointer to the SkyPainter to use.

Implements SkyComponent.

Definition at line 110 of file solarsystemsinglecomponent.cpp.

◆ drawTrails()

void SolarSystemSingleComponent::drawTrails ( SkyPainter skyp)
overrideprotectedvirtual

Draw trails for objects.

Reimplemented from SkyComponent.

Definition at line 123 of file solarsystemsinglecomponent.cpp.

◆ findByName()

SkyObject * SolarSystemSingleComponent::findByName ( const QString name,
bool  exact = true 
)
overridevirtual

Search the children of this SkyComponent for a SkyObject whose name matches the argument name the name to be matched exact If true, it will return an exact match, otherwise it can return a partial match.

Returns
a pointer to the SkyObject whose name matches the argument, or a nullptr pointer if no match was found.
Note
This function simply returns the nullptr pointer; it is reimplemented in various sub-classes

Reimplemented from SkyComponent.

Definition at line 58 of file solarsystemsinglecomponent.cpp.

◆ objectNearest()

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

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 in degrees

Returns
a pointer to the nearest SkyObject
Note
This function simply returns a nullptr pointer; it is reimplemented in various sub-classes.

Reimplemented from SkyComponent.

Definition at line 68 of file solarsystemsinglecomponent.cpp.

◆ planet()

KSPlanetBase* SolarSystemSingleComponent::planet ( )
inline

Return pointer to stored planet object.

Definition at line 37 of file solarsystemsinglecomponent.h.

◆ selected()

bool SolarSystemSingleComponent::selected ( )
overridevirtual
Returns
true if component is to be drawn on the map.

Reimplemented from SkyComponent.

Definition at line 53 of file solarsystemsinglecomponent.cpp.

◆ update()

void SolarSystemSingleComponent::update ( KSNumbers num)
overridevirtual

update Only convert Equatorial to Horizontal coordinates given current time.

Parameters
numpointer to KSNumbers instance for target time

Reimplemented from SkyComponent.

Definition at line 79 of file solarsystemsinglecomponent.cpp.

◆ updateMoons()

void SolarSystemSingleComponent::updateMoons ( KSNumbers num)
overridevirtual

update Update Equatorial & Horizontal coordinates.

(Called more frequently.)

Reimplemented from SkyComponent.

Definition at line 101 of file solarsystemsinglecomponent.cpp.

◆ updateSolarSystemBodies()

void SolarSystemSingleComponent::updateSolarSystemBodies ( KSNumbers num)
overridevirtual

updateSolarSystemBodies Update Equatorial & Horizontal coordinates.

Parameters
numpointer to KSNumbers instance for target time

Reimplemented from SkyComponent.

Definition at line 86 of file solarsystemsinglecomponent.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Aug 17 2022 04:14:24 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.