bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Interface AssemblyHierarchyNode

    Node in the assembly hierarchy. Provides comprehensive information about each element in the assembly tree.

    interface AssemblyHierarchyNode {
        id: string;
        parentId?: string;
        depth: number;
        label: string;
        name: string;
        isAssembly: boolean;
        isInstance: boolean;
        definitionId?: string;
        refersToAssembly?: boolean;
        refersToPart?: boolean;
        nodeType: string;
        isPart: boolean;
        isSubShape: boolean;
        isFreeShape: boolean;
        isCompound: boolean;
        hasGeometry: boolean;
        shapeType?: string;
        subShapeCounts?: SubShapeCounts;
        visible: boolean;
        colorRgba?: ColorRGBA;
        transform?: TransformMatrix;
    }
    Index

    Properties

    id parentId? depth label name isAssembly isInstance definitionId? refersToAssembly? refersToPart? nodeType isPart isSubShape isFreeShape isCompound hasGeometry shapeType? subShapeCounts? visible colorRgba? transform?

    Properties

    id: string

    Unique node ID (same as label entry)

    parentId?: string

    Parent node ID (if not root)

    depth: number

    Depth in hierarchy (0 = root)

    label: string

    Label entry string (e.g., "0:1:1:1")

    name: string

    Node name

    isAssembly: boolean

    Whether this label IS an assembly container (not just references one)

    isInstance: boolean

    Whether this is an instance (reference to a part/assembly)

    definitionId?: string

    Definition ID (for instances - the label of the referenced part/assembly)

    refersToAssembly?: boolean

    True if this instance references an assembly (only present for instances)

    refersToPart?: boolean

    True if this instance references a part (only present for instances)

    nodeType: string

    Detailed node type:

    • "assembly": An assembly container
    • "instance-part": An instance referencing a part
    • "instance-assembly": An instance referencing an assembly
    • "instance": An instance (type unknown)
    • "part": An original part definition (not an instance)
    • "subshape": A sub-shape of another shape
    • "compound": A compound shape
    • "unknown": Unknown type
    isPart: boolean

    Whether this IS an original part definition (not an instance). An instance is never a part - use refersToPart to check what an instance references.

    isSubShape: boolean

    Whether this is a sub-shape of another shape

    isFreeShape: boolean

    Whether this is a free (root-level) shape

    isCompound: boolean

    Whether this is a compound shape

    hasGeometry: boolean

    Whether this node has associated geometry

    shapeType?: string

    Shape type if has geometry: "solid", "compound", "shell", "face", "wire", "edge", "vertex", "shape", "none"

    subShapeCounts?: SubShapeCounts

    Sub-shape counts (for compounds and assemblies)

    visible: boolean

    Whether node is visible

    colorRgba?: ColorRGBA

    Color if set (RGBA, values 0-1)

    transform?: TransformMatrix

    Local transform (4x4 matrix, column-major)

    Settings

    Member Visibility

    On This Page

    Properties