@shapediver/sdk.sdtf-rhino3dm
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    ShapeDiver

    Structured Data Transfer Format - Integration for rhino3dm types

    The Structured Data Transfer Format (sdTF) is an API-neutral exchange and storage format for trees of data items as used by parametric 3D modeling software like Grasshopper®. This open, efficient, and easily extensible data format enables the exchange of complex data structures, independent of software vendors. See the sdTF documentation for more details.

    The aim of this package is to extend the sdTF-v1 module to provide processing and typing functionality for rhino3dm.js data.

    It can be used in Node.js and modern Browsers, and exposes the respective TypeScript declarations.

    Installation

    npm i @shapediver/sdk.sdtf-v1 @shapediver/sdk.sdtf-rhino3dm

    This package is a plugin for the sdTF-v1 module and cannot be used by itself.

    Usage

    This code initializes the SDK and registers the integration for rhino3dm types. After this step, the integration is fully included in all reading and writing processes of the SDK instance.

    // index.ts
    import { create, SdtfSdk } from "@shapediver/sdk.sdtf-v1"
    import { SdtfRhino3dmTypeIntegration } from "@shapediver/sdk.sdtf-rhino3dm"
    
    (async () => {
        const sdk: SdtfSdk = await create({
            integrations: [ new SdtfRhino3dmTypeIntegration() ]
        })
    
        // Use the sdk here
    })()

    Configuration

    The behaviour of the integration can be configured by passing a partial SdtfRhino3dmTypeConfig object to the constructor.

    config.enableCompression:
    When creating a new sdTF file, the integration stores all rhino3dm components in a File3dm object and stores them in the sdTF binary buffer. When enableCompression is set to true, the File3dm object is compressed via GZIP to reduce its overall size.

    Default: true

    config.requireValidRhino3dmComponents:
    When creating a new sdTF file, the integration stores all rhino3dm components in a File3dm object and stores them in the sdTF binary buffer. When requireValidRhino3dmComponents is set to true, all rhino3dm components are tested for validity via the isValid function, before they are written.

    Default: true

    Example:

    const sdk: SdtfSdk = await create({
        integrations: [ new SdtfRhino3dmTypeIntegration({
            enableCompression: false,                               // Disable GZIP compression of the `File3dm` object
            requireValidRhino3dmComponents: false                   // Disable the validation-check for all rhino3dm components
        }) ]
    })

    Supported types

    The following table lists all type hints that are supported by this integration, their specific TypeScript types, and the provided type guard functions that can be used to infer a data content type.

    Type hint name TypeScript type Type guard
    "grasshopper.path" or SdtfGrasshopperTypeHintName.GRASSHOPPER_PATH string SdtfRhino3dmTypeGuard.assertGrasshopperPath
    SdtfRhino3dmTypeGuard.isGrasshopperPath
    "rhino.arccurve" or SdtfRhino3dmTypeGuard.RHINO_ARC_CURVE ArcCurve SdtfRhino3dmTypeGuard.assertArcCurve
    SdtfRhino3dmTypeGuard.isArcCurve
    "rhino.brep" or SdtfRhino3dmTypeGuard.RHINO_BREP Brep SdtfRhino3dmTypeGuard.assertBrep
    SdtfRhino3dmTypeGuard.isBrep
    "rhino.curve" or SdtfRhino3dmTypeGuard.RHINO_CURVE Curve SdtfRhino3dmTypeGuard.assertCurve
    SdtfRhino3dmTypeGuard.isCurve
    "rhino.extrusion" or SdtfRhino3dmTypeGuard.RHINO_EXTRUSION Extrusion SdtfRhino3dmTypeGuard.assertExtrusion
    SdtfRhino3dmTypeGuard.isExtrusion
    "rhino.linecurve" or SdtfRhino3dmTypeGuard.RHINO_LINE_CURVE LineCurve SdtfRhino3dmTypeGuard.assertLineCurve
    SdtfRhino3dmTypeGuard.isLineCurve
    "rhino.mesh" or SdtfRhino3dmTypeGuard.RHINO_MESH Mesh SdtfRhino3dmTypeGuard.assertMesh
    SdtfRhino3dmTypeGuard.isMesh
    "rhino.nurbscurve" or SdtfRhino3dmTypeGuard.RHINO_NURBS_CURVE NurbsCurve SdtfRhino3dmTypeGuard.assertNurbsCurve
    SdtfRhino3dmTypeGuard.isNurbsCurve
    "rhino.nurbssurface" or SdtfRhino3dmTypeGuard.RHINO_NURBS_SURFACE NurbsSurface SdtfRhino3dmTypeGuard.assertNurbsSurface
    SdtfRhino3dmTypeGuard.isNurbsSurface
    "rhino.planesurface" or SdtfRhino3dmTypeGuard.RHINO_PLANE_SURFACE PlaneSurface SdtfRhino3dmTypeGuard.assertPlaneSurface
    SdtfRhino3dmTypeGuard.isPlaneSurface
    "rhino.point" or SdtfRhino3dmTypeGuard.RHINO_POINT Point SdtfRhino3dmTypeGuard.assertPoint
    SdtfRhino3dmTypeGuard.isPoint
    "rhino.polycurve" or SdtfRhino3dmTypeGuard.RHINO_POLY_CURVE PolyCurve SdtfRhino3dmTypeGuard.assertPolyCurve
    SdtfRhino3dmTypeGuard.isPolyCurve
    "rhino.polylinecurve" or SdtfRhino3dmTypeGuard.RHINO_POLYLINE_CURVE PolylineCurve SdtfRhino3dmTypeGuard.assertPolylineCurve
    SdtfRhino3dmTypeGuard.isPolylineCurve
    "rhino.revsurface" or SdtfRhino3dmTypeGuard.RHINO_REV_SURFACE RevSurface SdtfRhino3dmTypeGuard.assertRevSurface
    SdtfRhino3dmTypeGuard.isRevSurface
    "rhino.subd" or SdtfRhino3dmTypeGuard.RHINO_SUBD SubD SdtfRhino3dmTypeGuard.assertSubD
    SdtfRhino3dmTypeGuard.isSubD
    "rhino.surface" or SdtfRhino3dmTypeGuard.RHINO_SURFACE Surface SdtfRhino3dmTypeGuard.assertSurface
    SdtfRhino3dmTypeGuard.isSurface

    Example

    This example creates a new sdTF file that contains two rhino3dm point-objects. Afterward, the created sdTF file is parsed and both points are extracted. Since the extracted points are of type unknown, a type guard function is used to check and infer the content type to Point.

    // index.ts
    import { SdtfRhino3dmTypeGuard, SdtfRhino3dmTypeIntegration } from "@shapediver/sdk.sdtf-rhino3dm"
    import { create, SdtfRhinoTypeHintName, SdtfSdk } from "@shapediver/sdk.sdtf-v1"
    import { RhinoModule } from "rhino3dm"
    
    (async () => {
        const sdk: SdtfSdk = await create({
            integrations: [ new SdtfRhino3dmTypeIntegration() ],
        })
    
        const rhino: RhinoModule = await require("rhino3dm")()      // Initialize the rhino3dm library
        const constructor = sdk.createConstructor()
    
        // Create a simple sdTF structure that contains two rhino3dm point-components
        const writeableAsset = constructor
            .getWriter()
            .createSimpleDataSdtf("points", [
                { content: new rhino.Point([ 1, 2, 3 ]), typeHint: SdtfRhinoTypeHintName.RHINO_POINT },
                { content: new rhino.Point([ 4, 5, 6 ]), typeHint: SdtfRhinoTypeHintName.RHINO_POINT },
            ])
    
        // Creates a new sdTF file from the writeable-asset.
        //
        // Note:
        //   The integration compresses the rhino3dm components and writes them into the binary buffer to reduce the overall size.
        //   When the file is parsed later on, the integration instantiates and returns new rhino3dm components.
        const sdTF = constructor.createBinarySdtf(writeableAsset)
    
        // sdTF - JSON content:
        // {
        //     "asset": {
        //         "generator": "ShapeDiverSdtfWriter",
        //         "version": "1.0"
        //     },
        //     "chunks": [
        //         {
        //             "items": [ 0, 1 ],
        //             "name": "points"
        //         }
        //     ],
        //     "nodes": [],
        //     "items": [
        //         {
        //             "accessor": 0,
        //             "typeHint": 0
        //         },
        //         {
        //             "accessor": 1,
        //             "typeHint": 0
        //         }
        //     ],
        //     "attributes": [],
        //     "typeHints": [
        //         { "name": "rhino.point" }
        //     ],
        //     "accessors": [
        //         {
        //             "bufferView": 0,
        //             "id": "ddd41af3-a02a-4c07-eacb-02627113ef65"
        //         },
        //         {
        //             "bufferView": 0,
        //             "id": "b086ae7c-e0cd-45c4-aa58-5a2aead343f6"
        //         }
        //     ],
        //     "bufferViews": [
        //         {
        //             "buffer": 0,
        //             "byteLength": 949,
        //             "byteOffset": 0,
        //             "contentEncoding": "gzip",
        //             "contentType": "model/vnd.3dm"
        //         }
        //     ],
        //     "buffers": [
        //         { "byteLength": 952 }
        //     ]
        // }
    
        // Reads the previously created sdTF file
        const readableAsset = sdk.createParser().readFromBuffer(sdTF)
    
        const point1 = await readableAsset.items[0].getContent()    // load first point of type `unknown`
        SdtfRhino3dmTypeGuard.assertPoint(point1)                   // infer the type to `Point`; throws if not possible
        point1.scale(5)                                             // manipulate point
    
        const point2 = await readableAsset.items[1].getContent()    // load second point of type `unknown`
        SdtfRhino3dmTypeGuard.assertPoint(point2)                   // infer the type to `Point`; throws if not possible
        point1.scale(3)                                             // manipulate point
    })()

    Support

    If you have questions, please use the ShapeDiver Help Center.

    You can find out more about ShapeDiver right here.

    Licensing

    This project is released under the MIT License.

    Install

    npm i @shapediver/sdk.sdtf-rhino3dm

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    ISC

    Unpacked Size

    82.6 kB

    Total Files

    34

    Last publish

    Collaborators

    • dmitry_at_shapediver
    • snabela
    • michael_at_shapediver
    • matt_at_shapediver
    • luka_at_shapediver