Skip to content

editor › Globals › MeshAnnotationSerializer

Class: MeshAnnotationSerializer ‹T, S›

Type parameters

▪ T: MeshAnnotation

▪ S: ISerializedMeshAnnotation

Hierarchy

↳ MeshAnnotationSerializer

↳ SurfaceDisabledAnnotationSerializer

↳ SurfaceDisplayAnnotationSerializer

↳ EdgeUnfoldingAnnotationSerializer

Index

Methods

Methods

Protected _deserializePlane

▸ _deserializePlane(plane: ISerializedPlane): Plane

Inherited from BaseSerializer._deserializePlane

Defined in src/history/serialization/BaseSerializer.ts:155

Convenience method to serialize a Plane without invoking an extra serializer.

Parameters:

Name Type Description
plane ISerializedPlane -

Returns: Plane

Protected _deserializeQuaternion

▸ _deserializeQuaternion(quaternion: ISerializedQuaternion): Quaternion

Inherited from BaseSerializer._deserializeQuaternion

Defined in src/history/serialization/BaseSerializer.ts:136

Convenience method to deserialize a Vector3 without invoking an extra serializer.

Parameters:

Name Type Description
quaternion ISerializedQuaternion -

Returns: Quaternion

Protected _deserializeVector3

▸ _deserializeVector3(vector: ISerializedVector3): Vector3

Inherited from BaseSerializer._deserializeVector3

Defined in src/history/serialization/BaseSerializer.ts:115

Convenience method to deserialize a Vector3 without invoking an extra serializer.

Parameters:

Name Type
vector ISerializedVector3

Returns: Vector3

Protected _serializePlane

▸ _serializePlane(plane: Plane): ISerializedPlane

Inherited from BaseSerializer._serializePlane

Defined in src/history/serialization/BaseSerializer.ts:144

Convenience method to serialize a Plane without invoking an extra serializer.

Parameters:

Name Type Description
plane Plane -

Returns: ISerializedPlane

Protected _serializeQuaternion

▸ _serializeQuaternion(quaternion: Quaternion): ISerializedQuaternion

Inherited from BaseSerializer._serializeQuaternion

Defined in src/history/serialization/BaseSerializer.ts:123

Convenience method to serialize a Quaternion without invoking an extra serializer.

Parameters:

Name Type Description
quaternion Quaternion -

Returns: ISerializedQuaternion

Protected _serializeVector3

▸ _serializeVector3(vector: ReadonlyVector3): ISerializedVector3

Inherited from BaseSerializer._serializeVector3

Defined in src/history/serialization/BaseSerializer.ts:104

Convenience method to serialize a Vector3 without invoking an extra serializer.

Parameters:

Name Type
vector ReadonlyVector3

Returns: ISerializedVector3

Abstract deserialize

▸ deserialize(serialized: LatestSerializedObjectVersion): T

Inherited from BaseSerializer.deserialize

Defined in src/history/serialization/BaseSerializer.ts:80

This method should instantiate the deserialized object and fill it with the information that can be retrieved from the serialized object serialized. Any references to other objects, that depend on another Serializer (i.e. that used enqueueObjectToSerialize in the serialize method) must be resolved in linkDependencies.

remarks Classes might have to be adapted to allow for this separation between instantiation and initialization.

Parameters:

Name Type Description
serialized LatestSerializedObjectVersion the serialized object in POJO form, not as a string

Returns: T

linkDependencies

▸ linkDependencies(meshAnnotation: T, serialized: ISerializedMeshAnnotation, resolve: function): void

Overrides BaseSerializer.linkDependencies

Defined in src/history/serialization/MeshAnnotationSerializer.ts:21

Parameters:

▪ meshAnnotation: T

▪ serialized: ISerializedMeshAnnotation

▪ resolve: function

▸ (name: string): any

Parameters:

Name Type
name string

Returns: void

serialize

▸ serialize(annotation: T, enqueueObjectToSerialize: function): S

Overrides BaseSerializer.serialize

Defined in src/history/serialization/MeshAnnotationSerializer.ts:15

Subclasses must overwrite this method and return a proper S

Parameters:

▪ annotation: T

▪ enqueueObjectToSerialize: function

▸ (o: any): string

Parameters:

Name Type
o any

Returns: S

Static getSerializedClass

▸ getSerializedClass(): object

Inherited from BaseSerializer.getSerializedClass

Defined in src/history/serialization/BaseSerializer.ts:52

Return a reference to the class that is serialized by this Serializer.

Returns: object

Static getSerializedClassName

▸ getSerializedClassName(): string

Inherited from BaseSerializer.getSerializedClassName

Defined in src/history/serialization/BaseSerializer.ts:45

Overwrite in subclass. Warning: Do not use getSerializedClass().name because the name is minified in production.

Returns: string

the (unique) name of the class that is serialized