Show / Hide Table of Contents

    Class TransformBroadcaster

    A IComponentBroadcaster specifically for transforms.

    Inheritance
    Object
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>
    TransformBroadcaster
    Implements
    IComponentBroadcaster
    Inherited Members
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.transformBroadcaster
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.TransformBroadcaster
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ComponentBroadcasterService
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.IComponentBroadcaster.ComponentBroadcasterService
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.Awake()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.OnDestroy()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.UpdateWhenDisabled
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.PerformanceComponentName
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ResetFrame()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ShouldSendChanges(SocketEndpoint)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ProcessNewConnections(SocketEndpointConnectionDelta)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ProcessNewConnections(IEnumerable<SocketEndpoint>)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.OnFrameCompleted(SocketEndpointConnectionDelta)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.SendComponentCreation(IEnumerable<SocketEndpoint>)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.OnInitialized()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.ShouldUpdateFrame(SocketEndpoint)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.BeginUpdatingFrame(SocketEndpointConnectionDelta)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.EndUpdatingFrame()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.SendCompleteChanges(IEnumerable<SocketEndpoint>)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.CalculateDeltaChanges()
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.HasChanges(TransformBroadcasterChangeType)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.SendDeltaChanges(IEnumerable<SocketEndpoint>, TransformBroadcasterChangeType)
    ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>.RemoveDisconnectedEndpoints(IEnumerable<SocketEndpoint>)
    Namespace: Microsoft.MixedReality.SpectatorView
    Assembly: cs.temp.dll.dll
    Syntax
    public class TransformBroadcaster : ComponentBroadcaster<TransformBroadcasterService, TransformBroadcasterChangeType>, IComponentBroadcaster

    Fields

    SpectatorViewChildrenHiddenTag

    Declaration
    public const string SpectatorViewChildrenHiddenTag = "SpectatorViewChildrenHidden"
    Field Value
    Type Description
    String

    SpectatorViewHiddenTag

    Declaration
    public const string SpectatorViewHiddenTag = "SpectatorViewHidden"
    Field Value
    Type Description
    String

    Properties

    BlockedConnections

    SocketEndpoint connections that are currently blocked

    Declaration
    public ISet<SocketEndpoint> BlockedConnections { get; }
    Property Value
    Type Description
    ISet<SocketEndpoint>

    CachedName

    Associated game object's name

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

    Id

    Returns the unique id for the broadcasted transform

    Declaration
    public short Id { get; }
    Property Value
    Type Description
    Int16

    Layer

    Associated game object's layer

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

    NullTransformId

    Returns an id that can be used for initialization checks

    Declaration
    public static short NullTransformId { get; }
    Property Value
    Type Description
    Int16

    ParentId

    Parent transform's id, returns NullTransformId if no parent transform exists

    Declaration
    public short ParentId { get; }
    Property Value
    Type Description
    Int16

    SynchronizedIsActive

    Returns true if the associated game object is active in the scene, otherwise false

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

    UpdateWhenDisabled

    Declaration
    protected override bool UpdateWhenDisabled { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.UpdateWhenDisabled

    Methods

    Awake()

    Declaration
    protected override void Awake()
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.Awake()

    BeginUpdatingFrame(SocketEndpointConnectionDelta)

    Declaration
    protected override void BeginUpdatingFrame(SocketEndpointConnectionDelta connectionDelta)
    Parameters
    Type Name Description
    SocketEndpointConnectionDelta connectionDelta
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.BeginUpdatingFrame(Microsoft.MixedReality.SpectatorView.SocketEndpointConnectionDelta)

    CalculateDeltaChanges()

    Declaration
    protected override TransformBroadcasterChangeType CalculateDeltaChanges()
    Returns
    Type Description
    TransformBroadcasterChangeType
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.CalculateDeltaChanges()

    EndUpdatingFrame()

    Declaration
    protected override void EndUpdatingFrame()
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.EndUpdatingFrame()

    HasChanges(TransformBroadcasterChangeType)

    Declaration
    protected override bool HasChanges(TransformBroadcasterChangeType changeFlags)
    Parameters
    Type Name Description
    TransformBroadcasterChangeType changeFlags
    Returns
    Type Description
    Boolean
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.HasChanges(Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType)

    HasFlag(TransformBroadcasterChangeType, TransformBroadcasterChangeType)

    Returns true if the provided change type contains the specified flag, otherwise false.

    Declaration
    public static bool HasFlag(TransformBroadcasterChangeType changeType, TransformBroadcasterChangeType flag)
    Parameters
    Type Name Description
    TransformBroadcasterChangeType changeType

    Change type

    TransformBroadcasterChangeType flag

    flag to check for

    Returns
    Type Description
    Boolean

    Returns true if the provided change type contains the specified flag, otherwise false.

    OnDestroy()

    Declaration
    protected override void OnDestroy()
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.OnDestroy()

    ProcessConnectionDelta(SocketEndpointConnectionDelta, out IReadOnlyList<SocketEndpoint>, out IReadOnlyList<SocketEndpoint>, out IReadOnlyList<SocketEndpoint>)

    Declaration
    public void ProcessConnectionDelta(SocketEndpointConnectionDelta connectionDelta, out IReadOnlyList<SocketEndpoint> needingCompleteChanges, out IReadOnlyList<SocketEndpoint> filteredNeedingDeltaChanged, out IReadOnlyList<SocketEndpoint> filteredNeedingCompleteChanges)
    Parameters
    Type Name Description
    SocketEndpointConnectionDelta connectionDelta
    IReadOnlyList<SocketEndpoint> needingCompleteChanges
    IReadOnlyList<SocketEndpoint> filteredNeedingDeltaChanged
    IReadOnlyList<SocketEndpoint> filteredNeedingCompleteChanges

    ResetFrame()

    Declaration
    public override void ResetFrame()
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.ResetFrame()

    SendCompleteChanges(IEnumerable<SocketEndpoint>)

    Declaration
    protected override void SendCompleteChanges(IEnumerable<SocketEndpoint> endpoints)
    Parameters
    Type Name Description
    IEnumerable<SocketEndpoint> endpoints
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.SendCompleteChanges(IEnumerable<Microsoft.MixedReality.SpectatorView.SocketEndpoint>)

    SendComponentCreation(IEnumerable<SocketEndpoint>)

    Declaration
    protected override void SendComponentCreation(IEnumerable<SocketEndpoint> newConnections)
    Parameters
    Type Name Description
    IEnumerable<SocketEndpoint> newConnections
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.SendComponentCreation(IEnumerable<Microsoft.MixedReality.SpectatorView.SocketEndpoint>)

    SendDeltaChanges(IEnumerable<SocketEndpoint>, TransformBroadcasterChangeType)

    Declaration
    protected override void SendDeltaChanges(IEnumerable<SocketEndpoint> endpoints, TransformBroadcasterChangeType changeFlags)
    Parameters
    Type Name Description
    IEnumerable<SocketEndpoint> endpoints
    TransformBroadcasterChangeType changeFlags
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.SendDeltaChanges(IEnumerable<Microsoft.MixedReality.SpectatorView.SocketEndpoint>, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType)

    ShouldSendTransformInHierarchy(SocketEndpoint)

    Returns true if the provided endpoint should receive a transform update, otherwise false

    Declaration
    public bool ShouldSendTransformInHierarchy(SocketEndpoint endpoint)
    Parameters
    Type Name Description
    SocketEndpoint endpoint

    network connection to potentially send transform update

    Returns
    Type Description
    Boolean

    True if the provided endpoint should receive a transform update, otherwise false

    ShouldUpdateFrame(SocketEndpoint)

    Declaration
    protected override bool ShouldUpdateFrame(SocketEndpoint endpoint)
    Parameters
    Type Name Description
    SocketEndpoint endpoint
    Returns
    Type Description
    Boolean
    Overrides
    Microsoft.MixedReality.SpectatorView.ComponentBroadcaster<Microsoft.MixedReality.SpectatorView.TransformBroadcasterService, Microsoft.MixedReality.SpectatorView.TransformBroadcasterChangeType>.ShouldUpdateFrame(Microsoft.MixedReality.SpectatorView.SocketEndpoint)

    WriteChildHierarchyTree(BinaryWriter)

    Writes child transforms hierarchy to network message

    Declaration
    public void WriteChildHierarchyTree(BinaryWriter message)
    Parameters
    Type Name Description
    BinaryWriter message

    Implements

    IComponentBroadcaster
    In This Article
    • Fields
      • SpectatorViewChildrenHiddenTag
      • SpectatorViewHiddenTag
    • Properties
      • BlockedConnections
      • CachedName
      • Id
      • Layer
      • NullTransformId
      • ParentId
      • SynchronizedIsActive
      • UpdateWhenDisabled
    • Methods
      • Awake()
      • BeginUpdatingFrame(SocketEndpointConnectionDelta)
      • CalculateDeltaChanges()
      • EndUpdatingFrame()
      • HasChanges(TransformBroadcasterChangeType)
      • HasFlag(TransformBroadcasterChangeType, TransformBroadcasterChangeType)
      • OnDestroy()
      • ProcessConnectionDelta(SocketEndpointConnectionDelta, out IReadOnlyList<SocketEndpoint>, out IReadOnlyList<SocketEndpoint>, out IReadOnlyList<SocketEndpoint>)
      • ResetFrame()
      • SendCompleteChanges(IEnumerable<SocketEndpoint>)
      • SendComponentCreation(IEnumerable<SocketEndpoint>)
      • SendDeltaChanges(IEnumerable<SocketEndpoint>, TransformBroadcasterChangeType)
      • ShouldSendTransformInHierarchy(SocketEndpoint)
      • ShouldUpdateFrame(SocketEndpoint)
      • WriteChildHierarchyTree(BinaryWriter)
    • Implements
    Back to top Generated by DocFX