Class PlanesComponent

The PlanesComponent class manages requests for planes, processes the results and provides them to the calling system.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PlanesComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.MagicLeap
Assembly: UE4DotNet.dll
Syntax
public class PlanesComponent : SceneComponent
Remarks

The calling system is able request planes within a specified area. Various other search criteria can be set via this class's public properties. Planes requests are processed on a separate thread. Once a planes request has been processed the calling system will be notified via an FPlaneResultDelegate broadcast.

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static PlanesComponent DefaultObject { get; }
Property Value
Type Description
PlanesComponent
| Improve this Doc View Source

IgnoreBoundingVolume

Declaration
public bool IgnoreBoundingVolume { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MaxResults

The maximum number of planes that should be returned in the result.

Declaration
public int MaxResults { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

MinHolePerimeter

If EPlaneQueryFlags::IgnoreHoles is not a query flag then holes with a perimeter (in Unreal Units) smaller than this value will be ignored, and can be part of the plane.

Declaration
public float MinHolePerimeter { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MinPlaneArea

The minimum area (in squared Unreal Units) of planes to be returned.

Declaration
public float MinPlaneArea { get; set; }
Property Value
Type Description
System.Single
Remarks

This value cannot be lower than 400 (lower values will be capped to this minimum).

| Improve this Doc View Source

SearchVolume

Bounding box for searching planes in.

Declaration
public BoxComponent SearchVolume { get; set; }
Property Value
Type Description
BoxComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PlanesComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PlanesComponent
| Improve this Doc View Source

RequestPlanes(Int32, Byte)

Requests planes with the current value of QueryFlags, SearchVolume and MaxResults.

Declaration
public bool RequestPlanes(int UserData, byte ResultDelegate)
Parameters
Type Name Description
System.Int32 UserData
System.Byte ResultDelegate
Returns
Type Description
System.Boolean
Remarks

@param UserData User data for this request. The same data will be included in the result for query identification. @param ResultDelegate Delegate which will be called when the planes result is ready. @returns True if the planes query was successfully placed, false otherwise.

Operators

| Improve this Doc View Source

Implicit(IntPtr to PlanesComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator PlanesComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
PlanesComponent