C# Class UnityEngine.XR.MagicLeap.Planes

Planes is a MonoBehaviour meant to handle all communication with the ML API including querying, parameter construction and callback information.
Inheritance: MonoBehaviour
Exibir arquivo Open project: space10-community/changing-colours-in-mixed-reality

Public Methods

Method Description
DoesPlaneHaveFlag ( UnityEngine.XR.MagicLeap.MLWorldPlane plane, OrientationFlags flag ) : bool

Utility function used to determine if the passed in MLWorldPlane object's flags contain the passed in OrientationFlags.
DoesPlaneHaveFlag ( UnityEngine.XR.MagicLeap.MLWorldPlane plane, SemanticFlags flag ) : bool

Utility function used to determine if the passed in MLWorldPlane object's flags contain the passed in SemanticFlags.
OnDisable ( ) : void

Stops and destroys plane polling
OnEnable ( ) : void

Initializes variables and makes sure they started correctly
OnValidate ( ) : void
Update ( ) : void

Updates planes

Private Methods

Method Description
HandleOnReceivedPlanes ( UnityEngine.XR.MagicLeap.MLResult result, Array planes, Array boundaries ) : void

Handles the result that is recieved from the query to the Planes API. The resulting status of the query The planes recieved from the query The boundaries recieved from the query
QueryPlanes ( ) : bool

Queries the Planes API with all of the set query flags and parameters and sets the Planes[] when finished. Based on the query flags that are passed in, extraction and calculation times may vary.

Method Details

DoesPlaneHaveFlag() public static method

Utility function used to determine if the passed in MLWorldPlane object's flags contain the passed in OrientationFlags.
public static DoesPlaneHaveFlag ( UnityEngine.XR.MagicLeap.MLWorldPlane plane, OrientationFlags flag ) : bool
plane UnityEngine.XR.MagicLeap.MLWorldPlane The MLWorldPlane object to be checked
flag OrientationFlags The OrientationFlags to be checked
return bool

DoesPlaneHaveFlag() public static method

Utility function used to determine if the passed in MLWorldPlane object's flags contain the passed in SemanticFlags.
public static DoesPlaneHaveFlag ( UnityEngine.XR.MagicLeap.MLWorldPlane plane, SemanticFlags flag ) : bool
plane UnityEngine.XR.MagicLeap.MLWorldPlane The MLWorldPlane object to be checked
flag SemanticFlags The SemanticFlags to be checked
return bool

OnDisable() public method

Stops and destroys plane polling
public OnDisable ( ) : void
return void

OnEnable() public method

Initializes variables and makes sure they started correctly
public OnEnable ( ) : void
return void

OnValidate() public method

public OnValidate ( ) : void
return void

Update() public method

Updates planes
public Update ( ) : void
return void