แก้ไขฉากด้วย Scene Decorator

เครื่องมือตกแต่งฉากช่วยให้คุณแก้ไขฉากที่คำนวณโดยกลยุทธ์ฉากของแอปได้ โดยพื้นฐานแล้ว ระบบจะใช้เฟสที่ 2 ของการสร้างเนื้อหาที่แสดงโดย NavDisplay

วิธีนี้ช่วยให้คุณรวมฟังก์ชันการทำงานที่เฉพาะเจาะจง เช่น การแสดงคอมโพเนนต์ UI ทั่วไป ไว้ในเดคอเรเตอร์ฉากแต่ละรายการได้

ตัวอย่างเช่น ลองพิจารณาแอปเพื่อการทำงานที่มีเส้นทางระดับบนสุด 3 เส้นทาง ได้แก่ กล่องจดหมายอีเมล กล่องจดหมายข้อความส่วนตัว และมุมมองปฏิทิน แอปดังกล่าวอาจใช้ตัวตกแต่งฉาก 2 ตัว โดยตัวหนึ่งใช้สำหรับเพิ่มแถบแอปด้านบนที่แสดงข้อมูลและการควบคุมสำหรับเส้นทางระดับบนสุดปัจจุบัน และอีกตัวหนึ่งใช้สำหรับเพิ่มแถบการนำทางหรือรางการนำทางแบบถาวรเพื่อไปยังเส้นทางต่างๆ

สร้างกลยุทธ์การตกแต่งฉาก

เดโคเรเตอร์ฉากมีรูปแบบคล้ายกับกลยุทธ์ฉาก หากต้องการกำหนดตัวตกแต่งฉาก ให้ใช้อินเทอร์เฟซ SceneDecoratorStrategy อินเทอร์เฟซนี้มีเมธอด decorateScene ซึ่งคล้ายกับเมธอด calculateScene ของอินเทอร์เฟซ SceneStrategy decorateScene จะพิจารณาว่าจะตกแต่งฉากได้หรือไม่ ดังนี้

  • หากกลยุทธ์การตกแต่งฉากไม่ควรตกแต่งฉากอินพุต ระบบจะแสดงฉากอินพุตตามที่เป็นอยู่
  • หากควรตกแต่งฉากอินพุต ระบบจะแสดงผล Scene ใหม่ โดยทั่วไป ฉากที่แสดงผลจะใช้ฉากอินพุตเป็นพารามิเตอร์และเรียกใช้เมธอด content ของฉากอินพุตภายในเมธอด content ของตัวเอง

หากต้องการพิจารณาว่าควรตกแต่งฉากอินพุตหรือไม่และอย่างไร กลยุทธ์การตกแต่งฉากจะพิจารณาข้อมูลเมตาของทั้ง Scene อินพุตและรายการที่อยู่ในฉากนั้น

class MySceneDecoratorStrategy<T : Any> : SceneDecoratorStrategy<T> {


    override fun SceneDecoratorStrategyScope<T>.decorateScene(scene: Scene<T>): Scene<T> {
        // `shouldDecorate` determines if the scene should be decorated based on scene.metadata,
        // scene.entries.metadata, or any other relevant state.
        return if (shouldDecorate(scene)) {
            MyDecoratingScene(scene)
        } else {
            scene
        }
    }

}

data class MyDecoratingScene<T : Any>(
    val scene: Scene<T>
) : Scene<T> {

    // ...

    override val content = @Composable {
        scene.content()
    }
}

ใช้กลยุทธ์การตกแต่งฉาก

หากต้องการใช้กลยุทธ์การตกแต่งฉาก ให้ระบุกลยุทธ์เหล่านั้นให้กับ NavDisplay โดยใช้พารามิเตอร์ sceneDecoratorStrategies เมื่อตกแต่งฉาก NavDisplay จะเรียกใช้เมธอด decorateScene ของแต่ละกลยุทธ์ตามลำดับ โดยส่งเอาต์พุตของการเรียกแต่ละครั้งเป็นอินพุตไปยังการเรียกครั้งถัดไป

NavDisplay(
    // ...
    sceneDecoratorStrategies = listOf(firstSceneDecoratorStrategy, secondSceneDecoratorStrategy)
)

รูปแบบทั่วไปสำหรับตัวตกแต่งฉาก

เมื่อใช้เดโคเรเตอร์ฉาก รูปแบบที่พบบ่อยซึ่งควรทราบมีดังนี้

คัดลอกพร็อพเพอร์ตี้

ในหลายกรณี ฉากที่แสดงผลโดยการตกแต่งฉากควรมีรายการเดียวกันและมีรายการก่อนหน้าเหมือนกับฉากที่ตกแต่ง นอกจากนี้ ควรรับค่า (หรือแก้ไข) ข้อมูลเมตาของฉากที่ตกแต่ง แทนที่จะใช้ลักษณะการทำงานเริ่มต้น โค้ดต่อไปนี้แสดงตัวอย่างวิธีดำเนินการ

data class CopyingScene<T : Any>(
    val scene: Scene<T>
) : Scene<T> {
    override val entries = scene.entries
    override val previousEntries = scene.previousEntries
    override val metadata = scene.metadata

    // ...
}

คงภาพเคลื่อนไหวไว้

ตามที่อธิบายไว้ในสร้างภาพเคลื่อนไหวระหว่างปลายทาง NavDisplay จะสร้างภาพเคลื่อนไหวสำหรับการเปลี่ยนระหว่างฉากโดยอัตโนมัติเมื่อคีย์ที่ได้มาจากคลาสของฉากปัจจุบันและพร็อพเพอร์ตี้ key มีการเปลี่ยนแปลง

เมื่อเปิดตัวเครื่องมือตกแต่งฉากในแอป คลาสของฉากที่แสดงผลหลังจากการตกแต่งฉากจะยังคงเหมือนเดิม แม้ว่าคลาสของฉากที่แสดงผลระหว่างการคำนวณฉากจะเปลี่ยนแปลงไปก็ตาม เมื่อเกิดเหตุการณ์นี้ขึ้นและฉากที่ตกแต่งคัดลอก key ของฉากที่กำลังตกแต่งโดยตรง ภาพเคลื่อนไหวในตัวจะไม่เกิดขึ้นอีกต่อไปเนื่องจากคีย์ที่ได้มาจะไม่เปลี่ยนแปลง

หากต้องการคงการรองรับภาพเคลื่อนไหวในตัวไว้ ฉากตกแต่งควรใช้คีย์ที่ได้มาจากคลาสและ key ของฉากที่ calculateScene แสดงผล

data class DerivedKeyScene<T : Any>(
    val scene: Scene<T>
) : Scene<T> {
    override val key = scene::class to scene.key

    // ...
}