Tekla Open API

Detailed and full API reference helps you master Tekla Open API

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

Tekla.Structures.Model.UI Namespace

The Tekla.Structures.Model.UI namespace consists of some classes that can be used, for example, to highlight objects from the user interface.
Classes
  Class Description
Public classCode example ClipPlane
The ClipPlane class defines a clip plane which can be used together with a visible view.
Public class ClipPlaneCollection
The ClipPlaneCollection class handles the collection of the clip planes.
Public classCode example Color
The Color class represents an RGB color with transparency. The color values must be between 0.0 and 1.0.
Public class GraphicPolyLine
Public classCode example GraphicsDrawer
The GraphicsDrawer class draws temporary graphics in the currently active rendered view in Tekla Structures.
Public classCode example Mesh
The Mesh class represents a mesh for drawing three-dimensional data.
Public classCode example ModelObjectSelector
The ModelObjectSelector class can be used to select objects from the Tekla Structures user interface. Currently, these selections both select the objects from the database and highlight them visually.
Public classCode example ModelObjectVisualization
The class to set and clear temporary visualization (color and transparency) for model objects in view. Permananet representation will be restored when view is redrawed or temporary visualization is cleared. Can be used also to fetch current permanent representation of model object.
Public class ModelViewEnumerator
The ModelViewEnumerator class is an enumerator class for model views. The enumerator enables model view items to be looped.
Public classCode example Picker
The Picker class can be used to query the user to do manual picks of objects and points from the Tekla Structures model. The methods throw an exception if the user interrupts (cancels) the pick command.
Public classCode example PickInput
The PickInput class handles the input of picked objects and positions.
Public classCode example View
The View class contains methods related to views.
Public classCode example ViewCamera
The ViewCamera class defines a camera which can be used together with a visible view. Always supply a properly orthogonalized camera up vector when rotating the camera.
Public classCode example ViewHandler
The ViewHandler class contains methods for handling views.
Public class ViewVisibilitySettings
The View visibility settings class contains object visibility information related to view.
Enumerations
  Enumeration Description
Public enumeration GraphicPolyLineLineType
The appearance of the line. For instance solid, dashed or dotted.
Public enumeration PickerPickObjectEnum
The possible model object pick types for a single object.
Public enumeration PickerPickObjectsEnum
The possible model object pick types for many objects.
Public enumeration PickerPickPointEnum
The possible point pick types.
Public enumeration TemporaryTransparency
The possible temporary transparencies. Used to temporarily change transparency of a model object to visualize some state in the model.
Public enumeration ViewDisplayOrientationType
The view plane types. The plane type can be changed.
Public enumeration ViewViewProjectionType
The view projection types. The projection type can be read but not changed.
Public enumeration ViewViewRenderingType
The view rendering types. Only rendered views can be modified.