Add observable celestial objects to MapProjection. More...

#include <CelestialOverlay.h>

Inheritance diagram for rose::CelestialOverlay:

Collaboration diagram for rose::CelestialOverlay:

Public Member Functions
	CelestialOverlay (std::shared_ptr< TimerTick > timerTick, std::filesystem::path &xdgDataPath)

	CelestialOverlay (const CelestialOverlay &)=delete

	CelestialOverlay (CelestialOverlay &&)=delete

CelestialOverlay &	operator= (const CelestialOverlay &)=delete

CelestialOverlay &	operator= (CelestialOverlay &&)=delete

std::string_view	nodeId () const noexcept override

void	draw (gm::Context &context, const Position< int > &containerPosition) override
	Draw the CelestialOverlay.

Rectangle	layout (gm::Context &context, const Rectangle &screenRect) override
	Layout the CelestialOverlay.

void	addedToContainer () override
	Called when added to a container. More...

void	loadMapCelestialObjectImages (const std::filesystem::path &xdgResourcePath, gm::Context &context)
	Load overlay images into the ImageStore.

void	setCelestialObservations ()

Public Member Functions inherited from rose::Widget
	Widget (const Widget &)=delete

	Widget (Widget &&)=delete

Widget &	operator= (const Widget &)=delete

Widget &	operator= (Widget &&)=delete

std::string_view	nodeId () const noexcept override

std::shared_ptr< Widget >	pointerWidget (const Position< int > &position, const Position< int > &containerPosition)
	Search for the Widget within which the position lies. More...

Position< int >	computeScreenPosition ()
	Recursively compute the Widget Position on the Screen. More...

bool	contains (const Position< int > &position)
	Determine if a given Screen Position is within the Widget Rectangle. More...

Application &	getApplication ()
	Get a reference to the Application object. More...

Application &	getApplication () const
	const version of getApplication()

std::shared_ptr< Window >	getWindow ()
	Get the Window ancestor of a Widget. More...

std::shared_ptr< Window >	getWindow () const
	const version of getWindow().

bool	enterEvent ()
	Notify Widget of mouse pointer enter event. More...

void	setEnterLeaveEventCallback (EventCallback eventCallback)
	Set the enter callback.

bool	leaveEvent ()
	Notify Widget of mouse pointer leave event. More...

void	setLeaveEventCallback (EventCallback eventCallback)
	Set the leave callback.

bool	buttonEvent (bool pressed, uint button, uint clicks, bool passed)
	Notify Widget of mouse button events. More...

void	setButtonEventCallback (ButtonCallback buttonCallback)
	Set the button callback.

bool	mouseMotionEvent (bool pressed, uint button, const Position< int > &mousePos, const Position< int > &relativePos, bool passed)
	Notify Widget of mouse motion events. More...

void	setMouseMotionEventCallback (MouseMotionCallback mouseMotionCallback)
	Set the mouse motion callback.

bool	mouseScrollEvent (const Position< int > &deltaPos, bool passed)
	Notify Widget of mouse scroll wheel events. More...

void	setMouseScrollEventCallback (ScrollCallback scrollCallback)
	Set the mouse scroll callback.

bool	keyboardShortcutEvent (uint32_t shortcutCode, bool state, uint repeat)
	Notify the Widget of a keyboard shortcut invocation. More...

void	setKeyboardShortcutCallback (KeyboardShortcutCallback keyboardShortcutCallback)
	Set the keyboard shortcut callback.

bool	keyTextInputEvent (const std::string &text)
	Notify the Widget of text input. More...

void	setTextInputCallback (TextInputCallback textInputCallback)
	Set the text input callback.

bool	supportsKeyboardFocus () const

bool	keyboardFocusEvent (bool hasFocus)
	Notify the Widget when it gains or looses keyboard focus. More...

void	setKeyboardFocusCallback (KeyboardFocusCallback keyboardFocusCallback)
	Set the keyboard focus callback.

bool	keyboardEvent (const SDL_KeyboardEvent &keyboardEvent)

void	setKeyboardEvent (KeyboardEventCallback keyboardEventCallback)

Public Member Functions inherited from rose::Visual
void	setScreenRectangle (const Position< int > &containerPosition)
	Compute the screen rectangle from the Container screen Position. More...

Rectangle	getScreenRectangle (const Position< int > &containerPosition) const
	Get the rectangle occupied by the Visual. More...

Position< int >	drawPadding (const Position< int > &containerPosition)
	Pad the drawing location.

Rectangle	layoutPadding (const Rectangle &screenRect)
	Pad the layout.

void	setSize (const Size &size)
	Set preferred Size.

Size	getSize () const
	Get the preferred size.

void	setPosition (const Position< int > &position)
	Set preferred Position.

Position< int >	getPosition () const
	Get the preferred Position.

void	setPadding (const Padding &padding)
	Set Padding.

void	setScreenRectangle (const Rectangle &screenRect)
	Set Screen Rectangle.

constexpr bool	isVisible () const noexcept
	Check visibility.

void	setVisible (bool visible) noexcept
	Set visibility.

void	setLayoutHint (const LayoutHint &hint)
	Add a LayoutHint.

std::optional< int >	getAttachmentHint (LayoutHint::Attachment attachment)
	Get an AttachmentHint value given a LayoutHint::Attachment. More...

std::optional< int >	getGridHint (LayoutHint::GridLayoutHint gridLayoutHint)
	Get a GridLayoutHint value given a LayoutHint::GridLayoutHint. More...

template<size_t HintClass>
std::optional< const ValueMap >	getHintMap () const

SemanticGesture	supportedSemanticGestures () const
	Get supported SemanticGestures.

Public Member Functions inherited from rose::Container
virtual void	add (const std::shared_ptr< Node > &node)

void	remove (const std::shared_ptr< Node > &node)

Public Member Functions inherited from rose::Node
	Node (const std::shared_ptr< Container > &container)
	Create a node and add it to a Container. More...

void	setId (const Id &nodeId) noexcept
	Set Id.

std::string_view	getId () const
	Get Id.

IdPath	getIdPath () const
	Get the Id Path.

std::shared_ptr< Container >	container ()

std::shared_ptr< Container >	container () const

template<typename C >
std::shared_ptr< C >	containerAs ()

template<typename C >
std::shared_ptr< C >	containerAs () const

std::shared_ptr< const Node >	getNode () const
	Get a const std::shared_ptr to this node. More...

std::shared_ptr< Node >	getNode ()
	Get a std::shared_ptr to this node. More...

template<typename NodeType >
std::shared_ptr< const Node >	getNode () const
	Get a std::shared_ptr<const NodeType> to this node. More...

template<typename NodeType >
std::shared_ptr< NodeType >	getNode ()
	Get a std::shared_ptr<NodeType> to this node. More...

std::shared_ptr< Node >	remove ()

Static Public Member Functions
static void	throwContainerError ()

Static Public Member Functions inherited from rose::Node
template<typename NodeType >
static std::shared_ptr< NodeType >	create ()
	Create a Node with no arguments. More...

template<typename NodeType , typename ... Args>
static std::shared_ptr< NodeType >	create (Args ... args)
	Create a Node with arguments. More...

template<typename NodeType , typename ContainerType , typename ... Args>
static std::shared_ptr< NodeType >	add (ContainerType container, Args ... args)
	Create a Node with arguments and add to a Container. More...

Static Public Attributes
static constexpr std::string_view	id = "CelestialOverlay"

Static Public Attributes inherited from rose::Widget
static constexpr std::string_view	id = "Widget"

Static Public Attributes inherited from rose::Container
static constexpr std::string_view	id = "Container"

Static Public Attributes inherited from rose::Node
static constexpr std::string_view	id = "Node"

Protected Attributes
std::array< ImageId, CelestialOverlayFileName.size()>	mMapOverlayId {}

TickProtocol::slot_type	mCelestialUpdateTimer {}
	Slot to receive celestial update time signals on.

bool	mDisplayCelestialObjects {true}
	If true celestial objects (Sun, Moon) will be displayed.

SatelliteObservation	mCelestialObservations
	The last calculated celestial observations.

GeoPosition	mSubSolar {}
	The geographic sub-solar position.

GeoPosition	mSubLunar {}
	The geographic sub-lunar position.

SatelliteObservation	mSatelliteObservation
	The last calculated observations.

std::filesystem::path	mXdgDataPath
	Path to the XDG application data directory.

std::shared_ptr< TimerTick >	mTimerTick {}
	Source of timing information.

Protected Attributes inherited from rose::Widget
EventCallback	mEnterEventCallback {}
	The pointer has entered the Widget.

EventCallback	mLeaveEventCallback {}
	The pointer has left the Widget.

ButtonCallback	mButtonEventCallback {}
	The pointer button has been pressed with the pointer inside the Widget.

MouseMotionCallback	mMouseMotionCallback {}
	The pointer is in motion, inside the Widget with a button pressed.

ScrollCallback	mMouseScrollCallback {}
	The mouse scroll wheel has moved with the pointer inside the Widget.

KeyboardShortcutCallback	mKeyboardShortcutCallback {}
	A keyboard button event while the Widget has keyboard focus.

TextInputCallback	mTextInputCallback {}
	A text input event while the Widget has keyboard focus.

KeyboardFocusCallback	mKeyboardFocusCallback {}
	Notification that this Widget has gained or lost keyboard focus.

KeyboardEventCallback	mKeyboardEventCallback {}
	Notification that this Widget has received a keyboard event.

Protected Attributes inherited from rose::Visual
SemanticGesture	mSemanticGesture {}

Position< int >	mPos {}
	Position relative to the container, arrived at by layout.

Size	mSize {}
	The size on screen, arrived at by layout.

Position< int >	mPreferredPos {}
	The preferred position.

Size	mPreferredSize {}
	The preferred size.

Rectangle	mScreenRect {}
	The screen Rectangle computed at drawing time.

Padding	mPadding {}
	Immediately around the Visual, used for separation and alignment.

State	mState {}
	The object state Id string.

bool	mVisible {true}
	If true the object is visible.

Protected Attributes inherited from rose::Node
std::weak_ptr< Container >	mContainer {}
	The Container that holds the Node. More...

Id	mId {}

Static Protected Attributes
static constexpr std::array< OverlayImageSpec, static_cast< size_t >MapOverLayImage::Count)>	CelestialOverlayFileName

Additional Inherited Members
Public Types inherited from rose::Visual
using	ValueMap = std::map< int, int >
	The std::map type for each hint class.

Public Types inherited from rose::Node
using	NodePtr = std::shared_ptr< Node >

Public Attributes inherited from rose::Visual
std::map< size_t, ValueMap >	mHintsMap {}
	The std::map of hint class to ValueMap.

Detailed Description

Add observable celestial objects to MapProjection.

The CelestialOverlay is designed to display icons representing the positions of the Sun and Moon on the Earth overlaid on a MapProjection. The CelestialOverlay can only be added to a MapProjection and communicates with the MapProjection to match display with the MapOverlay.

Member Function Documentation

◆ addedToContainer()

void rose::CelestialOverlay::addedToContainer ( )

overridevirtual

Called when added to a container.

Connects the map slot receiver for notification when maps are loaded, then calls cacheCurrentMaps().

Reimplemented from rose::Node.

Member Data Documentation

◆ CelestialOverlayFileName

constexpr std::array<OverlayImageSpec,static_cast<size_t>MapOverLayImage::Count)> rose::CelestialOverlay::CelestialOverlayFileName

staticprotected

Initial value:

{{
                         { MapOverLayImage::Sun, "35px-SunBg.png" },
                         { MapOverLayImage::Moon, "moon22.png"},
                 }}

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

applications/Chrono/CelestialOverlay.h
applications/Chrono/CelestialOverlay.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addedToContainer()

Member Data Documentation

◆ CelestialOverlayFileName