# bluebolt/bb_arnoldalembicprocedural architecture

> Architecture diagram of the GitHub repository bluebolt/bb_arnoldalembicprocedural, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bluebolt/bb_arnoldalembicprocedural
- Repository: https://github.com/bluebolt/bb_arnoldalembicprocedural

## Overview

##### Project type and purpose
- This is a C++ “procedural” plugin for the Arnold renderer that reads Alembic (.abc) archives and emits geometry (polymesh, curves, points, subd, etc.) into an Arnold scene.
- It’s invoked with command‐line style flags but ultimately is a shared‐object loaded inside Arnold as a procedural node.

##### Top‐level architectural components
A. Procedural Entry & Argument Handling
– ProcMain.cpp / ProcArgs.{cpp,h}
– Entry point registers the plugin, parses flags (–filename, –frame, –fps, user properties).

B. Alembic Parameter & Sampling Layer
– ArbGeomParams.{cpp,h}
– SampleUtil.{cpp,h}
– Encapsulates Alembic time mapping, shutter window computation, subd iteration handling.

C. Geometry‐Emitter Modules
– WriteGeo, WriteCurves, WritePoint, WriteTransform, WriteOverrides (all .cpp/.h)
– Each module knows how to traverse a subset (e.g. polymesh, curves, points, face‐sets) of the Alembic archive and emit corresponding Arnold primitives.

D. Utility Libraries
– PathUtil.{cpp,h}: path‐string manipulation for Alembic object paths.
– JSON wrapper (json/ directory + jsoncpp.cpp): parse user‐provided JSON dictionaries for overrides, userAttributes, shader assignments.
– pystring.{cpp,h}: Python‐style string utilities used by modules for pattern matching, wildcarding.

E. External Dependencies
– Alembic C++ SDK (AbcGeom API)
– Arnold C API for procedural registration & primitive creation
– JSONCPP (bundled in json/)
– CMakeLists.txt for build configuration

##### Key relationships and data flow
1. Arnold instantiates the procedural node → calls your ProcMain entry
2. ProcMain uses ProcArgs to parse flags & JSON property strings/files
3. Parsed parameters feed into ArbGeomParams to set up Alembic archive reader and sampling window
4. SampleUtil supplies time‐sampled data out of the archive
5. Writing modules (WriteGeo, WriteCurves, etc.) traverse the archive hierarchy (using PathUtil) and emit Arnold primitives
6. WriteOverrides & JSON parsing attach user‐overrides, shaders, displacement assignments to the emitted nodes

##### Architectural patterns and design principles
- Modular decomposition: each “Write…” module handles one primitive type
- Layered design: separation of argument parsing, sampling logic, write logic, and utilities
- Plugin pattern: registration via Arnold’s API, entry via ProcMain
- Data‐driven configuration: JSON dictionaries drive user overrides, shader assigns

– Each component clearly labeled
– Notes on key responsibilities (e.g., “WriteCurves: emits curve primitives from ICurves”)
– Grouping of modules by layer to reflect architectural separation

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "User"
        User["User"]
    end

    subgraph "Plugin Interface"
        ProcMain["ProcMain.cpp / Entry"]:::core
        ProcArgs["ProcArgs.cpp / ProcArgs.h"]:::core
    end

    subgraph "Core Logic"
        ArbGeomParams["ArbGeomParams.cpp / ArbGeomParams.h"]:::core
        SampleUtil["SampleUtil.cpp / SampleUtil.h"]:::core
    end

    subgraph "Geometry Writers"
        WriteGeo["WriteGeo.cpp / WriteGeo.h"]:::core
        WriteCurves["WriteCurves.cpp / WriteCurves.h"]:::core
        WritePoint["WritePoint.cpp / WritePoint.h"]:::core
        WriteTransform["WriteTransform.cpp / WriteTransform.h"]:::core
        WriteOverrides["WriteOverrides.cpp / WriteOverrides.h"]:::core
    end

    subgraph "Utilities"
        PathUtil["PathUtil.cpp / PathUtil.h"]:::util
        JSON["json/ + jsoncpp.cpp"]:::util
        Pystring["pystring.cpp / pystring.h"]:::util
    end

    subgraph "External Dependencies"
        AlembicSDK["Alembic C++ SDK"]:::external
        ArnoldAPI["Arnold C API"]:::external
    end

    subgraph "Build"
        CMake["CMakeLists.txt"]:::build
        README["README"]:::build
    end

    User -->|flags/JSON| ProcArgs
    ProcMain -->|"calls ProcArgs"| ProcArgs
    ProcMain -->|"registers plugin"| ArnoldAPI
    ProcArgs -->|"ParsedFlags"| ArbGeomParams
    ProcArgs -->|"reads JSON"| JSON
    ArbGeomParams -->|"configures sampling"| SampleUtil
    SampleUtil -->|"TimeSample"| WriteGeo
    SampleUtil -->|"TimeSample"| WriteCurves
    SampleUtil -->|"TimeSample"| WritePoint
    SampleUtil -->|"TimeSample"| WriteTransform
    SampleUtil -->|"TimeSample"| WriteOverrides
    WriteGeo -->|"uses PathUtil"| PathUtil
    WriteCurves -->|"uses PathUtil"| PathUtil
    WritePoint -->|"uses PathUtil"| PathUtil
    WriteTransform -->|"uses PathUtil"| PathUtil
    WriteOverrides -->|"reads OverrideDict"| JSON
    WriteGeo -->|"emits primitives"| ArnoldAPI
    WriteCurves -->|"emits primitives"| ArnoldAPI
    WritePoint -->|"emits primitives"| ArnoldAPI
    WriteTransform -->|"emits primitives"| ArnoldAPI
    WriteOverrides -->|"emits primitives"| ArnoldAPI
    CMake -->|"builds & links"| ProcMain
    CMake -->|"builds & links"| ProcArgs
    CMake -->|"builds & links"| ArbGeomParams
    CMake -->|"builds & links"| SampleUtil
    CMake -->|"builds & links"| WriteGeo
    CMake -->|"builds & links"| WriteCurves
    CMake -->|"builds & links"| WritePoint
    CMake -->|"builds & links"| WriteTransform
    CMake -->|"builds & links"| WriteOverrides
    CMake -->|"includes"| PathUtil
    CMake -->|"includes"| JSON
    CMake -->|"includes"| Pystring
    CMake -->|"links"| AlembicSDK
    CMake -->|"links"| ArnoldAPI

    click ProcMain "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/ProcMain.cpp"
    click ProcArgs "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/ProcArgs.cpp"
    click ProcArgs "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/ProcArgs.h"
    click ArbGeomParams "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/ArbGeomParams.cpp"
    click ArbGeomParams "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/ArbGeomParams.h"
    click SampleUtil "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/SampleUtil.cpp"
    click SampleUtil "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/SampleUtil.h"
    click WriteGeo "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteGeo.cpp"
    click WriteGeo "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteGeo.h"
    click WriteCurves "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteCurves.cpp"
    click WriteCurves "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteCurves.h"
    click WritePoint "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WritePoint.cpp"
    click WritePoint "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WritePoint.h"
    click WriteTransform "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteTransform.cpp"
    click WriteTransform "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteTransform.h"
    click WriteOverrides "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteOverrides.cpp"
    click WriteOverrides "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/WriteOverrides.h"
    click PathUtil "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/PathUtil.cpp"
    click PathUtil "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/PathUtil.h"
    click JSON "https://github.com/bluebolt/bb_arnoldalembicprocedural/tree/master/json/"
    click JSON "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/jsoncpp.cpp"
    click Pystring "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/pystring.cpp"
    click Pystring "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/pystring.h"
    click CMake "https://github.com/bluebolt/bb_arnoldalembicprocedural/blob/master/CMakeLists.txt"
    click README "https://github.com/bluebolt/bb_arnoldalembicprocedural/tree/master/README"

    classDef core fill:#ADD8E6,stroke:#000
    classDef util fill:#90EE90,stroke:#000
    classDef external fill:#FFFF99,stroke:#000
    classDef build fill:#D3D3D3,stroke:#000
```
