GuiPanel class

An immutable snapshot of one GUI panel, safe to keep. Get a newer one from GuiPanelControl.SubscribeUpdates.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll · Source: GuiPanel.cs

public sealed class GuiPanel

Properties

Member	Description
Id
DisplayName
Pose	The panel's pose in the publishing peer's room space: the midpoint of its top edge, front normal along -Z.
Size
ContentType	Which of GuiPanel.ContentUri and GuiPanel.ContentStreamId is set; the other is null. Fixed when the panel is created.
ContentUri	The web page shown, for GuiPanelContentType.WebsiteUri; null otherwise.
ContentStreamId	The video stream shown, for GuiPanelContentType.StreamId; null otherwise.
State	Whether peers see the panel. A GuiPanelState.Closed panel is reopened by GuiPanelControl.GetOrCreate with the same common name.
VisibleToPeers	The peers the panel is narrowed to. Empty means visible to every peer, not to none.

Id

public GuiPanelId Id { get; }

Value: GuiPanelId

DisplayName

public string DisplayName { get; }

Value: string

Pose

The panel's pose in the publishing peer's room space: the midpoint of its top edge, front normal along -Z.

public Pose Pose { get; }

Value: Pose

Size

public GuiPanelSize Size { get; }

Value: GuiPanelSize

ContentType

Which of GuiPanel.ContentUri and GuiPanel.ContentStreamId is set; the other is null. Fixed when the panel is created.

public GuiPanelContentType ContentType { get; }

Value: GuiPanelContentType

ContentUri

The web page shown, for GuiPanelContentType.WebsiteUri; null otherwise.

public string? ContentUri { get; }

Value: string

ContentStreamId

The video stream shown, for GuiPanelContentType.StreamId; null otherwise.

public StreamId? ContentStreamId { get; }

Value: StreamId?

State

Whether peers see the panel. A GuiPanelState.Closed panel is reopened by GuiPanelControl.GetOrCreate with the same common name.

public GuiPanelState State { get; }

Value: GuiPanelState

VisibleToPeers

The peers the panel is narrowed to. Empty means visible to every peer, not to none.

public PeerId[] VisibleToPeers { get; }

Value: PeerId[]