Uploaded image for project: 'Qt 3D Studio'
  1. Qt 3D Studio
  2. QT3DS-3688

Make it clearer in documentation that runtime APIs are asynchronous

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Won't Do
    • Not Evaluated
    • None
    • Qt 3D Studio 2.4 BETA3
    • Documentation
    • None

    Description

      We are receiving several bug reports arising from misunderstandings or inadequate information of timing patterns in runtime APIs. We should elaborate more clearly that these APIs are asynchronous without latency guarantees, and clients should connect to various signals to make sure that calls like SetAttribute, setdatainputvalue etc. work correctly. This info is in the documentation, but perhaps bit hard to find as most of it seems to be in API signal descriptions.

      For example: a sequence where a presentation is loaded through setSource, and setAttribute is immediately called for an element in the presentation will fail as presentation is not yet initialized and ready. Instead, the API client should wait for presentationReady signal.

      Same applies to slide changes, and probably to other locations.

       

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            mahonkam Mats Honkamaa
            jakangas Janne Kangas
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes