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

Allow subscribing to the "drag" event for ui.scene #3466

Merged
merged 2 commits into from
Aug 10, 2024
Merged

Allow subscribing to the "drag" event for ui.scene #3466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a0c968
allow receiving drag events
falkoschindler Aug 9, 2024
088f41b
add a demo to the documentation
falkoschindler Aug 9, 2024
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
4 changes: 2 additions & 2 deletions nicegui/elements/scene.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,6 @@ export default {
};
const handleDrag = (event) => {
this.drag_constraints.split(",").forEach((constraint) => applyConstraint(constraint, event.object.position));
if (event.type === "drag") return;
this.$emit(event.type, {
type: event.type,
object_id: event.object.object_id,
Expand All @@ -158,7 +157,8 @@ export default {
y: event.object.position.y,
z: event.object.position.z,
});
this.controls.enabled = event.type == "dragend";
if (event.type === "dragstart") this.controls.enabled = false;
if (event.type === "dragend") this.controls.enabled = true;
};
this.drag_controls.addEventListener("dragstart", handleDrag);
this.drag_controls.addEventListener("drag", handleDrag);
Expand Down
22 changes: 22 additions & 0 deletions website/documentation/content/scene_documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,28 @@ def handle_drag(e: events.SceneDragEventArguments):
on_change=lambda e: sphere.draggable(e.value))


@doc.demo('Subscribe to the drag event', '''
By default, a draggable object is only updated when the drag ends to avoid performance issues.
But you can explicitly subscribe to the "drag" event to get immediate updates.
In this demo we update the position and size of a box based on the positions of two draggable spheres.
''')
def immediate_updates() -> None:
from nicegui import events

with ui.scene(drag_constraints='z=0') as scene:
box = scene.box(1, 1, 0.2).move(0, 0).material('Orange')
sphere1 = scene.sphere(0.2).move(0.5, -0.5).material('SteelBlue').draggable()
sphere2 = scene.sphere(0.2).move(-0.5, 0.5).material('SteelBlue').draggable()

def handle_drag(e: events.GenericEventArguments) -> None:
x1 = sphere1.x if e.args['object_id'] == sphere2.id else e.args['x']
y1 = sphere1.y if e.args['object_id'] == sphere2.id else e.args['y']
x2 = sphere2.x if e.args['object_id'] == sphere1.id else e.args['x']
y2 = sphere2.y if e.args['object_id'] == sphere1.id else e.args['y']
box.move((x1 + x2) / 2, (y1 + y2) / 2).scale(x2 - x1, y2 - y1, 1)
scene.on('drag', handle_drag)


@doc.demo('Rendering point clouds', '''
You can render point clouds using the `point_cloud` method.
The `points` argument is a list of point coordinates, and the `colors` argument is a list of RGB colors (0..1).
Expand Down
Loading