[3.8.4] [native] Fix that 2d object's world transform not being updated if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback. #17555

dumganhar · 2024-08-19T06:16:02Z

And run performed functions at the end of Engine::tick instead of Director::AfterPersent.

Added testcase:

Reported at : https://forum.cocos.org/t/topic/159379/380?u=dumganhar

Reason

Review the code in director.ts:

public tick (dt: number): void {
    ......

        this.emit(Director.EVENT_BEFORE_DRAW);
        uiRendererManager.updateAllDirtyRenderers();
        this._root!.frameMove(dt);
        // The old code will invoke Scheduler::runFunctionsToBePerformedInCocosThread in frameMove.
        // And the code in those user callback may call `node.setPosition/setScale/setRotation` to update the local transform for node.
        // The return value of Node's getChangedFlags() will be updated, but since it's invoked after render, the world transform will not be updated in the current frame.
        // In the next frame, Batcher2D will only check whether the return value of Node::getChangedFlags() is dirty, 
        // because it's in the next frame, Node::getChangedFlags will return 0 which means `NO CHANGES`.
        // This make the 2D object's world transform not being updated.
        this.emit(Director.EVENT_AFTER_DRAW);

        Node.resetHasChangedFlags();
        Node.clearNodeArray();
        scalableContainerManager.update(dt);
        this.emit(Director.EVENT_END_FRAME);
        this._totalFrames++;
    }
}

inline uint32_t getChangedFlags() const {
    return _hasChangedFlagsVersion == globalFlagChangeVersion ? _hasChangedFlags : 0;
}

CC_FORCE_INLINE void Batcher2d::handleComponentDraw(RenderEntity* entity, RenderDrawInfo* drawInfo, Node* node) {
    ......
    if (!drawInfo->getIsMeshBuffer()) {
        if (node->getChangedFlags() ||  drawInfo->getVertDirty()) { // Only check getChangedFlags here which is not enough, should also check Node::isTransformDirty().
            fillVertexBuffers(entity, drawInfo);
            drawInfo->setVertDirty(false);
        }
        if (entity->getVBColorDirty()) {
            fillColors(entity, drawInfo);
        }

        fillIndexBuffers(drawInfo);
    }

    if (isMask) {
        _stencilManager->enableMask();
    }
}

Re: #

Changelog

Continuous Integration

This pull request:

needs automatic test cases check.

Manual trigger with @cocos-robot run test cases afterward.
does not change any runtime related code or build configuration

If any reviewer thinks the CI checks are needed, please uncheck this option, then close and reopen the issue.

Compatibility Check

This pull request:

changes public API, and have ensured backward compatibility with deprecated features.
affects platform compatibility, e.g. system version, browser version, platform sdk version, platform toolchain, language version, hardware compatibility etc.
affects file structure of the build package or build configuration which requires user project upgrade.
introduces breaking changes, please list all changes, affected features and the scope of violation.

Greptile Summary

This pull request addresses an issue with 2D object world transforms not updating correctly when modified in the Director.EVENT_AFTER_DRAW callback, by adjusting the timing of transform updates and async task execution.

Modified Batcher2d::handleComponentDraw in native/cocos/2d/renderer/Batcher2d.cpp to check node->isTransformDirty() for more accurate transform updates
Removed AfterPresent event listener in native/cocos/bindings/manual/jsb_scene_manual.cpp to adjust async task execution timing
Added _scheduler->runFunctionsToBePerformedInCocosThread() call at the end of Engine::tick() in native/cocos/engine/Engine.cpp for improved async task handling
These changes ensure proper updating of 2D object world transforms when modified in specific callbacks

…ed if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback.

…r::AfterPersent.

greptile-apps

LGTM

_{3 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

dumganhar · 2024-08-19T06:19:39Z

@cocos-robot run test cases

github-actions · 2024-08-19T06:23:41Z

Interface Check Report

This pull request does not change any public interfaces !

github-actions · 2024-08-19T07:37:11Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: FAIL
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/e85c1b93-385e-4822-a56f-81953cd85fcb/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10448233239

Task Details

Platform	build	boot	runned	FailScene
web-mobile	PASS	PASS	FAIL	graphics-line-join
ios	PASS	PASS	PASS
mac	PASS	PASS	PASS

github-actions · 2024-08-19T07:37:11Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: PASS
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/5b3f4f54-831c-4c66-96d9-5c9582a3d47f/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10448233239

Task Details

dumganhar · 2024-08-19T08:17:12Z

@cocos-robot run test cases

github-actions · 2024-08-19T09:40:56Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: FAIL
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/e9053b82-7b9d-462b-9992-052d43a178ae/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10449725615

Task Details

Platform	build	boot	runned	FailScene
web-mobile	PASS	PASS	FAIL	director-after-draw-test
ios	PASS	PASS	FAIL	director-after-draw-test
mac	PASS	PASS	FAIL	director-after-draw-test

github-actions · 2024-08-19T09:40:57Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: FAIL
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/2442219e-aede-4dcb-ac5e-2cc25d6d0567/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10449725615

Task Details

Platform	build	boot	runned	FailScene
windows	PASS	PASS	FAIL	director-after-draw-test
android	PASS	PASS	FAIL	director-after-draw-test
wechatgame	PASS	PASS	FAIL	director-after-draw-test

dumganhar · 2024-08-19T09:43:46Z

@cocos-robot run test cases

github-actions · 2024-08-19T11:00:50Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: FAIL
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/522b8e5f-06ca-4b08-b53f-b7abf7ff9003/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10451033040

Task Details

Platform	build	boot	runned	FailScene
web-mobile	PASS	PASS	FAIL	graphics-continuous-filling
ios	PASS	PASS	PASS
mac	PASS	PASS	PASS

github-actions · 2024-08-19T11:00:50Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.4
Task Result: PASS
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/fa5c0e36-f03f-4041-9533-6ced3004c9a6/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/10451033040

Task Details

dumganhar added 2 commits August 19, 2024 13:57

[3.8.4] [native] Fix that 2d object's world transform not being updat…

1ff0044

…ed if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback.

Run performed functions at the end of Engine::tick instead of Directo…

8e3761e

…r::AfterPersent.

dumganhar requested a review from minggo August 19, 2024 06:17

greptile-apps bot reviewed Aug 19, 2024

View reviewed changes

minggo approved these changes Aug 19, 2024

View reviewed changes

dumganhar merged commit bc73e79 into cocos:v3.8.4 Aug 20, 2024
24 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.8.4] [native] Fix that 2d object's world transform not being updated if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback. #17555

[3.8.4] [native] Fix that 2d object's world transform not being updated if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback. #17555

dumganhar commented Aug 19, 2024 •

edited

Loading

greptile-apps bot left a comment

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

[3.8.4] [native] Fix that 2d object's world transform not being updated if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback. #17555

[3.8.4] [native] Fix that 2d object's world transform not being updated if modifying local position/rotation/scale in Director.EVENT_AFTER_DRAW callback. #17555

Conversation

dumganhar commented Aug 19, 2024 • edited Loading

Reason

Changelog

Continuous Integration

Compatibility Check

Greptile Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

Interface Check Report

github-actions bot commented Aug 19, 2024

Task Details

github-actions bot commented Aug 19, 2024

Task Details

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

Task Details

github-actions bot commented Aug 19, 2024

Task Details

dumganhar commented Aug 19, 2024

github-actions bot commented Aug 19, 2024

Task Details

github-actions bot commented Aug 19, 2024

Task Details

dumganhar commented Aug 19, 2024 •

edited

Loading