vpype_viewer.Engine#
- class Engine(view_mode: ~vpype_viewer.engine.ViewMode = ViewMode.OUTLINE, show_pen_up: bool = False, show_points: bool = False, show_rulers: bool = True, default_pen_width: float = 1.1, default_pen_opacity: float = 0.8, override_pen_width: bool = False, override_pen_opacity: bool = False, render_cb: ~typing.Callable[[], None] = <function Engine.<lambda>>)#
OpenGL-based rendering engine for
vpype.Document
.Methods
Fit the current document in the viewport, allowing for a 2.5% margin on either sides.
True if the corresponding layer is currently visible.
Pan the viewport.
Post-init configuration to provide a GL context.
Execute a render.
Resizes the viewport.
Toggles the visibility of the provided layer.
Converts viewport coordinates to model coordinates in pixels.
Zoom the viewport.
Attributes
Debug mode for display.
Pen opacity used for rendering (preview only).
Pen width used for rendering (preview only).
vpype.Document
being displayed.Current origin (document coordinates corresponding to the display window's top-left corner.
Disregard pen opacity from properties (preview only).
Disregard pen opacity from properties (preview only).
Current scale (ratio screen pixel per document pixel)
True if pen-up trajectories are rendered.
True if points are rendered.
Current view mode.
Methods#
- Engine._get_projection() ndarray #
- Return type:
ndarray
- Engine._rebuild()#
- Engine._update(rebuild=True)#
- Engine.fit_to_viewport()#
Fit the current document in the viewport, allowing for a 2.5% margin on either sides.
- Engine.post_init(ctx: Context, width: int = 100, height: int = 100)#
Post-init configuration to provide a GL context.
- Engine.render()#
Execute a render.
- Engine.resize(width: int, height: int) None #
Resizes the viewport. :param width: new viewport width :param height: new viewport height
- Engine.toggle_layer_visibility(layer_id: int) None #
Toggles the visibility of the provided layer.
- Parameters:
layer_id (int) -- layer to toggle
- Return type:
None
- Engine.viewport_to_model(x: float, y: float) tuple[float, float] #
Converts viewport coordinates to model coordinates in pixels.
Attributes#
- Engine.debug#
Debug mode for display.
- Engine.default_pen_opacity#
Pen opacity used for rendering (preview only).
- Engine.default_pen_width#
Pen width used for rendering (preview only).
- Engine.document#
vpype.Document
being displayed.
- Engine.height#
- Engine.origin#
Current origin (document coordinates corresponding to the display window’s top-left corner.
- Engine.override_pen_opacity#
Disregard pen opacity from properties (preview only).
- Engine.override_pen_width#
Disregard pen opacity from properties (preview only).
- Engine.pixel_factor#
- Engine.scale#
Current scale (ratio screen pixel per document pixel)
- Engine.scale_spec#
- Engine.show_pen_up#
True if pen-up trajectories are rendered.
- Engine.show_points#
True if points are rendered.
- Engine.show_rulers#
- Engine.unit_type#
- Engine.view_mode#
Current view mode.
- Engine.width#