mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0
  • 指南
  • API 文档
  • API 文档

    Show / Hide Table of Contents

    Class BaseBoundarySystem

    Inheritance
    Object
    BaseService
    BaseEventSystem
    BaseCoreSystem
    BaseBoundarySystem
    Implements
    IMixedRealityBoundarySystem
    IMixedRealityEventSystem
    IMixedRealityService
    IDisposable
    IMixedRealityEventSource
    IEqualityComparer
    Inherited Members
    BaseCoreSystem.Registrar
    BaseEventSystem.enableDanglingHandlerDiagnostics
    BaseEventSystem.EventHandlersByType
    BaseEventSystem.EventListeners
    BaseEventSystem.RegisterHandler<T>(IEventSystemHandler)
    BaseEventSystem.UnregisterHandler<T>(IEventSystemHandler)
    BaseService.DefaultPriority
    BaseService.Priority
    BaseService.ConfigurationProfile
    BaseService.Reset()
    BaseService.Enable()
    BaseService.Update()
    BaseService.LateUpdate()
    BaseService.Disable()
    BaseService.disposed
    BaseService.Dispose()
    BaseService.Dispose(Boolean)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Boundary
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class BaseBoundarySystem : BaseCoreSystem, IMixedRealityBoundarySystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

    Constructors

    BaseBoundarySystem(MixedRealityBoundaryVisualizationProfile, ExperienceScale)

    Constructor.

    Declaration
    protected BaseBoundarySystem(MixedRealityBoundaryVisualizationProfile profile, ExperienceScale scale)
    Parameters
    Type Name Description
    MixedRealityBoundaryVisualizationProfile profile

    The configuration profile for the service.

    ExperienceScale scale

    The application's configured ExperienceScale.

    Fields

    RectangularBounds

    The largest rectangle that is contained withing the play space geometry.

    Declaration
    protected InscribedRectangle RectangularBounds
    Field Value
    Type Description
    InscribedRectangle

    Properties

    BoundaryHeight

    Declaration
    public float BoundaryHeight { get; set; }
    Property Value
    Type Description
    Single

    BoundaryVisualizationProfile

    Declaration
    public MixedRealityBoundaryVisualizationProfile BoundaryVisualizationProfile { get; }
    Property Value
    Type Description
    MixedRealityBoundaryVisualizationProfile

    BoundaryWallsPhysicsLayer

    Declaration
    public int BoundaryWallsPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32

    Bounds

    Declaration
    public Edge[] Bounds { get; protected set; }
    Property Value
    Type Description
    Edge[]

    CeilingPhysicsLayer

    Declaration
    public int CeilingPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32

    FloorHeight

    Declaration
    public float? FloorHeight { get; protected set; }
    Property Value
    Type Description
    Nullable<Single>

    FloorPhysicsLayer

    Declaration
    public int FloorPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32

    Name

    Declaration
    public override string Name { get; protected set; }
    Property Value
    Type Description
    String
    Overrides
    BaseService.Name

    PlayAreaPhysicsLayer

    Declaration
    public int PlayAreaPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32

    Scale

    Declaration
    public ExperienceScale Scale { get; set; }
    Property Value
    Type Description
    ExperienceScale

    ShowBoundaryCeiling

    Declaration
    public bool ShowBoundaryCeiling { get; set; }
    Property Value
    Type Description
    Boolean

    ShowBoundaryWalls

    Declaration
    public bool ShowBoundaryWalls { get; set; }
    Property Value
    Type Description
    Boolean

    ShowFloor

    Declaration
    public bool ShowFloor { get; set; }
    Property Value
    Type Description
    Boolean

    ShowPlayArea

    Declaration
    public bool ShowPlayArea { get; set; }
    Property Value
    Type Description
    Boolean

    ShowTrackedArea

    Declaration
    public bool ShowTrackedArea { get; set; }
    Property Value
    Type Description
    Boolean

    SourceId

    Declaration
    public uint SourceId { get; }
    Property Value
    Type Description
    UInt32

    SourceName

    Declaration
    public string SourceName { get; }
    Property Value
    Type Description
    String

    TrackedAreaPhysicsLayer

    Declaration
    public int TrackedAreaPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32

    Methods

    Contains(Vector3, BoundaryType)

    Declaration
    public bool Contains(Vector3 location, BoundaryType boundaryType = null)
    Parameters
    Type Name Description
    Vector3 location
    BoundaryType boundaryType
    Returns
    Type Description
    Boolean

    Destroy()

    Declaration
    public override void Destroy()
    Overrides
    BaseEventSystem.Destroy()

    GetBoundaryCeilingVisualization()

    Declaration
    public GameObject GetBoundaryCeilingVisualization()
    Returns
    Type Description
    GameObject

    GetBoundaryGeometry()

    Retrieves the boundary geometry.

    Declaration
    protected abstract List<Vector3> GetBoundaryGeometry()
    Returns
    Type Description
    List<Vector3>

    A list of geometry points, or null if geometry was unavailable.

    GetBoundaryWallVisualization()

    Declaration
    public GameObject GetBoundaryWallVisualization()
    Returns
    Type Description
    GameObject

    GetFloorVisualization()

    Declaration
    public GameObject GetFloorVisualization()
    Returns
    Type Description
    GameObject

    GetHashCode(Object)

    Declaration
    public int GetHashCode(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Int32

    GetPlayAreaVisualization()

    Declaration
    public GameObject GetPlayAreaVisualization()
    Returns
    Type Description
    GameObject

    GetTrackedAreaVisualization()

    Declaration
    public GameObject GetTrackedAreaVisualization()
    Returns
    Type Description
    GameObject

    HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

    Declaration
    public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.EventFunction<T> eventHandler)
    
        where T : IEventSystemHandler
    Parameters
    Type Name Description
    BaseEventData eventData
    ExecuteEvents.EventFunction<T> eventHandler
    Type Parameters
    Name Description
    T
    Overrides
    Microsoft.MixedReality.Toolkit.BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

    Initialize()

    Declaration
    public override void Initialize()
    Overrides
    BaseService.Initialize()

    Register(GameObject)

    Registers the GameObject to listen for boundary events.

    Declaration
    public override void Register(GameObject listener)
    Parameters
    Type Name Description
    GameObject listener
    Overrides
    BaseEventSystem.Register(GameObject)

    SetTrackingSpace()

    Updates the tracking space on the XR device.

    Declaration
    protected abstract void SetTrackingSpace()

    TryGetRectangularBoundsParams(out Vector2, out Single, out Single, out Single)

    Declaration
    public bool TryGetRectangularBoundsParams(out Vector2 center, out float angle, out float width, out float height)
    Parameters
    Type Name Description
    Vector2 center
    Single angle
    Single width
    Single height
    Returns
    Type Description
    Boolean

    Unregister(GameObject)

    UnRegisters the GameObject to listen for boundary events. ///

    Declaration
    public override void Unregister(GameObject listener)
    Parameters
    Type Name Description
    GameObject listener
    Overrides
    BaseEventSystem.Unregister(GameObject)

    Implements

    IMixedRealityBoundarySystem
    IMixedRealityEventSystem
    IMixedRealityService
    IDisposable
    IMixedRealityEventSource
    IEqualityComparer
    In This Article
    • Constructors
      • BaseBoundarySystem(MixedRealityBoundaryVisualizationProfile, ExperienceScale)
    • Fields
      • RectangularBounds
    • Properties
      • BoundaryHeight
      • BoundaryVisualizationProfile
      • BoundaryWallsPhysicsLayer
      • Bounds
      • CeilingPhysicsLayer
      • FloorHeight
      • FloorPhysicsLayer
      • Name
      • PlayAreaPhysicsLayer
      • Scale
      • ShowBoundaryCeiling
      • ShowBoundaryWalls
      • ShowFloor
      • ShowPlayArea
      • ShowTrackedArea
      • SourceId
      • SourceName
      • TrackedAreaPhysicsLayer
    • Methods
      • Contains(Vector3, BoundaryType)
      • Destroy()
      • GetBoundaryCeilingVisualization()
      • GetBoundaryGeometry()
      • GetBoundaryWallVisualization()
      • GetFloorVisualization()
      • GetHashCode(Object)
      • GetPlayAreaVisualization()
      • GetTrackedAreaVisualization()
      • HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)
      • Initialize()
      • Register(GameObject)
      • SetTrackingSpace()
      • TryGetRectangularBoundsParams(out Vector2, out Single, out Single, out Single)
      • Unregister(GameObject)
    • Implements
    Back to top Generated by DocFX