Namespace SpeckleUnity

Classes

Contains all extension method definitions for converting Speckle stream object types into native Unity types and vice versa.

SpeckleUnityClient

Base class for all SpeckleUnity client types. Inherit from this class to define your own client types.

SpeckleUnityGeometry

Base definition for all rendered stream objects. Any Speckle object that needs to be displayed with a game object should inherit from this class.

SpeckleUnityManager

Manages the stream interactions for a single user in the scene and exposes parameters that control the output of the stream conversion.

SpeckleUnityMesh

A stream object represented as a gameobject with a MeshRenderer. Also adds a MeshCollider to the object. The material is assigned by the SpeckleUnityReceiver.

SpeckleUnityNumber

Contains a float, no game object to display

SpeckleUnityObject

Base class for all native SpeckleUnity objects

SpeckleUnityPoint

Display Point. Uses a line renderer for display. The material is assigned by the SpeckleUnityReceiver.

SpeckleUnityPolyline

Used to display lines, curves, or polylines as a game object with a LineRenderer. The material is assigned by the SpeckleUnityReceiver.

A SpeckleUnityClient specialised in receiving streams and updating the scene to reflect any updates made to the stream. Made serializable so that it would render in the inspector along with its exposed fields.

SpeckleUnitySender

A SpeckleUnityClient specialised in sending streams and updating the server to reflect any updates made to the scene. Made serializable so that it would render in the inspector along with its exposed fields.

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.

SpeckleUnityUpdateEvent

A custom UnityEvent type for assigning methods to in the inspector of a manger instance. The methods need to be public and accept a single argument of type SpeckleUnityUpdate in order to be assignable.

WSMessageData

Concrete type for the json structure of the web socket message data to deserialize into.

WSMessageDataArgs

Concrete type for the json structure of the nested web socket message argument data to deserialize into.

Enums

SpawnSpeed

An enum for controlling how quickly geometry objects get isntantiated into the scene. The Instant value simply means all objects will be spawned in the same frame. (Technically, it caps out at 2 billion, but who in the world is making streams bigger than 2 billion...)

StartMode

An enum for controlling what the default start behaviour of a SpeckleUnityManager would be.

UpdateType

The type of update that a receiver was notified of for a given stream.

Delegates

SpeckleUnityValueChange

A delegate which is invoked whenever a stream is updated. Intended for use with the SpeckleUnitySender which will eventually be supported.