OpenXRRenderModelManager.xml 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="OpenXRRenderModelManager" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. Helper node that will automatically manage displaying render models.
  5. </brief_description>
  6. <description>
  7. This helper node will automatically manage displaying render models. It will create new [OpenXRRenderModel] nodes as controllers and other hand held devices are detected, and remove those nodes when they are deactivated.
  8. [b]Note:[/b] If you want more control over this logic you can alternatively call [method OpenXRRenderModelExtension.render_model_get_all] to obtain a list of active render model ids and create [OpenXRRenderModel] instances for each render model id provided.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <members>
  13. <member name="make_local_to_pose" type="String" setter="set_make_local_to_pose" getter="get_make_local_to_pose" default="&quot;&quot;">
  14. Position render models local to this pose (this will adjust the position of the render models container node).
  15. </member>
  16. <member name="tracker" type="int" setter="set_tracker" getter="get_tracker" enum="OpenXRRenderModelManager.RenderModelTracker" default="0">
  17. Limits render models to the specified tracker. Include: 0 = All render models, 1 = Render models not related to a tracker, 2 = Render models related to the left hand tracker, 3 = Render models related to the right hand tracker.
  18. </member>
  19. </members>
  20. <signals>
  21. <signal name="render_model_added">
  22. <param index="0" name="render_model" type="OpenXRRenderModel" />
  23. <description>
  24. Emitted when a render model node is added as a child to this node.
  25. </description>
  26. </signal>
  27. <signal name="render_model_removed">
  28. <param index="0" name="render_model" type="OpenXRRenderModel" />
  29. <description>
  30. Emitted when a render model child node is about to be removed from this node.
  31. </description>
  32. </signal>
  33. </signals>
  34. <constants>
  35. <constant name="RENDER_MODEL_TRACKER_ANY" value="0" enum="RenderModelTracker">
  36. All active render models are shown regardless of what tracker they relate to.
  37. </constant>
  38. <constant name="RENDER_MODEL_TRACKER_NONE_SET" value="1" enum="RenderModelTracker">
  39. Only active render models are shown that are not related to any tracker we manage.
  40. </constant>
  41. <constant name="RENDER_MODEL_TRACKER_LEFT_HAND" value="2" enum="RenderModelTracker">
  42. Only active render models are shown that are related to the left hand tracker.
  43. </constant>
  44. <constant name="RENDER_MODEL_TRACKER_RIGHT_HAND" value="3" enum="RenderModelTracker">
  45. Only active render models are shown that are related to the right hand tracker.
  46. </constant>
  47. </constants>
  48. </class>