Skip to content

code_video.CodeScene

This class serves as a convenience class for animating code walkthroughs in as little work as possible. For more control, use Code or PartialCode with the HighlightLines and HighlightNone transitions directly.

`add_background(self, path)`

Adds a full screen background image. The image will be stretched to the full width.

Parameters:

Name	Type	Description	Default
`path`	`str`	The file path of the image file	required

Source code in code_video/scene.py

def add_background(self, path: str) -> ImageMobject:
    """
    Adds a full screen background image. The image will be stretched to the full width.

    Args:
        path: The file path of the image file
    """

    background = ImageMobject(path, height=self.camera_frame.get_height())
    background.stretch_to_fit_width(self.camera_frame.get_width())
    self.add(background)
    return background

`add_background_music(self, path)`

Adds background music for the video. Can be combined with wait_util_beat or wait_until_measure to automatically time animations

Parameters:

Name	Type	Description	Default
`path`	`str`	The file path of the music file, usually an mp3 file.	required

Source code in code_video/scene.py

def add_background_music(self, path: str) -> CodeScene:
    """
    Adds background music for the video. Can be combined with
    `wait_util_beat` or
    `wait_until_measure` to automatically time
    animations

    Args:
        path: The file path of the music file, usually an mp3 file.

    """
    self.music = BackgroundMusic(path)
    return self

`animate_code_comments(self, path, title=None, keep_comments=False, start_line=1, end_line=None, reset_at_end=True)`

Parses a code file, displays it or a section of it, and animates comments

Parameters:

Name	Type	Description	Default
`path`	`str`	The source code file path	required
`title`	`str`	The title or file path if not provided	`None`
`keep_comments`	`bool`	Whether to keep comments or strip them when displaying	`False`
`start_line`	`int`	The start line number, used for displaying only a partial file	`1`
`end_line`	`Optional[int]`	The end line number, defaults to the end of the file	`None`
`reset_at_end`	`bool`	Whether to reset the code to full screen at the end or not	`True`

Source code in code_video/scene.py

def animate_code_comments(
    self,
    path: str,
    title: str = None,
    keep_comments: bool = False,
    start_line: int = 1,
    end_line: Optional[int] = None,
    reset_at_end: bool = True,
) -> Code:
    """
    Parses a code file, displays it or a section of it, and animates comments

    Args:
        path: The source code file path
        title: The title or file path if not provided
        keep_comments: Whether to keep comments or strip them when displaying
        start_line: The start line number, used for displaying only a partial file
        end_line: The end line number, defaults to the end of the file
        reset_at_end: Whether to reset the code to full screen at the end or not
    """
    code, comments = comment_parser.parse(
        path, keep_comments=keep_comments, start_line=start_line, end_line=end_line
    )

    tex = AutoScaled(PartialCode(code=code, line_no_from=start_line, style=self.code_theme))
    if title is None:
        title = path

    title = Text(title, color=WHITE).to_edge(edge=UP)
    self.add(title)
    tex.next_to(title, DOWN)

    self.play(ShowCreation(tex))
    self.wait()

    for comment in comments:
        self.highlight_lines(tex, comment.start, comment.end, comment.caption)

    if self.caption:
        self.play(FadeOut(self.caption))
        self.caption = None

    if reset_at_end:
        self.play(HighlightNone(tex))
        self.play(ApplyMethod(tex.full_size))
    return tex

`create_code(self, path, **kwargs)`

Convenience method for creating an autoscaled code object.

Parameters:

Name	Type	Description	Default
`path`	`str`	The source code file path	required

Source code in code_video/scene.py

def create_code(self, path: str, **kwargs) -> Code:
    """
    Convenience method for creating an autoscaled code object.

    Args:
        path: The source code file path
    """
    return AutoScaled(Code(path, font=self.code_font, style=self.code_theme, **kwargs))

`highlight_line(self, code, number=-1, caption=None)`

Convenience method for highlighting a single line

Parameters:

Name	Type	Description	Default
`code`	`AutoScaled`	The code object, must be wrapped in `AutoScaled`	required
`number`	`int`	The line number	`-1`
`caption`	`Optional[str]`	The text to display with the highlight	`None`

Source code in code_video/scene.py

def highlight_line(self, code: AutoScaled, number: int = -1, caption: Optional[str] = None):
    """
    Convenience method for highlighting a single line

    Args:
        code: The code object, must be wrapped in `AutoScaled`
        number: The line number
        caption: The text to display with the highlight
    """
    return self.highlight_lines(code, number, number, caption=caption)

`highlight_lines(self, code, start=1, end=-1, caption=None)`

Convenience method for animating a code object.

Parameters:

Name	Type	Description	Default
`code`	`Code`	The code object, must be wrapped in `AutoScaled`	required
`start`	`int`	The start line number	`1`
`end`	`int`	The end line number, defaults to the end of the file	`-1`
`caption`	`Optional[str]`	The text to display with the highlight	`None`

Source code in code_video/scene.py

def highlight_lines(self, code: Code, start: int = 1, end: int = -1, caption: Optional[str] = None):
    """
    Convenience method for animating a code object.

    Args:
        code: The code object, must be wrapped in `AutoScaled`
        start: The start line number
        end: The end line number, defaults to the end of the file
        caption: The text to display with the highlight
    """

    if end == -1:
        end = len(code.line_numbers) + code.line_no_from

    layout = ColumnLayout(columns=3)

    actions = []
    if caption and not self.caption:
        self.play(
            ApplyMethod(
                code.fill_between_x,
                layout.get_x(1, span=2, direction=LEFT),
                layout.get_x(1, span=2, direction=RIGHT),
            )
        )

    if self.caption:
        actions.append(FadeOut(self.caption))
        self.caption = None

    if not caption:
        self.play(ApplyMethod(code.full_size))
    else:
        callout = TextBox(caption, text_attrs=dict(size=0.5))
        callout.align_to(code.line_numbers[start - code.line_no_from], UP)
        callout.set_x(layout.get_x(3), LEFT)
        actions += [HighlightLines(code, start, end), FadeIn(callout)]
        self.caption = callout

    self.play(*actions)

    if not self.caption:
        self.play(ApplyMethod(code.full_size))
    else:
        wait_time = len(self.caption.text) / (200 * 5 / 60)
        self.wait_until_measure(wait_time, -1.5)

`highlight_none(self, code)`

Convenience method for resetting any existing highlighting.

Parameters:

Name	Type	Description	Default
`code`	`AutoScaled`	The code object, must be wrapped in `AutoScaled`	required

Source code in code_video/scene.py

def highlight_none(self, code: AutoScaled):
    """
    Convenience method for resetting any existing highlighting.

    Args:
        code: The code object, must be wrapped in `AutoScaled`
    """
    if self.caption:
        self.play(FadeOut(self.caption), HighlightNone(code))
        self.caption = None

    self.play(ApplyMethod(code.full_size))

`wait(self, duration=1.0, stop_condition=None)`

Either waits like normal or if the codevidgen script is used and the "--slides" flag is used, it will treat these calls as breaks between slides

Source code in code_video/scene.py

def wait(self, duration=DEFAULT_WAIT_TIME, stop_condition=None):
    """
    Either waits like normal or if the codevidgen script is used and the "--slides" flag is used,
    it will treat these calls as breaks between slides
    """
    if config.get("show_slides"):
        print("In slide mode, skipping wait")
        self.pauses.append(len(self.renderer.file_writer.partial_movie_files) - 1)
    else:
        super().wait(duration, stop_condition)

`wait_until_beat(self, wait_time)`

Waits until the next music beat, only works with add_background_music

Source code in code_video/scene.py

def wait_until_beat(self, wait_time: Union[float, int]):
    """
    Waits until the next music beat, only works with `add_background_music`
    """
    if self.music:
        adjusted_delay = self.music.next_beat(self.renderer.time + wait_time) - self.renderer.time
        self.wait(adjusted_delay)
    else:
        self.wait(wait_time)

`wait_until_measure(self, wait_time, post=0)`

Waits until the next music measure, only works with add_background_music

Source code in code_video/scene.py

def wait_until_measure(self, wait_time: Union[float, int], post: Union[float, int] = 0):
    """
    Waits until the next music measure, only works with `add_background_music`
    """
    if self.music:
        adjusted_delay = self.music.next_measure(self.renderer.time + wait_time) - self.renderer.time
        adjusted_delay += post
        self.wait(adjusted_delay)

    else:
        self.wait(wait_time)