GuiPanelOptions class

Arguments of GuiPanelControl.GetOrCreate.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll

public sealed class GuiPanelOptions

Constructors

GuiPanelOptions(string)

public GuiPanelOptions(string commonName)

Parameters

Name	Type	Description
commonName	string	Required stable identity key the panel's id is derived from: GuiPanelControl.GetOrCreate returns the existing panel with this name, or creates one.

Properties

Member	Description
CommonName	Required stable identity key the panel's id is derived from. Must be ASCII and non-empty; put any other text in GuiPanelOptions.DisplayName.
DisplayName	Label shown to users; any text, emoji included.
Pose	The panel's pose in room space: the midpoint of its top edge, front normal along -Z of the pose, the surface hanging below it.
Size	Defaults to GuiPanelSize.Default.
ContentUri	Website to show. Set at most one of this and GuiPanelOptions.ContentStreamId, or GuiPanelControl.GetOrCreate throws ArgumentException; with neither, a website panel is created with the default URL. The content type is fixed at creation.
ContentStreamId	Video to show: the PrimarylessVideoSender.GetStreamId of a video sender owned by the same session, whose layout sizes the panel's receiver. Excludes GuiPanelOptions.ContentUri.
VisibleToPeers	Peers the panel is shown to. Empty, the default, means visible to every peer. A panel meant only for some peers is created with them here rather than narrowed afterwards.

CommonName

Required stable identity key the panel's id is derived from. Must be ASCII and non-empty; put any other text in GuiPanelOptions.DisplayName.

public string CommonName { get; set; }

Value: string

DisplayName

Label shown to users; any text, emoji included.

public string? DisplayName { get; set; }

Value: string

Pose

The panel's pose in room space: the midpoint of its top edge, front normal along -Z of the pose, the surface hanging below it.

public Pose Pose { get; set; }

Value: Pose

Size

Defaults to GuiPanelSize.Default.

public GuiPanelSize Size { get; set; }

Value: GuiPanelSize

ContentUri

Website to show. Set at most one of this and GuiPanelOptions.ContentStreamId, or GuiPanelControl.GetOrCreate throws ArgumentException; with neither, a website panel is created with the default URL. The content type is fixed at creation.

public string? ContentUri { get; set; }

Value: string

ContentStreamId

Video to show: the PrimarylessVideoSender.GetStreamId of a video sender owned by the same session, whose layout sizes the panel's receiver. Excludes GuiPanelOptions.ContentUri.

public StreamId? ContentStreamId { get; set; }

Value: StreamId?

VisibleToPeers

Peers the panel is shown to. Empty, the default, means visible to every peer. A panel meant only for some peers is created with them here rather than narrowed afterwards.

public PeerId[] VisibleToPeers { get; set; }

Value: PeerId[]

Methods

WithExtension

public GuiPanelOptions WithExtension(Structure extension)

Parameters

Name	Type	Description
extension	Structure

Returns: GuiPanelOptions