OpenXRSpatialComponentPlaneAlignmentList.xml 1.4 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="OpenXRSpatialComponentPlaneAlignmentList" 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 queries plane alignment result data.
  5. </brief_description>
  6. <description>
  7. Object for storing the queries plane alignment result data when calling [method OpenXRSpatialEntityExtension.query_snapshot].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="get_plane_alignment" qualifiers="const">
  13. <return type="int" enum="OpenXRSpatialComponentPlaneAlignmentList.PlaneAlignment" />
  14. <param index="0" name="index" type="int" />
  15. <description>
  16. Returns the plane alignment for the parent entity at this [param index].
  17. </description>
  18. </method>
  19. </methods>
  20. <constants>
  21. <constant name="PLANE_ALIGNMENT_HORIZONTAL_UPWARD" value="0" enum="PlaneAlignment">
  22. Plane is facing upward.
  23. </constant>
  24. <constant name="PLANE_ALIGNMENT_HORIZONTAL_DOWNWARD" value="1" enum="PlaneAlignment">
  25. Plane is facing downwards.
  26. </constant>
  27. <constant name="PLANE_ALIGNMENT_VERTICAL" value="2" enum="PlaneAlignment">
  28. Plane is vertically aligned.
  29. </constant>
  30. <constant name="PLANE_ALIGNMENT_ARBITRARY" value="3" enum="PlaneAlignment">
  31. Plane has an arbitrary alignment.
  32. </constant>
  33. </constants>
  34. </class>