Class SpeckleUnityUpdate

A container of data describing what stream just got updated, what Transform it's under and what type of update it had so that user code can respond accordingly.

Inheritance

System.Object

SpeckleUnityUpdate

Namespace: SpeckleUnity

Assembly: cs.temp.dll.dll

Syntax

public class SpeckleUnityUpdate

Constructors

SpeckleUnityUpdate(String, Transform, UpdateType, Single)

Constructs a new instance of this object with all its values assigned.

Declaration

public SpeckleUnityUpdate(string streamID, Transform streamRoot, UpdateType updateType, float updateProgress)

Parameters

Type	Name	Description
System.String	streamID	The ID of the stream that got updated.
Transform	streamRoot	The root Transform of the stream that got updated.
UpdateType	updateType	The type of update made to the stream.
System.Single	updateProgress	The current progress of the ongoing update.

Fields

streamID

The ID of the stream that got updated.

Declaration

public string streamID

Field Value

Type	Description
System.String

streamRoot

The root Transform of the stream that got updated.

Declaration

public Transform streamRoot

Field Value

Type	Description
Transform

updateProgress

A value from 0-1 describing how far along the update is. Can be used to represent a percentage;

Declaration

public float updateProgress

Field Value

Type	Description
System.Single

updateType

The type of update made to the stream.

Declaration

public UpdateType updateType

Field Value

Type	Description
UpdateType