Class CreateSpatial3DAttachmentRequest

Represents a request to create a new annotation Spatial-3D attachment

Inheritance
object
CreateSpatial3DAttachmentRequest
Implements
Inherited Members
Namespace: Unity.Cloud.Collaboration.Models.AttachmentRequest
Assembly: Unity.Cloud.Collaboration.dll
Syntax
public class CreateSpatial3DAttachmentRequest : ICreateSpatial3DAttachmentRequest, ICreateAttachmentRequest

Constructors

CreateSpatial3DAttachmentRequest(string, SpatialPosition?, ICameraDetails, Dictionary<string, object>, TimeDetails?, ILocalSpaceDetails)

Initializes a new instance of the CreateSpatial3DAttachmentRequest class.

Declaration
public CreateSpatial3DAttachmentRequest(string label, SpatialPosition? position, ICameraDetails camera, Dictionary<string, object> metadata = null, TimeDetails? time = null, ILocalSpaceDetails local = null)
Parameters
Type Name Description
string label

The label for the spatial 3D attachment. Required.
SpatialPosition? position

The spatial position of the attachment. Required.
ICameraDetails camera

Camera details associated with the attachment. Required.
Dictionary<string, object> metadata

Optional metadata for the attachment.
TimeDetails? time

Optional time details for the attachment.
ILocalSpaceDetails local

Optional local space details for the attachment.
Exceptions
Type Condition
ArgumentNullException

Thrown when label, position, or camera is null or empty.

Properties

Camera

Camera data structure.

Declaration
public ICameraDetails Camera { get; }
Property Value
Type Description
ICameraDetails

Label

A simple label for the attachment

Declaration
public string Label { get; }
Property Value
Type Description
string

Local

LocalSpace datastructure.

Declaration
public ILocalSpaceDetails Local { get; }
Property Value
Type Description
ILocalSpaceDetails

Metadata

Metadata for the Attachment

Declaration
public Dictionary<string, object> Metadata { get; }
Property Value
Type Description
Dictionary<string, object>

Position

The representation of the attachment position (3D).

Declaration
public SpatialPosition Position { get; }
Property Value
Type Description
SpatialPosition

Time

Time data structure.

Declaration
public TimeDetails? Time { get; }
Property Value
Type Description
TimeDetails?

Type

The type of the Attachment, this should be used to identify the specific type of Attachment given

Declaration
public string Type { get; }
Property Value
Type Description
string

Implements