Smart 3D .

Net API

Overview of Smart 3D .Net API

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 1

Topics

• Smart 3D .Net API Architecture.

• What Automation can you develop.
• API available for your use
(to write Commands, Standalone Executables and Customization)
• Client Tier Services/Components
• Middle Tier Services/Components
• Commands – Modal, Non-Modal, Graphic, Step
• Metadata – Classes, BOCs, Interfaces, Properties, Codelists …
• Get/Set Properties, Access Relationships
• Writing Standalone Applications
• Application functionality
– Common, Systems, Catalog, Eqp, Route, Space and an overall sample.
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 2
 What is Smart 3D .Net API

• API
Application Programming Interface

is a set of routines, data structures, object classes and/or protocols
provided by libraries and/or operating system services in order to
support the building of applications.

• See http://en.wikipedia.org/wiki/API

• Smart 3D .Net API
API of Smart 3D applications.

(SmartPlant 3D & SmartMarine 3D)

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 3

Smart 3D .Net API Architecture

• Leverages .Net methodologies, and provides .Net based Automation

capability.
Useful components delivered to you as .Net Assemblies.
• You can program in VB.Net or C# or any .Net language.
• Use Visual Studio
– VS2008SP1 with .NET Framework v3.5(prior to Smart 3D v2014),
– VS2010 with .NET Framework v4.0 (from Smart 3D v2014).
– VS2013/V2015 with .NET Framework v4.5 (from Smart 3D v2016).
• Delivered assemblies categorized as Middle, Client Tiers.
• Offers facilities to deal with both User Interface development for
functionality within Smart 3D® and Business Logic, to
create/access/modify /delete objects & their data in Smart 3D.
• Lets you write “interactive automation” – within Smart3D
environment, and, “non-interactive automation” – in custom
executables outside of Smart3D graphics environment.

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 4
 Smart 3D .Net API Architecture

Client Tier (Within Smart 3D Environment)

Smart 3D native .Net based Automation

Smart 3D .Net API
(COM) Custom Commands
Client Tier Infrastructure
Client Tier (Interactive –
(Services/Components)
Services/Components Within TaskHost)

.Net based Customization

User Defined Forms

Middle Tier
.Net based Automation
Smart 3D .Net API
Standalone Applications
Middle Tier Infrastructure
(Non-Interactive –
(Services/Components)
Outside Taskhost)

.Net based Customization

Symbols NameRules
Smart 3D native
(COM) IFC Rules
Middle Tier
Services/Components

Legend Intergraph Delivered .Net API Assemblies User Customized .Net Assemblies

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 5

Smart3D .Net API delivered Assemblies

All of the Smart 3D .Net API is delivered in assemblies in

$Smart3D\Core\Container\Bin\Assemblies\Release\

Client Tier (Within Smart3D

Environment)
CommonClient.DLL
Smart 3D .Net API
SP3DFrmDefHelper.dll
Client Tier Infrastructure
CustomFormDefinitionControls.dll
(Services/Components)

Middle Tier
CommonMiddle.DLL
SystemsMiddle.DLL
RefDataMiddle.DLL
CommonRouteMiddle.DLL
Smart 3D .Net API GridsMiddle.DLL
Middle Tier Infrastructure SpaceMiddle.DLL
(Services/Components) SupportMiddle.DLL
SmartPlantStructureMiddle.DLL
…
…
NameRuleWrapperForNet.DLL

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 6
 Smart 3D .Net API Highlights

• API available for use

– Within TaskHost
Custom Commands
– In customization
NameRule / Symbols / IFC Rule / …
– In an external stand-alone application
• Fully documented with API Help integrated into Visual Studio
Environment. F1 help works and shows context sensitive help.
• Examples provided for each aspect of the API.
• API for creating / modifying Smart 3D objects, get/set
properties, navigating relationships, access metadata.
• Utilize User Interface specific services –
Graphics/Mouse/Keyboard/Selection/Visual Identification etc.
• Utilize Middle tier specific services/Functionality – Transaction
control, Filters…
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 7

Smart 3D .Net API Highlights …

• Data integrity maintained with API usage to

Create/Modify/Delete objects

Whether Smart3D .Net API is used in Smart3D’s graphic

environment (S3DHost.exe) or a Standalone Executable,
the Semantic and Revision Management machinery is always
“running behind scenes”,
percolating the changes to the required related objects,
performing intuitive and implied updates to objects and related objects,
thus keeping the objects and data always in a valid state.

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 8
 Smart 3D .Net API – Automation Facilities at a Glance
Object Catalog Ability to
Selection Parts, Specs • Create Objects
Math / Graphic
• Modify Objects
Geometry / Views • Delete Objects
Transforms .Net Mouse • Find/Filter Objects
Keyboard • Traverse Relations
Transaction
Control Automation Filters Application

Fence,
Facilities Metadata
Functionality
• Common
Locators, • Systems & Specs
Hiliters VB.Net Properties • Catalog
Relations • Equipment
StatusBar C# Database • Piping, Electrical,
HVAC
Access
Commands • Grids
Preferences
• Space
Undo, Error Forms & UI ValueMgr Rule-Based • Structure
Handling, Smart Menus, Associative • Hangers
TODO List Sketch Toolbars Behaviour • …

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 9

Business Objects / Services

Smart 3D .Net API based

User Developed
Automation/Customization Smart 3D .Net API based Logic
ONLY uses
.Net Framework Smart 3D .Net API
Classes / Services Business Objects/Services
&
External / In-house .Net Framework objects
Applications /
Never needs to use COM
Automation Business Objects / Services

Client / Middle Tier

Smart 3D Smart 3D
Pipeline UnitSystem Nozzle …
.Net API .Net API
PipeRun PipeSpec Support Space …
Business Objects Services

Equipment Filter PartClass …

Smart 3D
Slab Part RouteFeature … Smart 3D COM
COM
Business Objects
Services

Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Overview Of Smart 3D .Net API - 10