Fix placing objects via touch in editor not working sometimes #30411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…input More specifically, this fixes placement blueprints not beginning placement when using touch input while the cursor was previously outside compose area, due to the placement blueprint not existing (removed from the scene by `ComposeBlueprintContainer`).
peppy
reviewed
Oct 24, 2024
| @@ -127,6 +129,16 @@ protected override bool Handle(UIEvent e) | |||
| } | |||
| } | |||
|
|
|||
| protected override void PopIn() | |||
There was a problem hiding this comment.
Thought it may be a nice touch, no problem.
|
I think the direction seems okay. Will need some conflict resolution on tests (need to be moved to new class). |
peppy
reviewed
Oct 25, 2024
osu.Game/Screens/Edit/Compose/Components/ComposeBlueprintContainer.cs
Outdated
Show resolved
Hide resolved
|
In initial testing I can't find any edge cases that don't match previous behaviour. But reviewing this change is a bit arduous due to the amount of weird logic surrounding the placement object (and the change doesn't simplify but instead adds more new state). Will need some time to work through this. |
peppy
approved these changes
Nov 13, 2024
bdach
added a commit
to bdach/osu
that referenced
this pull request
Jan 8, 2025
- Closes ppy#31423. - Regressed in ppy#30411. Admittedly, I don't completely understand all of the pieces here, because code quality of this placement blueprint code is ALL-CAPS ATROCIOUS, but I believe the failure mode to be something along the lines of: - User activates juice stream tool, blueprint gets created in initial state. It reads in a mouse position far outside of the playfield, and sets internal positioning appropriately. - When the user moves the mouse into the bounds of the playfield, some positions update (the ones inside `UpdateTimeAndPosition()`, but the fruit markers are for *nested* objects, and `updateHitObjectFromPath()` is responsible for updating those... however, it only fires if the `editablePath.PathId` changes, which it won't here, because there is only one path vertex until the user commits the starting point of the juice stream and it's always at (0,0). - Therefore the position of the starting fruit marker remains bogus until left click, at which point the path changes and everything returns to *relative* sanity. An alternative solution that shows this hypothesis to be true follows in the diff below: diff --cc osu.Game.Rulesets.Catch/Edit/Blueprints/JuiceStreamPlacementBlueprint.cs index 7b57dac36e,7b57dac36e..21cc260462 --- a/osu.Game.Rulesets.Catch/Edit/Blueprints/JuiceStreamPlacementBlueprint.cs +++ b/osu.Game.Rulesets.Catch/Edit/Blueprints/JuiceStreamPlacementBlueprint.cs @@@ -88,10 -88,10 +88,9 @@@ namespace osu.Game.Rulesets.Catch.Edit. switch (PlacementActive) { case PlacementState.Waiting: -- if (!(result.Time is double snappedTime)) return; -- HitObject.OriginalX = ToLocalSpace(result.ScreenSpacePosition).X; -- HitObject.StartTime = snappedTime; ++ if (result.Time is double snappedTime) ++ HitObject.StartTime = snappedTime; break; case PlacementState.Active: @@@ -107,21 -107,21 +106,13 @@@ Vector2 startPosition = CatchHitObjectUtils.GetStartPosition(HitObjectContainer, HitObject); editablePath.Position = nestedOutlineContainer.Position = scrollingPath.Position = startPosition; -- updateHitObjectFromPath(); -- } -- -- private void updateHitObjectFromPath() -- { -- if (lastEditablePathId == editablePath.PathId) -- return; ++ if (lastEditablePathId != editablePath.PathId) ++ editablePath.UpdateHitObjectFromPath(HitObject); ++ lastEditablePathId = editablePath.PathId; -- editablePath.UpdateHitObjectFromPath(HitObject); ApplyDefaultsToHitObject(); -- scrollingPath.UpdatePathFrom(HitObjectContainer, HitObject); nestedOutlineContainer.UpdateNestedObjectsFrom(HitObjectContainer, HitObject); -- -- lastEditablePathId = editablePath.PathId; } private double positionToTime(float relativeYPosition) The patch essentially relies on inlining the broken method and only guarding the relevant part of processing behind the path version check (which is actually updating the path). Everything else that can touch positions of nesteds (like default application, and the drawable piece updates) is allowed to happen unconditionally. On one side, that patch looks more proper, but also does more processing, and is less safe, so I kinda just went with the easier option?
bdach
added a commit
to bdach/osu
that referenced
this pull request
Jan 9, 2025
- Closes ppy#31423. - Regressed in ppy#30411. Admittedly, I don't completely understand all of the pieces here, because code quality of this placement blueprint code is ALL-CAPS ATROCIOUS, but I believe the failure mode to be something along the lines of: - User activates juice stream tool, blueprint gets created in initial state. It reads in a mouse position far outside of the playfield, and sets internal positioning appropriately. - When the user moves the mouse into the bounds of the playfield, some positions update (the ones inside `UpdateTimeAndPosition()`, but the fruit markers are for *nested* objects, and `updateHitObjectFromPath()` is responsible for updating those... however, it only fires if the `editablePath.PathId` changes, which it won't here, because there is only one path vertex until the user commits the starting point of the juice stream and it's always at (0,0). - Therefore the position of the starting fruit marker remains bogus until left click, at which point the path changes and everything returns to *relative* sanity. The solution essentially relies on inlining the broken method and only guarding the relevant part of processing behind the path version check (which is actually updating the path). Everything else that can touch positions of nesteds (like default application, and the drawable piece updates) is allowed to happen unconditionally.
TheDark98
pushed a commit
to TheDark98/osu
that referenced
this pull request
Jan 14, 2025
- Closes ppy#31423. - Regressed in ppy#30411. Admittedly, I don't completely understand all of the pieces here, because code quality of this placement blueprint code is ALL-CAPS ATROCIOUS, but I believe the failure mode to be something along the lines of: - User activates juice stream tool, blueprint gets created in initial state. It reads in a mouse position far outside of the playfield, and sets internal positioning appropriately. - When the user moves the mouse into the bounds of the playfield, some positions update (the ones inside `UpdateTimeAndPosition()`, but the fruit markers are for *nested* objects, and `updateHitObjectFromPath()` is responsible for updating those... however, it only fires if the `editablePath.PathId` changes, which it won't here, because there is only one path vertex until the user commits the starting point of the juice stream and it's always at (0,0). - Therefore the position of the starting fruit marker remains bogus until left click, at which point the path changes and everything returns to *relative* sanity. The solution essentially relies on inlining the broken method and only guarding the relevant part of processing behind the path version check (which is actually updating the path). Everything else that can touch positions of nesteds (like default application, and the drawable piece updates) is allowed to happen unconditionally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Placing objects in editor requires the presence of a
PlacementBlueprintthat responds to the input of the user placing the object. But placement blueprints are programmed to be removed when the user's cursor is outside the compose area.Similar to the symptoms in #30263, in the case of touch input, if the current position of the cursor (led by where the user has tapped the screen last time) is currently outside the compose area, then if the user tries to tap on the compose screen to place an object, nothing happens because there's no
PlacementBlueprintpresent at the point of the user tapping the compose area.Unlike #30263, this cannot be resolved by responding to mouse movement events and create a
PlacementBlueprintright before the subsequent mouse click event is raised, because adding a drawable in the scene requires waiting a full update frame cycle in order for the drawable to become alive (which is a prerequisite for the drawable to be considered in the input queue).Instead, this PR resolves the issue by making placement blueprints always exist, and change their visibility state instead. This required a minor refactor around the
IPlacementHandlerinterface to better work with the new behaviour.ScreenRecording_10-23-2024.16-55-59_1.MP4