OpenXRSpatialQueryResultData.xml 1.3 KB

123456789101112131415161718192021222324252627282930313233
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="OpenXRSpatialQueryResultData" inherits="OpenXRSpatialComponentData" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. Object for storing the main query result data.
  5. </brief_description>
  6. <description>
  7. Object for storing the main query result data when calling [method OpenXRSpatialEntityExtension.query_snapshot]. This must always be the first component requested.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="get_capacity" qualifiers="const">
  13. <return type="int" />
  14. <description>
  15. Returns the number of entities that were retrieved.
  16. </description>
  17. </method>
  18. <method name="get_entity_id" qualifiers="const">
  19. <return type="int" />
  20. <param index="0" name="index" type="int" />
  21. <description>
  22. Returns the entity id ([code]XrSpatialEntityIdEXT[/code]) for the entity at this [param index].
  23. </description>
  24. </method>
  25. <method name="get_entity_state" qualifiers="const">
  26. <return type="int" enum="OpenXRSpatialEntityTracker.EntityTrackingState" />
  27. <param index="0" name="index" type="int" />
  28. <description>
  29. Returns the entity state for the entity at this [param index].
  30. </description>
  31. </method>
  32. </methods>
  33. </class>