Tekla OpenAPI: Drawing tools and plug This track will focus on the ...

<strong>Tekla</strong> <strong>OpenAPI</strong>: : <strong>Drawing</strong> <strong>tools</strong> <strong>and</strong> <strong>plug</strong> ins 

<strong>This</strong> <strong>track</strong> <strong>will</strong> <strong>focus</strong> on the different uses of the <strong>Drawing</strong> API. 

First there <strong>will</strong> be a discussion of what drawing <strong>plug</strong> <strong>plug</strong>#ins are 

<strong>and</strong> how they work. Next, this session <strong>will</strong> discuss several 

new features available in the API <strong>and</strong> the benefits it brings to 

the end user. Lastly, it <strong>will</strong> look at several real world examples 

of drawing <strong>plug</strong>#in in implementations. 

2012 User Meeting / Charles Pool 1

Follow us on 

@<strong>Tekla</strong> / #UM12 

2012 User Meeting / Charles Pool 

2

Safe Harbor Statement <strong>and</strong> Disclaimer 

The information presented regarding future product features 

<strong>and</strong> functionalities is for informational purposes only <strong>and</strong> 

should not be relied upon in making a purchasing decision. 

<strong>Tekla</strong> is under no obligation to deliver any future products, 

features, or functions within any specified time frame, if at 

all. Release dates <strong>and</strong> content are subject to change at 

<strong>Tekla</strong>’s sole discretion. 


3

Presenter: Charles Pool 

25% Work for <strong>Tekla</strong> Finl<strong>and</strong> 

75% Work for <strong>Tekla</strong> USA 

• Bachelors in Architectural Engineering 

• Solutions Engineer (6 years at <strong>Tekla</strong>) 

• Used <strong>Tekla</strong> Structures (2 years before) 

Projects 

• People Tracker • Debug Tools 

• Component Manger 

• Pipe NC Data 

• Beam Marks 

• Bolt Dimension Tool 

• Dimension Section Rebar 

• <strong>Drawing</strong> Block 

• Cover Dimensions 

• Debug Tools 

• Compare Objects 

• Break Lines 

• Match Lines 

• <strong>Drawing</strong> Cloning Study 

• Model Checker 

• Offshore Suite 

• <strong>Drawing</strong> Roadmap <strong>and</strong> Vision assist assist2012 User Meeting / Charles Pool 

4

User Meeting 2012 

API Sessions # <strong>Drawing</strong>s

Agenda 

What is <strong>Drawing</strong> API, Why do we care? 

What are some key things I need to underst<strong>and</strong> about 

<strong>Tekla</strong> drawings to use this toolkit? 

Getting Started, where to go 

Different applications of the API 

Examples of <strong>tools</strong> already created 

Feature Highlights 

<strong>Drawing</strong> <strong>plug</strong>ins in depth 


Why do we care? 

We are here to study <strong>tools</strong> that can help us be: 

More productive 

Exp<strong>and</strong> our knowledge can capabilities 

Do things we could not easily or at all do before 

Customize appearance 

Ultimately save money 


7

What is the <strong>Drawing</strong> API 

Introduction 


What is the <strong>Tekla</strong> Open API? 

API = Application Programming Interface. 

Customization of <strong>Tekla</strong> Structures without having to 

change the core. 

Utilizing Industry st<strong>and</strong>ard Microsoft .NET technology. 

Creates a competitive advantage at lower cost. 


9

<strong>Drawing</strong> API 

Toolkit you need to connect to <strong>Tekla</strong> drawings 

– Extend existing functionality 

– Automate tasks 

– Create new functionality 

– Create new drawing type objects 

– Personalize the presentation of model graphics 

Benefits 

– Automate tedious <strong>and</strong> unpleasant tasks 

– Change the look <strong>and</strong> control over parts <strong>and</strong> annotations 

– Ultimately save considerable time <strong>and</strong> money 


Common Use Cases 


– Access the drawing list. 

– Create, modify <strong>and</strong> delete. 

– GA drawings <strong>and</strong> views in any drawing. 

– Dimensions, text <strong>and</strong> other basic objects. 

– Interact with the user. 

– Get currently selected drawing objects. 

– Prompt user to pick objects <strong>and</strong> locations. 

– Select <strong>and</strong> highlight objects for the user. 

– Access model objects from the drawing. 

– Select the parts found in a drawing in the model. 


11

Getting Started 

Underst<strong>and</strong>ing the different types of 

applications using the <strong>Drawing</strong> API 


How do I Get Started 

Learn some C# (book example?) 

Download Microsoft Visual Studio C# Express (free) 

Download “Getting started material from extranet” 

Start reading documents, getting familiar with content 

Review examples <strong>and</strong> compile them yourself 

Start experimenting on your own going through 

<strong>Tekla</strong>.Structures.Model <strong>and</strong> <strong>Tekla</strong>.Structures.<strong>Drawing</strong> 

namespaces. 

Start small at first. 


What do you need? 

<strong>Tekla</strong> Structures 

Windows XP, Vista, or 7 

.NET Framework 4.0 

Visual Studio 2010 Express (Free) 

Pick a Language (Suggest C#) 

Tutorial Material 

– Videos, Youtube 

– Books 

Download Startup Package from 

extranet. 

– Product>Open API 


14

Where is the API? 

Included inside your <strong>Tekla</strong> Structures Installation 

Tools>Macros 

XS_MACRO_DIRECTORY 

C:\ProgramData\<strong>Tekla</strong> 

Structures\18.0\environments 

\usimp\us_common\macros\ 

modeling or 

drawings 

C:\Program Program Files Files\<strong>Tekla</strong> Structures\ 

18.0\nt\bin\<strong>plug</strong>ins 

• <strong>Tekla</strong>.Structures.dll 

• <strong>Tekla</strong>.Structures.Model.dll 

• <strong>Tekla</strong>.Structures.<strong>Drawing</strong>.dll 

• <strong>Tekla</strong>.Structures.Dialog 

• <strong>Tekla</strong>.Structures.Datatype 

• <strong>Tekla</strong>.Structures.Plugins 

• <strong>Tekla</strong>.Structures.Catalogs 

• <strong>Tekla</strong>.Structures.Analysis 


15

Where to go to get Help 

<strong>Tekla</strong> Extranet Discussion Forums is the primary channel 


16

<strong>Tekla</strong> Extensions 

Download, Rate, <strong>and</strong> Comment on the <strong>Tekla</strong> Extranet 


17

Implementation Categories 

Create, Modify, Delete, 

Extract Information, 

Set User Attributes, 

Navigate, Call Macros. 

(*.cs) 

Recorded scripts calling comm<strong>and</strong>s in the 

<strong>Tekla</strong> Structures interface for Model <strong>and</strong> 

<strong>Drawing</strong>s. (C#, API Library can be used here) 

(*.exe) 

Tools that connect <strong>and</strong> interact with <strong>Tekla</strong> Structures 

(*.dll) 

Parametric, run inside <strong>Tekla</strong> Structures, fast. 


18

<strong>Drawing</strong> Macros 


19

Macros : What are they 

Scripts recorded from <strong>Tekla</strong> directly, can automate some 

things easily 

Can run directly un#compiled compiled c# code 

Independent of versions 

Easy to create 

Low maintenance 

Not good for User Interfaces, but great for smaller <strong>tools</strong> 

that do not need dialogs 

Freeze <strong>Tekla</strong> Structures until finished running 

Sample template you can now download under UM 2012 


Recorded Script 


Easy Template 

Console application – project template 

Single class with all logic in one file 

Script Class 

– Run method – Calls logic class when running inside <strong>Tekla</strong>, can 

then utilize akit calls directly 

– Main method – Calls logic class when running through debugger 

or as an executable console application 

Main logic class 

– Constructor – Class where you add your code to run 

To Run, Copy *.cs file to macros/drawings folder, then re re# 

launch Macro dialog, click on macro in list <strong>and</strong> then press 

“Run” 


22

Template code 


23

Sample Code In Macro – Reopen drawing 


Examples of Macros 

Remove Change Clouds* 

Re#Open Open drawing, forces templates to update* 

Start Point#Checker, Checker, Creates symbols at the physical 

start end of a model beam into the drawing* 

Top in Form Symbol # Creates symbols on the face that is 

set to the ‘up in form’ side of the column or other type 

concrete part 

Simple, modular dimensioning <strong>tools</strong> 

– Dimension str<strong>and</strong> or rebar 

– Dimension bolt group 


Bolt Dimension Tool 


26

<strong>Drawing</strong> Applications 


27

<strong>Drawing</strong> Applications : What are they 

Executable programs that run outside <strong>Tekla</strong> 

Structures <strong>and</strong> communicate back <strong>and</strong> forthbetween 

the model <strong>and</strong> drawings. 

Slower than <strong>plug</strong>ins, run asynchronously with <strong>Tekla</strong> 

Ideal for larger <strong>and</strong> more complex applications that 

need real user interfaces 

Unlimited in use cases <strong>and</strong> possibilities 

Can call ‘helper’ <strong>plug</strong>ins to extract data from the 

drawing or do smaller tasks 


Anchor Rod Tools 

Connection Code 


29

Beam Mark 


30

Detail <strong>Drawing</strong> Manager 

Originated from the 

request for st<strong>and</strong>ard 

details need. 

Similar to blocks, but 

this tool adds real 

native <strong>Tekla</strong> lines, 

hatching, <strong>and</strong> other 

2d objects on top of 

model graphics 

Intelligence to model 

objects is retained 


31

<strong>Drawing</strong> Plugins 


32

<strong>Drawing</strong> Plugins : What are they 

Run inside <strong>Tekla</strong> Structures drawing environment 

Fast 

Connected to their input always 

Get re#run run or updated automatically when changes 

occur, several scenarios for update available 

Easy way to implement your own custom drawing 

entities (E.g. Custom mark, custom dimension) 


Dimensioning Tool 

New to 18.0 as Extension 

Hybrid system 

– Plugin on <strong>Drawing</strong> for updating 

– Application that does work 

Powerful result, highly 

customizable 


34

Cover Dimensions 

Creates dimension from 

outer edge of concrete to 

edge of reinforcement 

Dimension points are 

managed by <strong>plug</strong>in <strong>and</strong> 

update always based on 

part changing in model 


35

<strong>Drawing</strong> Match Line 

Creates thick, custom 

polyline that is very 

easy to see on 

drawings 

Illustrates where 

drawings get isolated 

Multiple lines offset 

together, but grouped 

with its own user 

interface 


36

Advanced Grid Labels 

Replace the 

graphics for normal 

grid labels 

Allows for some 

fixed type symbols 

with font <strong>and</strong> colors 

customizable 


37


Key Concepts 


<strong>Drawing</strong> Architecture (Typical GA <strong>Drawing</strong>) 

Y 

Y 

X 

X 

Y 

Y 

X 

X 


39

<strong>Drawing</strong> objects 

<strong>Drawing</strong> objects are not the same as model objects 

Presentation object that represents the model object in 

the drawing interface. E.g. Color, accuracy, symbol 

Can be many different types of objects including text, 

lines, marks 

Can get model object identifier for the model part that the 

drawing part represents 

You can not change the Model object when a drawing is 

open, , but you can get information from it 


40

Model API versus the <strong>Drawing</strong>s 

<strong>Drawing</strong>s are just presentations of the model objects 

<strong>Drawing</strong> part settings 

Model object 


Dimension Architecture 

Dimension 

Points 


42

Dimension Direction Vectors 

Sets the up position relative to the direction that is to be 

dimensioned, always *90 from dimension line 

– Horizontal, Vertical, Skew dimension 

– Sets the direction to where dimension is placed 

– Left, Right, Up, Down from object it is dimensioning 

– Set using a Vector (x value, y value, z value) 

– Relative to DisplayCoordinateSystem 


43

Transforming Points to View Local 


44

Show from coordinate system to local 

Global System 

Origin 

– (640540.24,554707.56, 

5687.32) 

Local System 

Origin 

– (0,0,0) 


45

Feature Highlight 

Some common features of drawing API 

highlighted 


<strong>Drawing</strong> H<strong>and</strong>ler 

new <strong>Drawing</strong>H<strong>and</strong>ler(); 

Check if a drawing is currently open 

– GetActive<strong>Drawing</strong>() check if null or <strong>Drawing</strong> 

Gets Picker for getting input from user 

Closes, Saves, <strong>and</strong> Opens drawings 

– Can open drawing hidden in background 

– SetActive<strong>Drawing</strong>(my<strong>Drawing</strong>, false); 

Get drawings from drawing list 


47

Example: Getting <strong>Drawing</strong> Views 

Two Methods for Getting Views 


48

<strong>Drawing</strong>.UI Picker 

How to get a drawing object from the user 


49

Example: Open a drawing in background 

It is possible to open drawing hidden to user in order to 

add views or change objects in the views if needed. 


50

Example: Check if a drawing is open 


51

Example: Get certain drawing 

The <strong>Drawing</strong>H<strong>and</strong>ler is also useful for getting drawings 


52

Get model object from drawing object 

<strong>Drawing</strong> Parts have a method to get the model object 

identifier 


53

StraightDimensionSetH<strong>and</strong>ler 

new StraightDimensionSetH<strong>and</strong>ler(); 

Easiest way to create dimension ‘set’ 

Set is multiple dimensions grouped together 

CreateDimensionSet(View, Points, Direction, Offset); 


54

Example: Create dimension to bolts 


55

Inserting Text into <strong>Drawing</strong> 


Inserting Symbols into <strong>Drawing</strong> 


Create new Blank GA drawing 


Marks 

Generic mark base 

3 Types of placement 

Associative Note UI shown to user 

Getting existing marks 

Getting drawing part from mark 


Insert Mark into <strong>Drawing</strong> 


60


Deeper look at <strong>Drawing</strong> Plugins 

(sample available on extranet) 


How a Plugin is Structured 

New Plug#in/connection in/connection started 

– Constructor method runs 

– Input prompted from user 

– Applied values taken from dialog 

– Plug#in in Run() when input complete 

– Both the StructuresData <strong>and</strong> the Input are 

stored to the model database 

User 

Input 

Plug Plug#in 

StructuresData 

Input 

UI (Dialog) 



Basic requirements of PluginBase 


– Defines the data that can be passed from the UI 

Attributes 

– Define the name <strong>and</strong> UI 

Constructor 

– Initializes the Plug#in 

– Takes the currently applied StructuresData 

DefineInput() 

– Defines the input the Plug#in in requires 

Run() 

– Executes after input has been received 


Main Class : Declarations 


64

When <strong>plug</strong>in updates 

Several different options, based on user setup 


65

Main Class 


66

Main Class : Override DefineInput 


67

Main Class : Override Run 


68

User Interface Data Storage Class 


69

User Interface data is stored in model database 

Fetched automatically when run 


70

Main Logic Class 


71

Wrap Up 

What is <strong>Drawing</strong> API, Why do we care? 

What are some key things I need to underst<strong>and</strong> about 

<strong>Tekla</strong> drawings to use this toolkit? 

Getting Started, where to go 

Different applications of the API 

Examples of <strong>tools</strong> already created 

Feature Highlights 

<strong>Drawing</strong> <strong>plug</strong>ins in depth 


Questions <strong>and</strong> Discussion 

User Meeting 2012 / Charles Pool 

73

For further questions, please contact US Solutions Team: 

solutions.us@tekla.com 

Thank You 


74

Tekla OpenAPI: Drawing tools and plug This track will focus on the ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?