Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorScrollEngine::StripAxis Class Reference

Coordinate mapping for one strip orientation: a pure value type, trivially copyable, no allocation, cheap enough to read once per column and once per tile inside the relayout loop. More...

#include <PhosphorScrollEngine/StripAxis.h>

Public Member Functions

constexpr StripAxis ()=default
constexpr StripAxis (PhosphorProtocol::ScrollAxis axis)
constexpr PhosphorProtocol::ScrollAxis axis () const
constexpr bool isHorizontal () const
constexpr bool isVertical () const
 The negative of isHorizontal, spelled out.
constexpr StripAxis transposed () const
 Main and cross exchanged.
constexpr int mainPos (const QRect &r) const
constexpr int crossPos (const QRect &r) const
constexpr int mainSize (const QRect &r) const
constexpr int crossSize (const QRect &r) const
constexpr int mainSize (const QSize &s) const
constexpr int crossSize (const QSize &s) const
constexpr int mainPos (const QPoint &p) const
constexpr int crossPos (const QPoint &p) const
constexpr int mainLow (const QRect &r) const
 Inclusive low / high edges, matching QRect's own semantics where right() and bottom() are the LAST CONTAINED pixel rather than one past.
constexpr int mainHigh (const QRect &r) const
constexpr int crossLow (const QRect &r) const
constexpr int crossHigh (const QRect &r) const
constexpr QRect makeRect (int mainPosition, int crossPosition, int mainExtent, int crossExtent) const
 Build a rect from role coordinates.
constexpr void setMainLow (QRect &r, int v) const
 setLeft/setTop equivalent: MOVES the low edge and HOLDS the high edge, so it changes both position and extent.
constexpr void setMainHigh (QRect &r, int v) const
constexpr void setCrossHigh (QRect &r, int v) const
constexpr void moveMain (QRect &r, int v) const
 Reposition without resizing, unlike the setters above.
constexpr QRect translatedMain (const QRect &r, int delta) const
 Translate along the MAIN axis only — the view slide.
constexpr bool operator== (const StripAxis &other) const
constexpr bool operator!= (const StripAxis &other) const

Static Public Member Functions

static constexpr StripAxis horizontal ()
static constexpr StripAxis vertical ()

Detailed Description

Coordinate mapping for one strip orientation: a pure value type, trivially copyable, no allocation, cheap enough to read once per column and once per tile inside the relayout loop.

Every accessor is named for the ROLE (main / cross), never the physical axis. MAIN is the strip — columns lie along it and the view scrolls along it. CROSS is the within-column stack. For Horizontal, main = x and cross = y, and every accessor below is the identity mapping, which is what makes the transposition rewrite land behaviour-preserving.

A call site that still needs a physical x or y is by definition NOT transposing and must say so in a comment. There are two legitimate cases: the park position (which means "off every output", a claim independent of strip direction) and the tab indicator's screen-edge vocabulary (a user who asked for an indicator on the left means the left of their screen).

THIS TYPE MAPS COORDINATES; IT NEVER INTERPRETS USER INTENT. The direction-token to role remap belongs with the navigation verbs, not here — geometry transposition and input-intent transposition are different problems and must not share an object.

Constructor & Destructor Documentation

◆ StripAxis() [1/2]

PhosphorScrollEngine::StripAxis::StripAxis ( )
constexprdefault

◆ StripAxis() [2/2]

PhosphorScrollEngine::StripAxis::StripAxis ( PhosphorProtocol::ScrollAxis axis)
inlineexplicitconstexpr

Member Function Documentation

◆ axis()

PhosphorProtocol::ScrollAxis PhosphorScrollEngine::StripAxis::axis ( ) const
inlineconstexpr

◆ crossHigh()

int PhosphorScrollEngine::StripAxis::crossHigh ( const QRect & r) const
inlineconstexpr

◆ crossLow()

int PhosphorScrollEngine::StripAxis::crossLow ( const QRect & r) const
inlineconstexpr

◆ crossPos() [1/2]

int PhosphorScrollEngine::StripAxis::crossPos ( const QPoint & p) const
inlineconstexpr

◆ crossPos() [2/2]

int PhosphorScrollEngine::StripAxis::crossPos ( const QRect & r) const
inlineconstexpr

◆ crossSize() [1/2]

int PhosphorScrollEngine::StripAxis::crossSize ( const QRect & r) const
inlineconstexpr

◆ crossSize() [2/2]

int PhosphorScrollEngine::StripAxis::crossSize ( const QSize & s) const
inlineconstexpr

◆ horizontal()

constexpr StripAxis PhosphorScrollEngine::StripAxis::horizontal ( )
inlinestaticconstexpr

◆ isHorizontal()

bool PhosphorScrollEngine::StripAxis::isHorizontal ( ) const
inlineconstexpr

◆ isVertical()

bool PhosphorScrollEngine::StripAxis::isVertical ( ) const
inlineconstexpr

The negative of isHorizontal, spelled out.

Callers that want the vertical case were reaching through axis() to compare the wire enum, which puts the protocol type in the middle of a question this object already answers.

◆ mainHigh()

int PhosphorScrollEngine::StripAxis::mainHigh ( const QRect & r) const
inlineconstexpr

◆ mainLow()

int PhosphorScrollEngine::StripAxis::mainLow ( const QRect & r) const
inlineconstexpr

Inclusive low / high edges, matching QRect's own semantics where right() and bottom() are the LAST CONTAINED pixel rather than one past.

◆ mainPos() [1/2]

int PhosphorScrollEngine::StripAxis::mainPos ( const QPoint & p) const
inlineconstexpr

◆ mainPos() [2/2]

int PhosphorScrollEngine::StripAxis::mainPos ( const QRect & r) const
inlineconstexpr

◆ mainSize() [1/2]

int PhosphorScrollEngine::StripAxis::mainSize ( const QRect & r) const
inlineconstexpr

◆ mainSize() [2/2]

int PhosphorScrollEngine::StripAxis::mainSize ( const QSize & s) const
inlineconstexpr

◆ makeRect()

QRect PhosphorScrollEngine::StripAxis::makeRect ( int mainPosition,
int crossPosition,
int mainExtent,
int crossExtent ) const
inlineconstexpr

Build a rect from role coordinates.

The ONE constructor every resolved rect should go through.

◆ moveMain()

void PhosphorScrollEngine::StripAxis::moveMain ( QRect & r,
int v ) const
inlineconstexpr

Reposition without resizing, unlike the setters above.

◆ operator!=()

bool PhosphorScrollEngine::StripAxis::operator!= ( const StripAxis & other) const
inlineconstexpr

◆ operator==()

bool PhosphorScrollEngine::StripAxis::operator== ( const StripAxis & other) const
inlineconstexpr

◆ setCrossHigh()

void PhosphorScrollEngine::StripAxis::setCrossHigh ( QRect & r,
int v ) const
inlineconstexpr

◆ setMainHigh()

void PhosphorScrollEngine::StripAxis::setMainHigh ( QRect & r,
int v ) const
inlineconstexpr

◆ setMainLow()

void PhosphorScrollEngine::StripAxis::setMainLow ( QRect & r,
int v ) const
inlineconstexpr

setLeft/setTop equivalent: MOVES the low edge and HOLDS the high edge, so it changes both position and extent.

setMainHigh is the mirror. That asymmetry is QRect's own, and it is load-bearing for the straddle clamp's pinned-position test — do not "fix" either into a move.

◆ translatedMain()

QRect PhosphorScrollEngine::StripAxis::translatedMain ( const QRect & r,
int delta ) const
inlineconstexpr

Translate along the MAIN axis only — the view slide.

The cross coordinate is left exactly as it was.

◆ transposed()

StripAxis PhosphorScrollEngine::StripAxis::transposed ( ) const
inlineconstexpr

Main and cross exchanged.

NO engine call site uses this today — it completes the role algebra for embedders of this library (a consumer reasoning about the cross axis in main-axis vocabulary should not hand-roll the flip), and the unit tests pin the involution.

◆ vertical()

constexpr StripAxis PhosphorScrollEngine::StripAxis::vertical ( )
inlinestaticconstexpr

The documentation for this class was generated from the following file:
  • phosphor-scroll-engine/include/PhosphorScrollEngine/StripAxis.h