Singleton mini-map providing normalised graph overview data. More...

#include <MiniMapPanel.h>

Public Member Functions
void	SetGraphBounds (float minX, float maxX, float minY, float maxY)
	Sets the full bounds of the graph in graph space.

void	SetViewport (float minX, float maxX, float minY, float maxY)
	Sets the currently visible viewport in graph space.

void	UpdateNodePositions (const std::vector< std::pair< int, std::pair< float, float > > > &rawPositions)
	Updates the normalised node positions from raw (id, x, y) triples.

const std::vector< MiniMapNodeEntry > &	GetNodes () const
	Returns the normalised node positions for rendering.

void	GetViewportRect (float &outX, float &outY, float &outW, float &outH) const
	Returns the normalised viewport rectangle.

bool	IsVisible () const
	Returns true when the mini-map has valid data to display.

bool	HandleClick (float clickNX, float clickNY, float &outScrollX, float &outScrollY) const
	Converts a click on the mini-map into a graph-scroll target.

Static Public Member Functions
static MiniMapPanel &	Get ()
	Returns the single shared instance.

Static Public Attributes
static constexpr float	PANEL_WIDTH = 200.0f
	Default panel width in screen px.

static constexpr float	PANEL_HEIGHT = 150.0f
	Default panel height in screen px.

Private Member Functions
	MiniMapPanel ()

float	Normalise (float value, float minVal, float maxVal) const

Private Attributes
float	m_GraphMinX

float	m_GraphMaxX

float	m_GraphMinY

float	m_GraphMaxY

float	m_ViewMinX

float	m_ViewMaxX

float	m_ViewMinY

float	m_ViewMaxY

std::vector< MiniMapNodeEntry >	m_Nodes

bool	m_IsVisible

Detailed Description

Singleton mini-map providing normalised graph overview data.

Typical usage:

auto& mm = MiniMapPanel::Get();
mm.SetGraphBounds(minX, maxX, minY, maxY);
mm.SetViewport(viewMinX, viewMaxX, viewMinY, viewMaxY);
mm.UpdateNodePositions(rawPositions);
 
// Render thumbnail using GetNodes() and GetViewportRect()
auto [vpX, vpY, vpW, vpH] = mm.GetViewportRect();  // C++14: use structured float4

Definition at line 57 of file MiniMapPanel.h.

Constructor & Destructor Documentation

◆ MiniMapPanel()

Olympe::MiniMapPanel::MiniMapPanel ( )

private

Definition at line 24 of file MiniMapPanel.cpp.

Member Function Documentation

◆ Get()

MiniMapPanel & Olympe::MiniMapPanel::Get ( )

static

Returns the single shared instance.

Definition at line 18 of file MiniMapPanel.cpp.

◆ GetNodes()

const std::vector< MiniMapNodeEntry > & Olympe::MiniMapPanel::GetNodes ( ) const

Returns the normalised node positions for rendering.

Definition at line 90 of file MiniMapPanel.cpp.

References m_Nodes.

◆ GetViewportRect()

void Olympe::MiniMapPanel::GetViewportRect	(	float &	outX,
		float &	outY,
		float &	outW,
		float &	outH
	)		const

Returns the normalised viewport rectangle.

Parameters

outX	Left edge [0..1]
outY	Top edge [0..1]
outW	Width [0..1]
outH	Height [0..1]

Definition at line 95 of file MiniMapPanel.cpp.

References GetComponentTypeID_Static(), m_GraphMaxX, m_GraphMaxY, m_GraphMinX, m_GraphMinY, m_ViewMaxX, m_ViewMaxY, m_ViewMinX, m_ViewMinY, and Normalise().

Here is the call graph for this function:

◆ HandleClick()

bool Olympe::MiniMapPanel::HandleClick	(	float	clickNX,
		float	clickNY,
		float &	outScrollX,
		float &	outScrollY
	)		const

Converts a click on the mini-map into a graph-scroll target.

Parameters

clickNX	Normalised X of the click on the mini-map [0..1].
clickNY	Normalised Y of the click on the mini-map [0..1].
outScrollX	Target scroll X in graph space.
outScrollY	Target scroll Y in graph space.

Definition at line 120 of file MiniMapPanel.cpp.

References GetComponentTypeID_Static(), m_GraphMaxX, m_GraphMaxY, m_GraphMinX, and m_GraphMinY.

Here is the call graph for this function: