Interface IModelStream

Represents a stream of a specific model instance on the IStage.

Namespace: Unity.Cloud.DataStreaming.Runtime

Assembly: Unity.Cloud.DataStreaming.Runtime.dll

Syntax

public interface IModelStream

Properties

Id

The unique identifier to this IModelStream instance.

Declaration

ModelStreamId Id { get; }

Property Value

Type	Description
ModelStreamId

Transform

Returns an object to manipulate the model transform.

Declaration

ITransformValuesAccessor Transform { get; }

Property Value

Type	Description
ITransformValuesAccessor

Visibility

Returns an object to manipulate the model visibility.

Declaration

IModelVisibilityAccessor Visibility { get; }

Property Value

Type	Description
IModelVisibilityAccessor

Methods

LoadGeometryAsync(GeometryPayload, CancellationToken)

Download the geometry's mesh from the server.

Declaration

Task<GeometryObject> LoadGeometryAsync(GeometryPayload geometryPayload, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GeometryPayload	geometryPayload	The geometry payload which should be taken from a metadata query.
CancellationToken	cancellationToken	A cancellation token which can be used to abort the asynchronous function call.

Returns

Type	Description
Task<GeometryObject>	A GeometryObject which should be used to instantiate GameObjects for one or more instances.

LoadGeometryAsync(GeometryPayload, CancellationToken)

Download the geometry's mesh from the server.

Declaration

[Obsolete("Use LoadGeometryAsync(Unity.Cloud.Metadata.Runtime.GeometryPayload, CancellationToken) instead.", false)]
Task<GeometryObject> LoadGeometryAsync(GeometryPayload geometryPayload, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GeometryPayload	geometryPayload	The geometry payload which should be taken from a metadata query.
CancellationToken	cancellationToken	A cancellation token which can be used to abort the asynchronous function call.

Returns

Type	Description
Task<GeometryObject>	A GeometryObject which should be used to instantiate GameObjects for one or more instances.