Interface IInstanceUpdater

Implement this interface to update instances via derived classes of InstanceModifier.

Namespace: Unity.Cloud.DataStreaming.Runtime

Assembly: Unity.Cloud.DataStreaming.Runtime.dll

Syntax

public interface IInstanceUpdater

Methods

SetHighlight(ModelStreamId, IEnumerable<InstanceId>, Color32)

Change the highlight state for the given instances. Once all InstanceModifier have been evaluated, the corresponding RenderObjectId shader will be updated based on those states.

Declaration

void SetHighlight(ModelStreamId modelStreamId, IEnumerable<InstanceId> instances, Color32 highlight)

Parameters

Type	Name	Description
ModelStreamId	modelStreamId	Owner of the instances.
IEnumerable<InstanceId>	instances	Instances to update their state.
Color32	highlight	Set the highlight color to this value.

Exceptions

Type	Condition
ArgumentException	Throw an exception if an Unity.Cloud.Common.InstanceId is not loaded.

SetVisibility(ModelStreamId, IEnumerable<InstanceId>, bool)

Change the visibility state for the given instances. Once all InstanceModifier have been evaluated, the corresponding RenderObjectId shader will be updated based on those states.

Declaration

void SetVisibility(ModelStreamId modelStreamId, IEnumerable<InstanceId> instances, bool visibility)

Parameters

Type	Name	Description
ModelStreamId	modelStreamId	Owner of the instances.
IEnumerable<InstanceId>	instances	Instances to update their state.
bool	visibility	true to set display the instances; false to hide the instances.

Exceptions

Type	Condition
ArgumentException	Throw an exception if an Unity.Cloud.Common.InstanceId is not loaded.

SetVisibility(ModelStreamId, IEnumerable<InstanceId>, bool, Action)

Change the visibility state for the given instances. Once all InstanceModifier have been evaluated, the corresponding RenderObjectId shader will be updated based on those states.

Declaration

void SetVisibility(ModelStreamId modelStreamId, IEnumerable<InstanceId> instances, bool visibility, Action completed)

Parameters

Type	Name	Description
ModelStreamId	modelStreamId	Owner of the instances.
IEnumerable<InstanceId>	instances	Instances to update their state.
bool	visibility	true to set display the instances; false to hide the instances.
Action	completed	Execute this call once the shader is updated.

Exceptions

Type	Condition
ArgumentException	Throw an exception if an Unity.Cloud.Common.InstanceId is not loaded.