Interface IProvidesSelectObject

Provide access to scene object selection

Namespace: Unity.Labs.EditorXR.Interfaces

Syntax

public interface IProvidesSelectObject : IFunctionalityProvider

Methods

GetSelectionCandidate(GameObject, Boolean)

Given a hovered object, find what object would actually be selected

Declaration

GameObject GetSelectionCandidate(GameObject hoveredObject, bool useGrouping = false)

Parameters

Type	Name	Description
GameObject	hoveredObject	The hovered object that is being tested for selection
Boolean	useGrouping	Use group selection

Returns

Type	Description
GameObject	Returns what object would be selected by selectObject

SelectObject(GameObject, Transform, Boolean, Boolean)

Select the given object using the given rayOrigin

Declaration

void SelectObject(GameObject hoveredObject, Transform rayOrigin, bool multiSelect, bool useGrouping = false)

Parameters

Type	Name	Description
GameObject	hoveredObject	The hovered object
Transform	rayOrigin	The rayOrigin used for selection
Boolean	multiSelect	Whether to add the hovered object to the selection, or override the current selection
Boolean	useGrouping	Use group selection

SelectObjects(List<GameObject>, Transform, Boolean, Boolean)

Select the given objects using the given rayOrigin

Declaration

void SelectObjects(List<GameObject> hoveredObjects, Transform rayOrigin, bool multiSelect, bool useGrouping = false)

Parameters

Type	Name	Description
List<GameObject>	hoveredObjects	The hovered objects
Transform	rayOrigin	The rayOrigin used for selection
Boolean	multiSelect	Whether to add the hovered object to the selection, or override the current selection
Boolean	useGrouping	Use group selection