/
SDK Documentation

SDK Documentation

Getting started

Download the SDK package from
Windows: https://www.graebert.com/areskudoserver_win_SDK
Linux: https://www.graebert.com/areskudoserver_linux_SDK
and extract it to your preferred location.

SDK content

Headers

  • inc - Kudo include files

  • commonui_inc - CommonUI include files

  • dd_inc - ODA include files

  • wt_inc - Wt include files required if using Xe widgets 

Libraries

  • lib - Kudo libraries

  • commonui_lib - CommonUI libraries

  • dd_lib - ODA libraries

  • wt_lib - Wt libraries required if using Xe widgets

If including Xe widgets in your module, you also need to include and link against Wt and boost. Use boost version 1.65 (can be downloaded here).

Samples

  • BlockAttributeWidget - Example dialog to edit block attributes

  • BlockPreviewWidget - Example dialog having a preview widget of drawing content

  • CloneFromBlock - Example command that clones entities from a block to current drawing

  • CommonUIDialog - Example dialog built with CommonUI that lists all block references having attributes in a dropdown and displays the attributes values according to dropdown selection

  • CrossOriginIntegration - Example how to send messages from server to client and client’s parent frame. Also shows how to extend an object’s RMB menu

  • CustomEntity - Example of custom entity implementation and show its property

  • DatabaseReactor - Example how to add a database reactor

  • DrawAECCommand - Example command that creates different AEC entities

  • DrawCirclesCommand - Example command to draw a circle

  • DrawingSummary - Example command to write a drawing summery to a csv file

  • EditorReactor - Example how to add an editor reactor

  • ExplodePolylinesReactor - Example that explodes newly added polylines to lines

  • ImportBlock - Example command that imports a block from another drawing

  • InsertImageCommand - Example command to insert an image into a drawing

  • LineStyles - Example how to load linestyles

  • ObjectReactors - Example how to add object reactors

  • TrimCommand - Example command that trims all entities intersecting a picked cutting edge removing parts according to picked direction

  • BlockCollection - Example command will display various drawings available in storage, which can be attached as block in current drawing

Brief explanation

BlockCollection will display the dwg’s in preview widget which can be attached to current drawing. It can be attached by simply Drag&Drop on insert button.

Drawings are categorized in various folders, upon changing the category, all the .dwg’s in that folder will be loaded. Files will be available on cloud storage, its URL can be changed in Kudo server.

There is additional file bundle.min.js in BlockCollection project folder. Its a JavaScript file containing functionalities for block operations, it will be loaded at web browser.

It needs to put in Kudo server path for example:

  • C:\Program Files\Graebert GmbH\ARES Kudo Server\Kudo\Resources\docroot\www-editor\<id>\js [Windows]

  • /opt/graebert-gmbh/Xenon-Editor/Resources/docroot/<id>/js [Linux]

 

 See https://graebert.atlassian.net/wiki/spaces/KUDOPARTNER/pages/1180434585or https://graebert.atlassian.net/wiki/spaces/KUDOPARTNER/pages/1180434595

how to compile the samples on your platform and

https://graebert.atlassian.net/wiki/spaces/KUDOPARTNER/pages/1834450981 how to load them.

 

Related content

ARES Kudo Developer Studio Onboarding
ARES Kudo Developer Studio Onboarding
Read with this
Kudo Editor iframe → Partner Web Application
Kudo Editor iframe → Partner Web Application
Read with this
BlockAttributeWidget
More like this
Linux: Compiling Samples
Linux: Compiling Samples
Read with this