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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

feat(cli/lib): use scene background color as default #160

Merged
merged 8 commits into from
Mar 22, 2023
Merged

feat(cli/lib): use scene background color as default #160

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bec16f2
Use scene background color as default
Fairlight8 Mar 16, 2023
561afc9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 17, 2023
b6f527b
Merge branch 'jeertmans:main' into main
Fairlight8 Mar 21, 2023
4b4b886
Minor changes to feature: Read scene background
Fairlight8 Mar 22, 2023
1a19b41
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 22, 2023
c4ca277
Small fix for feature "Read bg color"
Fairlight8 Mar 22, 2023
3c6cf94
chore(ci): add typing ignore
jeertmans Mar 22, 2023
e027a21
fix(ci): typo
jeertmans Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions manim_slides/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ class PresentationConfig(BaseModel): # type: ignore
slides: List[SlideConfig]
files: List[FilePath]
resolution: Tuple[PositiveInt, PositiveInt] = (1920, 1080)
background_color: str = "black"
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
background_color: str = "black"
background_color: str = Color

Please use the Color type from Pydantic: https://docs.pydantic.dev/usage/types/#color-type.


@root_validator
def animation_indices_match_files(
Expand Down
4 changes: 2 additions & 2 deletions manim_slides/convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,9 @@ def get_sections_iter(self, assets_dir: Path) -> Generator[str, None, None]:
# Read more about this:
# https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide#autoplay_and_autoplay_blocking
if slide_config.is_loop():
yield f'<section data-background-size={self.background_size.value} data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
yield f'<section data-background-size={self.background_size.value} data-background-color="{presentation_config.background_color}" data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
else:
yield f'<section data-background-size={self.background_size.value} data-background-video="{file}" data-background-video-muted></section>'
yield f'<section data-background-size={self.background_size.value} data-background-color="{presentation_config.background_color}" data-background-video="{file}" data-background-video-muted></section>'

def load_template(self) -> str:
"""Returns the RevealJS HTML template as a string."""
Expand Down
22 changes: 18 additions & 4 deletions manim_slides/present.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ def resolution(self) -> Tuple[int, int]:
"""Returns the resolution."""
return self.config.resolution

@property
def background_color(self) -> str:
"""Returns the background color."""
return self.config.background_color

@property
def current_slide_index(self) -> int:
return self.__current_slide_index
Expand Down Expand Up @@ -647,7 +652,9 @@ def __init__(
self.label.setScaledContents(True)
self.label.setAlignment(Qt.AlignCenter)
self.label.resize(self.display_width, self.display_height)
self.label.setStyleSheet(f"background-color: {background_color}")
self.label.setStyleSheet(
f"background-color: {self.thread.current_presentation.background_color}"
)

self.pixmap = QPixmap(self.width(), self.height())
self.label.setPixmap(self.pixmap)
Expand Down Expand Up @@ -727,6 +734,9 @@ def update_canvas(self) -> None:
self.display_width, self.display_height = self.thread.current_resolution
if not self.isFullScreen():
self.resize(self.display_width, self.display_height)
self.label.setStyleSheet(
f"background-color: {self.thread.current_presentation.background_color}"
)
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
self.label.setStyleSheet(
f"background-color: {self.thread.current_presentation.background_color}"
)
self.label.setStyleSheet(
f"background-color: {self.thread.current_background_color}"
)

For readability, create a current_background_color property :-)



@click.command()
Expand Down Expand Up @@ -922,8 +932,8 @@ def str_to_int_or_none(value: str) -> Optional[int]:
"background_color",
metavar="COLOR",
type=str,
default="black",
help='Set the background color for borders when using "keep" resize mode. Can be any valid CSS color, e.g., "green", "#FF6500" or "rgba(255, 255, 0, .5)".',
default=None,
help='Set the background color for borders when using "keep" resize mode. Can be any valid CSS color, e.g., "green", "#FF6500" or "rgba(255, 255, 0, .5)". If not set, it defaults to the background color configured in the Manim scene.',
show_default=True,
)
@click.option(
Expand Down Expand Up @@ -978,7 +988,7 @@ def present(
hide_mouse: bool,
aspect_ratio: str,
resize_mode: str,
background_color: str,
background_color: Optional[str],
start_at: Tuple[Optional[int], Optional[int], Optional[int]],
start_at_scene_number: Optional[int],
start_at_slide_number: Optional[int],
Expand All @@ -1003,6 +1013,10 @@ def present(
for presentation_config in presentation_configs:
presentation_config.resolution = resolution

if background_color is not None:
for presentation_config in presentation_configs:
presentation_config.background_color = background_color

Comment on lines +1024 to +1027
Copy link
Owner

Choose a reason for hiding this comment

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

I think you need to remove the background_color option from App :-)

presentations = [
Presentation(presentation_config)
for presentation_config in presentation_configs
Expand Down
6 changes: 5 additions & 1 deletion manim_slides/slide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def __init__(
self.__current_animation = 0
self.__loop_start_animation: Optional[int] = None
self.__pause_start_animation = 0
self.__background_color = config["background_color"].hex
Copy link
Owner

Choose a reason for hiding this comment

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

This does not work because the background_color attribute is not placed in config with ManimGL. So you need to a separate implementation, as with __resolution:

manim-slides/manim_slides/slide.py

Lines 57 to 63 in 2a327c4

@property
def __resolution(self) -> Tuple[int, int]:
"""Returns the scene's resolution used during rendering."""
if MANIMGL:
return self.camera_config["pixel_width"], self.camera_config["pixel_height"]
else:
return config["pixel_width"], config["pixel_height"]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, I Didn't know, understood!


@property
def __resolution(self) -> Tuple[int, int]:
Expand Down Expand Up @@ -321,7 +322,10 @@ def __save_slides(self, use_cache: bool = True) -> None:
with open(slide_path, "w") as f:
f.write(
PresentationConfig(
slides=self.__slides, files=files, resolution=self.__resolution
slides=self.__slides,
files=files,
resolution=self.__resolution,
background_color=self.__background_color,
).json(indent=2)
)

Expand Down