Class ComponentBroadcasterDefinition<TComponentBroadcaster>

Attaches a ComponentBroadcaster of type TComponentBroadcaster to a GameObject if and only if a required set of Component types are present on the GameObject.

Inheritance

Object

ComponentBroadcasterDefinition

ComponentBroadcasterDefinition<TComponentBroadcaster>

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.SpectatorView

Assembly: cs.temp.dll.dll

Syntax

public class ComponentBroadcasterDefinition<TComponentBroadcaster> : ComponentBroadcasterDefinition where TComponentBroadcaster : Component

Type Parameters

Name	Description
TComponentBroadcaster	The type of ComponentBroadcaster to attach when requirements are met.

Constructors

ComponentBroadcasterDefinition(Boolean, Type[])

Creates a new definition, specifying whether the component definition is a transform controller and which set of Component types are required.

Declaration

public ComponentBroadcasterDefinition(bool isTransformBroadcasterController, params Type[] requiredComponents)

Parameters

Type	Name	Description
Boolean	isTransformBroadcasterController	Whether or not this component is a transform controller.
Type[]	requiredComponents	The set of Component types which must be present on the GameObject in order for the ComponentBroadcaster to be created. An empty list means that the ComponentBroadcaster will never be created.

ComponentBroadcasterDefinition(Type[])

Creates a new definition with a set of required Component types.

Declaration

public ComponentBroadcasterDefinition(params Type[] requiredComponents)

Parameters

Type	Name	Description
Type[]	requiredComponents	The set of Component types which must be present on the GameObject in order for the ComponentBroadcaster to be created. An empty list means that the ComponentBroadcaster will never be created.

Properties

IsTransformBroadcasterController

Declaration

public override bool IsTransformBroadcasterController { get; }

Property Value

Type	Description
Boolean

Overrides

ComponentBroadcasterDefinition.IsTransformBroadcasterController

Methods

EnsureComponentBroadcastersCreated(GameObject, out Boolean)

Method which checks for the existence of requirements on the provided GameObject and either creates or destroys ComponentBroadcasters as necessary.

Declaration

public override void EnsureComponentBroadcastersCreated(GameObject gameObject, out bool changesDetected)

Parameters

Type	Name	Description
GameObject	gameObject	The GameObject to check the state of.
Boolean	changesDetected	True if ComponentBroadcasters were added or removed, otherwise false.

Overrides

ComponentBroadcasterDefinition.EnsureComponentBroadcastersCreated(GameObject, out Boolean)