godot/modules/openxr/doc_classes/OpenXRSpatialComponentPlaneAlignmentList.xml
2025-09-27 12:23:33 +10:00

34 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OpenXRSpatialComponentPlaneAlignmentList" inherits="OpenXRSpatialComponentData" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Object for storing the queries plane alignment result data.
</brief_description>
<description>
Object for storing the queries plane alignment result data when calling [method OpenXRSpatialEntityExtension.query_snapshot].
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_plane_alignment" qualifiers="const">
<return type="int" enum="OpenXRSpatialComponentPlaneAlignmentList.PlaneAlignment" />
<param index="0" name="index" type="int" />
<description>
Returns the plane alignment for the parent entity at this [param index].
</description>
</method>
</methods>
<constants>
<constant name="PLANE_ALIGNMENT_HORIZONTAL_UPWARD" value="0" enum="PlaneAlignment">
Plane is facing upward.
</constant>
<constant name="PLANE_ALIGNMENT_HORIZONTAL_DOWNWARD" value="1" enum="PlaneAlignment">
Plane is facing downwards.
</constant>
<constant name="PLANE_ALIGNMENT_VERTICAL" value="2" enum="PlaneAlignment">
Plane is vertically aligned.
</constant>
<constant name="PLANE_ALIGNMENT_ARBITRARY" value="3" enum="PlaneAlignment">
Plane has an arbitrary alignment.
</constant>
</constants>
</class>