SOLIDOS API

SOLIDOS has an API for Dynamo and Visual Lisp, which allows the creation of objects, as well as the manipulation of properties

To use the API in Dynamo, you need to load it in the Dynamo editor. Access the Dynamo/Preferences menu:

In the screen that opens, click the Add Path button:

And locate the folder with the correct package for your version of Civil 3D:

In the example I am using Civil 3D 2025, so I choose the SOLIDOS.bundle/Dynamo/2025/ folder.

When you close these two screens and return to the Dynamo area, the following will be displayed in Add ons:

Note: Use the SOLIDOSABOUT command to locate where you installed SOLIDOS. The plugin is normally installed in:

To better understand and use the SOLIDOS API functions, always consult the help documentation. Each class has a set of properties. They are described as follows:

• Category
  • Friendly Name (Name, Type) - Property description

Note that to access any given property, you must use the property's Name (Id, Name, Description...) as a string. The property type is also specified.

• In Visual Basic, it looks like this:
  Dim valor As Tipo = SolidosGetNodeParam(handle, "Name", Nothing)
• In Visual Lisp:
  (setq valor (SolidosGetNodeParam handle "Name" nil))
• In Dynamo:
  valor = SolidosAPI.SolidosGetNodeParam(handle, "Name", null);

The API is divided into the following functions:

• SolidosFindObjectByName - Searches for a SOLIDOS object by its name
• SolidosGetRootNode - Returns a root node identifier
• SolidosConnectNodes - Connects a basin/device/sector to another basin/device/sector
• SolidosDisConnectNodes - Disconnects a basin/device/sector from another basin/device/sector
• SolidosCreateNode - Creates a SOLIDOS item
• SolidosGetChildNames - Returns the list of names of the child items of the specified item
• SolidosGetNodeParam - Returns the value of a property of a SOLIDOS object
• SolidosGetPropertyType - Returns the type of a property of a SOLIDOS object
• SolidosSetNodeParams - Sets the values ??of the properties of a SOLIDOS item
• SolidosFindShortestPath - Returns the shortest route between two devices
• SolidosCommit - Forces the reconstruction of devices and calculations that would only be done at the end of the command/script
• SolidosGetPointAt - Returns a point in a specific parameter of a linear or longitudinal device
• SolidosGetParameterAtPoint - Returns the parameter of a point projected on the 3D axis of a linear or longitudinal device
• SolidosListProperties - Lists the properties of an object or object type in SOLIDOS
• SolidosGetPropertyInfo - Returns a dictionary with information about a property of an object or object type

Tip: Load the plugin (<SOLIDOS installation folder>/Visual Lisp/SLIST.LSP) and use it as the AutoCAD LIST command to inspect information about the properties of the selected SOLIDOS item, such as:

• Category - The category name of the property
• DisplayName - The friendly name of the property
• Description - The description of the property
• PropertyType - The type of the property
• ReadOnly - Indicates whether the property is editable or no
• IsEnum - Indicates whether the property is an enumerator type
• Values ??- The possible values ??for the property when IsEnum is true