Speckle Docs

# GeometryConverter

Abstract class

#

Constructors

constructor

#

Methods

getSpeckleType convertNodeToGeometryData disposeNodeGeometryData

#

Typedefs

SpeckleType

#

Constructors

# constructor

constructor();
1

Default constructor.

#

Methods

# getSpeckleType

abstract getSpeckleType(node: NodeData): SpeckleType
1

Gets an opinionated SpeckleType based on the node's data.

Parameters

Returns: SpeckleType

# convertNodeToGeometryData

abstract convertNodeToGeometryData(node: NodeData): GeometryData
1

Takes in NodeData and outputs viewer defined geometry data.

Parameters

Returns: GeometryData

# disposeNodeGeometryData

abstract disposeNodeGeometryData(node: NodeData): void
1

Parameters

  • node: NodeData Disposes the explicit node data geometry

Returns: void

#

Typedefs

# SpeckleType

enum SpeckleType {
  View3D = "View3D",
  BlockInstance = "BlockInstance",
  Pointcloud = "Pointcloud",
  Brep = "Brep",
  Mesh = "Mesh",
  Point = "Point",
  Line = "Line",
  Polyline = "Polyline",
  Box = "Box",
  Polycurve = "Polycurve",
  Curve = "Curve",
  Circle = "Circle",
  Arc = "Arc",
  Ellipse = "Ellipse",
  RevitInstance = "RevitInstance",
  Text = "Text",
  Transform = "Transform",
  Unknown = "Unknown",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Non-exhaustive enum for viewer recognized object types.

← Input →