Struct AnchorSettings

Settings related to management of the internal anchor graph.

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Microsoft.MixedReality.WorldLocking.Core

Assembly: cs.temp.dll.dll

Syntax

[Serializable]
public struct AnchorSettings

Fields

anchorSubsystem

Choice of subsystem that supplies anchors.

Declaration

public AnchorSettings.AnchorSubsystem anchorSubsystem

Field Value

Type	Description
AnchorSettings.AnchorSubsystem

ARSessionOriginSource

GameObject which has (or will have) the ARSessionOrigin component, required when using AR Foundation.

Declaration

public GameObject ARSessionOriginSource

Field Value

Type	Description
GameObject

Remarks

Ignored except when anchorSubsystem == ARF.

ARSessionSource

GameObject which has (or will have) the ARSession component, required when using the AR Foundation.

Declaration

public GameObject ARSessionSource

Field Value

Type	Description
GameObject

Remarks

Ignored except when anchorSubsystem == ARF.

MaxAnchorEdgeLength

The maximum distance between two anchors to connect them with a graph edge.

Declaration

public float MaxAnchorEdgeLength

Field Value

Type	Description
Single

Remarks

This must be greater than MinNewAnchorDistance to create a connected graph of anchors.

MaxLocalAnchors

The maximum number of local anchors in the internal anchor graph.

Declaration

public int MaxLocalAnchors

Field Value

Type	Description
Int32

Remarks

Zero or any negative value is considered to be infinite (unlimited).

MinNewAnchorDistance

The minimum distance to the current closest anchor before creating a new anchor.

Declaration

public float MinNewAnchorDistance

Field Value

Type	Description
Single

Remarks

A greater value will result in a less dense anchor coverage.

NullSubsystemInEditor

Use the Null anchor subsystem when running in Unity Editor.

Declaration

public bool NullSubsystemInEditor

Field Value

Type	Description
Boolean

Properties

IsValid

Check the validity of the settings.

Declaration

public readonly bool IsValid { get; }

Property Value

Type	Description
Boolean

UseDefaults

Ignore set values and use default behavior. When set, will reset all values to defaults.

Declaration

public bool UseDefaults { get; set; }

Property Value

Type	Description
Boolean

Methods

InitToDefaults()

Init all fields to default values.

Declaration

public void InitToDefaults()