1.0.0 • Published 3 months ago

@itk-wasm/mesh-to-poly-data v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

@itk-wasm/mesh-to-poly-data

npm version

Convert an ITK Mesh to a simple data structure compatible with vtkPolyData.

Installation

npm install @itk-wasm/mesh-to-poly-data

Usage

Browser interface

Import:

import {
  meshToPolyData,
  polyDataToMesh,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/mesh-to-poly-data"

meshToPolyData

Convert an itk::Mesh to an itk::PolyData

async function meshToPolyData(
  mesh: Mesh,
  options: MeshToPolyDataOptions = {}
) : Promise<MeshToPolyDataResult>
ParameterTypeDescription
meshMeshInput mesh

MeshToPolyDataOptions interface:

PropertyTypeDescription
webWorkernull or Worker or booleanWebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker.
noCopybooleanWhen SharedArrayBuffer's are not available, do not copy inputs.

MeshToPolyDataResult interface:

PropertyTypeDescription
polyDataPolyDataOutput polydata
webWorkerWorkerWebWorker used for computation.

polyDataToMesh

Convert an itk::PolyData to an itk::Mesh

async function polyDataToMesh(
  polyData: PolyData,
  options: PolyDataToMeshOptions = {}
) : Promise<PolyDataToMeshResult>
ParameterTypeDescription
polyDataPolyDataInput polydata

PolyDataToMeshOptions interface:

PropertyTypeDescription
webWorkernull or Worker or booleanWebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker.
noCopybooleanWhen SharedArrayBuffer's are not available, do not copy inputs.

PolyDataToMeshResult interface:

PropertyTypeDescription
meshMeshOutput mesh
webWorkerWorkerWebWorker used for computation.

setPipelinesBaseUrl

Set base URL for WebAssembly assets when vendored.

function setPipelinesBaseUrl(
  baseUrl: string | URL
) : void

getPipelinesBaseUrl

Get base URL for WebAssembly assets when vendored.

function getPipelinesBaseUrl() : string | URL

Node interface

Import:

import {
  meshToPolyDataNode,
  polyDataToMeshNode,
} from "@itk-wasm/mesh-to-poly-data"

meshToPolyDataNode

Convert an itk::Mesh to an itk::PolyData

async function meshToPolyDataNode(
  mesh: Mesh
) : Promise<MeshToPolyDataNodeResult>
ParameterTypeDescription
meshMeshInput mesh

MeshToPolyDataNodeResult interface:

PropertyTypeDescription
polyDataPolyDataOutput polydata

polyDataToMeshNode

Convert an itk::PolyData to an itk::Mesh

async function polyDataToMeshNode(
  polyData: PolyData
) : Promise<PolyDataToMeshNodeResult>
ParameterTypeDescription
polyDataPolyDataInput polydata

PolyDataToMeshNodeResult interface:

PropertyTypeDescription
meshMeshOutput mesh
1.0.0

3 months ago

0.1.0

5 months ago