OverviewFilesCommitsIssuesDocsReleasesPeers

nvidia-rtx-godot / modules / openxr / doc_classes / OpenXRSpatialComponentPlaneSemanticLabelList.xml

38 lines · xml ref:
<?xml version="1.0" encoding="UTF-8" ?>
<class name="OpenXRSpatialComponentPlaneSemanticLabelList" inherits="OpenXRSpatialComponentData" api_type="core" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Object for storing the queries plane semantic label result data.
	</brief_description>
	<description>
		Object for storing the queries plane semantic label result data when calling [method OpenXRSpatialEntityExtension.query_snapshot].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_plane_semantic_label" qualifiers="const">
			<return type="int" enum="OpenXRSpatialComponentPlaneSemanticLabelList.PlaneSemanticLabel" />
			<param index="0" name="index" type="int" />
			<description>
				Returns the plane semantic label for the parent entity at this [param index].
			</description>
		</method>
	</methods>
	<constants>
		<constant name="PLANE_SEMANTIC_LABEL_UNCATEGORIZED" value="1" enum="PlaneSemanticLabel">
			Uncategorized plane.
		</constant>
		<constant name="PLANE_SEMANTIC_LABEL_FLOOR" value="2" enum="PlaneSemanticLabel">
			Plane represents a floor.
		</constant>
		<constant name="PLANE_SEMANTIC_LABEL_WALL" value="3" enum="PlaneSemanticLabel">
			Plane represents a wall.
		</constant>
		<constant name="PLANE_SEMANTIC_LABEL_CEILING" value="4" enum="PlaneSemanticLabel">
			Plane represents a ceiling.
		</constant>
		<constant name="PLANE_SEMANTIC_LABEL_TABLE" value="5" enum="PlaneSemanticLabel">
			Plane represents the surface of a table.
		</constant>
	</constants>
</class>