Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: relative position helpers #2051

Open
wants to merge 6 commits into
base: development
Choose a base branch
from
Open
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions arcade/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,30 @@ def on_mouse_leave(self, x: int, y: int):
"""
pass

def absolute(self, fractional_pos: tuple[float, float]) -> tuple[float, float]:
"""Convert a relative fractional pair to absolute screen pixels.

As in the rest of arcade and OpenGL, the default coordinate system
places the origin at the bottom left.

:param fractional_pos: A position where the x and y are fractional
values of the window size.
:returns: A tuple of absolute pixel X and Y relative to bottom left.
"""
Comment on lines +918 to +927
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring just seems to academic and lacks contex/example. It's unclear what "fractional pair" is. Also unsure is the method name itself is clear.

w, h = self.size
frac_x, frac_y = fractional_pos
return frac_x * w, frac_y * h

def relative(self, pixel_pos: tuple[float, float]) -> tuple[float, float]:
"""Convert absolute screen pixels to a relative fractional pair.

:param pixel_pos: a tuple of X and Y pixel positions within the window.
:returns: A tuple of fractional X and Y relative to the bottom left.
Comment on lines +932 to +936
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring just seems to academic and lacks contex/example. It's unclear what "fractional pair" is. Also unsure is the method name itself is clear.

"""
w, h = self.size
pixel_x, pixel_y = pixel_pos
return pixel_x / w, pixel_y / pixel_y
DigiDuncan marked this conversation as resolved.
Show resolved Hide resolved


def open_window(
width: int,
Expand Down