API Reference

Complete reference documentation for all volmdlr_tools modules and classes.

Module Overview

Module	Description
volmdlr_tools.graph package	Graph classes (Graph, AAG, GraphAssembly) and kinematics
volmdlr_tools.features package	Feature recognition, extraction, and classification
volmdlr_tools.shapes package	Shape recognizers (sheet metal, bearings, swept shapes)
volmdlr_tools.assembly package	Assembly analysis utilities and finders
volmdlr_tools.distance package	Distance and interference calculations
volmdlr_tools.wires package	Wire manipulation utilities

Package Structure

• volmdlr_tools package
  • Subpackages
    • volmdlr_tools.features package
    • volmdlr_tools.shapes package
    • volmdlr_tools.assembly package
    • volmdlr_tools.graph package
    • volmdlr_tools.distance package
    • volmdlr_tools.wires package
  • Module contents

Graph Module

Core graph infrastructure including base Graph class, AAG for face analysis, GraphAssembly for assemblies, and kinematics for joint analysis.

• volmdlr_tools.graph package
  • Subpackages
  • Submodules
  • volmdlr_tools.graph.assembly module
  • volmdlr_tools.graph.core module
  • volmdlr_tools.graph.faces module
  • Module contents
• volmdlr_tools.graph.utils package
  • Submodules
  • volmdlr_tools.graph.utils.angle_types module
  • volmdlr_tools.graph.utils.core module
  • volmdlr_tools.graph.utils.volmdlr_temp module
  • Module contents
• volmdlr_tools.graph.kinematics package
  • Submodules
  • volmdlr_tools.graph.kinematics.findjoint module
  • volmdlr_tools.graph.kinematics.torsor module
  • Module contents

Features Module

Feature extraction and classification including extractors for blends, cavities, sharp edges, and sheet metal features.

• volmdlr_tools.features package
  • Subpackages
  • Submodules
  • volmdlr_tools.features.core module
  • volmdlr_tools.features.constants module
  • volmdlr_tools.features.pattern_matcher module
  • volmdlr_tools.features.spring_pattern_matcher module
  • volmdlr_tools.features.edge_lines module
  • Module contents
• volmdlr_tools.features.extractors package
  • Submodules
  • volmdlr_tools.features.extractors.core module
  • volmdlr_tools.features.extractors.blend module
  • volmdlr_tools.features.extractors.cavity module
  • volmdlr_tools.features.extractors.sharp_edge module
  • volmdlr_tools.features.extractors.deformation module
  • volmdlr_tools.features.extractors.sheet_metal module
  • volmdlr_tools.features.extractors.feature_classifier module
  • Module contents
• volmdlr_tools.features.feature_types package
  • Subpackages
  • Submodules
  • volmdlr_tools.features.feature_types.core module
  • volmdlr_tools.features.feature_types.blends module
  • volmdlr_tools.features.feature_types.cavities module
  • volmdlr_tools.features.feature_types.sharp_edges module
  • Module contents
• volmdlr_tools.features.feature_types.sheet_metal package
  • Submodules
  • volmdlr_tools.features.feature_types.sheet_metal.bends module
  • volmdlr_tools.features.feature_types.sheet_metal.corners module
  • volmdlr_tools.features.feature_types.sheet_metal.jogs module
  • volmdlr_tools.features.feature_types.sheet_metal.notches module
  • volmdlr_tools.features.feature_types.sheet_metal.reliefs module
  • volmdlr_tools.features.feature_types.sheet_metal.lances module
  • volmdlr_tools.features.feature_types.sheet_metal.louvres module
  • volmdlr_tools.features.feature_types.sheet_metal.deformations module
  • volmdlr_tools.features.feature_types.sheet_metal.unknown module
  • Module contents
• volmdlr_tools.features.classification package
  • Submodules
  • volmdlr_tools.features.classification.registry module
  • volmdlr_tools.features.classification.matcher module
  • volmdlr_tools.features.classification.rules module
  • Module contents

Shapes Module

Shape recognition and abstraction classes for specialized part types.

• volmdlr_tools.shapes package
  • Subpackages
  • Submodules
  • volmdlr_tools.shapes.base module
  • volmdlr_tools.shapes.sheet_metal module
  • volmdlr_tools.shapes.bearing module
  • Module contents
• volmdlr_tools.shapes.recognizers package
  • Submodules
  • volmdlr_tools.shapes.recognizers.sheet_metal module
  • volmdlr_tools.shapes.recognizers.swept_shape module
  • Module contents
• volmdlr_tools.shapes.utils package
  • Submodules
  • volmdlr_tools.shapes.utils.signature module
  • Module contents

Assembly Module

Assembly-level utilities including finders for specific components.

• volmdlr_tools.assembly package
  • Subpackages
  • Module contents
• volmdlr_tools.assembly.finders package
  • Submodules
  • volmdlr_tools.assembly.finders.bearing module
  • Module contents

Utility Modules

Distance calculations and wire operations.

• volmdlr_tools.distance package
  • Submodules
  • volmdlr_tools.distance.clearance module
  • volmdlr_tools.distance.interference module
  • Module contents
• volmdlr_tools.wires package
  • Submodules
  • volmdlr_tools.wires.wires module
  • Module contents