NXKnowledge

NXOpen Java API Reference > Overview

NXOpen Java API Reference — Package Overview

This is the Javadoc-style API reference for NXOpen when used from Java. It is a pure alphabetical package/class/method reference (no conceptual guide content) — for concepts and getting-started material, see nxopen-prog-guide\ instead.

Navigation quirk (for future scraping sessions)

This book does not use the normal iframe#xhtml + accordion pattern used by narrative guides. It's a real Javadoc frameset. The content lives in the first <iframe> on the page, which has no id/name attribute: document.querySelectorAll('iframe')[0].contentDocument. Navigate by reading that iframe's own <a> elements and clicking them (via JS .click() or computer clicks) — do not try to fetch the underlying docs.sw.siemens.com/documentation/external/.../nxopen/<pkg>/<Class>.html URLs directly; they return AccessDenied without first loading the wrapper page (which sets a signing cookie).

Top-level packages

All packages are rooted at nxopen (or nxopen.<subarea> for sub-packages). One-line purpose per Javadoc summary, condensed:

  • nxopen — Common/base API: session, parts, objects, features, points, foundational types used everywhere else.
  • nxopen.aecdesign — AEC (Architecture/Engineering/Construction) Design.
  • nxopen.alp — Assembly Line Planner.
  • nxopen.ame, nxopen.ame.db — AME (Advanced Manufacturing Engineering) and its DB layer.
  • nxopen.animationdesigner, nxopen.animationdesigner.nav — Animation Designer and its navigation subsystem.
  • nxopen.annotations — Dimensions, Notes, Symbols, PMI, and other annotations.
  • nxopen.appearance — Appearance/material rendering management.
  • nxopen.assemblies, nxopen.assemblies.productinterface — Assemblies; assembly product interfaces.
  • nxopen.automat... (name truncated in scrape — automation-related package; re-check)
  • nxopen.clouddm — (no summary shown) Cloud Data Management.
  • nxopen.collaborationapplication — Collaboration Application.
  • nxopen.composites, nxopen.composites.features — Composites design (no summary shown for either).
  • nxopen.contactlessinspection — Contactless Inspection.
  • nxopen.designsimulation — Design Simulations.
  • nxopen.diagramming, nxopen.diagramming.geometry, nxopen.diagramming.tables — Diagramming, its geometric shapes, and tables.
  • nxopen.diagramminglibraryauthor — Diagramming Library Authoring.
  • nxopen.die — Die Engineering / Die Design.
  • nxopen.display — Display control.
  • nxopen.dmu — Digital Mock-Up (DMU).
  • nxopen.drafting — Drafting.
  • nxopen.drawings — Drafting Drawings.
  • nxopen.dse, nxopen.dsedesignworkflow, nxopen.dseplatform — DesignSpaceExplorer core, its design workflow, and platform layer.
  • nxopen.elec... (package name cut off in scrape between "elec" and "features" section — likely electrical/routing-adjacent; re-check on next pass)
  • nxopen.features.(subpackages incl. shipdesign general arrangement, structuredesign, subdivision, topologyoptimization, vehicledesign)* — Modeling feature APIs split by design domain:
    • nxopen.features.generalarrangement — Ship Design General Arrangement.
    • nxopen.features.structuredesign — Structure Design features.
    • nxopen.features.subdivision — Subdivision Body feature.
    • nxopen.features.topologyoptimization — Topology Optimization for Designers.
    • nxopen.features.vehicledesign — Vehicle Design.
  • nxopen.fields — Fields (parametric expressions-like objects).
  • nxopen.formboard — Routing Electrical Formboard functionality.
  • nxopen.gateway — Gateway.
  • nxopen.geometricanalysis, nxopen.geometricanalysis.sectionanalysis — Geometric Analysis and section analysis.
  • nxopen.geometricutilities, nxopen.geometricutilities.uvmapping — Geometric utilities; UV mapping/editing utilities.
  • nxopen.implicit — Implicit Modeling.
  • nxopen.issue — Issue Management.
  • nxopen.join — Join (assembly join feature).
  • nxopen.layer — Layers.
  • nxopen.layout2d — Layout2D.
  • nxopen.linedesigner — Line Designer.
  • nxopen.markup — Markup.
  • nxopen.mechanicalrouting — (no summary shown) Mechanical Routing.
  • nxopen.mechatronics — Mechatronics.
  • nxopen.mendixreporting — (no summary shown) Mendix-based reporting.
  • nxopen.menubar — Menu Bar customization.
  • nxopen.mfg, nxopen.mfg.am, nxopen.mfg.mlp — Manufacturing; Additive Manufacturing (AM); Machining Line Planner.
  • nxopen.mfgmodel — Manufacturing Model.
  • nxopen.mfgviewmaker — MFG View Maker.
  • nxopen.modldirect — Direct Modeling.
  • nxopen.modlutils — Modeling utilities.
  • nxopen.moldcooling — Mold Cooling.
  • nxopen.motion — Motion Simulation.
  • nxopen.openxml — OpenXml (Office document interop).
  • nxopen.optimization — Optimization.
  • nxopen.options — Options.
  • nxopen.partfamily — Part Family.
  • nxopen.partmfg — Part Manufacturing applications.
  • nxopen.pcbexchange — PCB Exchange.
  • nxopen.pdm, nxopen.pdm.savemanagement — PDM; Save Management.
  • nxopen.physmat — Physical Material.
  • nxopen.pid — PID (Piping & Instrumentation Diagram).
  • nxopen.placement — Placement (assembly component placement).
  • nxopen.plas — PLAS.
  • nxopen.plasticdesigner — (no summary shown) Plastic Designer.
  • nxopen.positioning — Assembly positioning/constraints.
  • nxopen.regionrecognition — Region Recognition.
  • nxopen.report — Report.
  • nxopen.routing, nxopen.routing.electrical, nxopen.routingcommon — Routing (mechanical); Routing Electrical; shared routing utilities.
  • nxopen.schematic, nxopen.schematic.mechanical, nxopen.schematic.model — Schematic design and its mechanical/model subpackages (no summaries shown).
  • nxopen.select — Selection.
  • nxopen.shapesearch — Shape Search.
  • nxopen.sheetmetal — Sheet Metal.
  • nxopen.shipdesign — Ship Design.
  • nxopen.sim, nxopen.sim.postconfigurator — Machine Tool Builder / CAM-Simulation; Post Configurator.
  • nxopen.stagemodel, nxopen.stagemodeltemplate — Stage Model; Stage Model Template.
  • nxopen.structuredesign — Structure Design (top-level, distinct from features.structuredesign).
  • nxopen.tdp — Technical Data Package (TDP).
  • nxopen.tooldesigner — ToolDesigner.
  • nxopen.tooling — Tooling.
  • nxopen.uf — Direct wrapper access to the legacy UF (User Function) API.
  • nxopen.uistyler — User Interface Styler (Block UI Styler runtime classes).
  • nxopen.userdefinedobjects — User Defined Objects (UDOs).
  • nxopen.userdefinedtemplate — User Defined Template.
  • nxopen.utilities — General utilities.
  • nxopen.validate — Validation Utilities.
  • nxopen.visualreporting — Visual Reporting.
  • nxopen.vsa — VSA (Variation Simulation Analysis, tolerance/robustness).
  • nxopen.weld — Weld.

Notes on scope/omissions

  • Package descriptions above are condensed from the one-line Javadoc summary shown in the package-overview table; several packages have no summary text in the vendor table at all (noted "no summary shown").
  • Two package names were cut off mid-scrape (nxopen.automat... near the start of the alphabet, and one package beginning nxopen.elec... between dseplatform and the features.* group) — likely nxopen.automation/similar and an electrical-routing-related package (e.g. nxopen.electrical or nxopen.electricalrouting). Re-verify by reopening the Java reference Overview page and reading that exact byte range if a complete package name list is needed.
  • This index intentionally does not enumerate classes within each package — see per-package files (where created) for class lists, or click Packages → package name in the live doc to browse.

Source: https://docs.sw.siemens.com/en-US/doc/209349590/PL20220512394070742.open_java_ref · retrieved Tue Jul 07 2026 00:00:00 GMT+0000 (Coordinated Universal Time)