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.

ClipPlane Class

The ClipPlane class defines a clip plane which can be used together with a visible view.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.Model.UIClipPlane

Namespace:  Tekla.Structures.Model.UI
Assembly:  Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2018.1.0.0 (2018.1.0.0)
Syntax
[SerializableAttribute]
public class ClipPlane

The ClipPlane type exposes the following members.

Constructors
  Name Description
Public method ClipPlane
Instantiates a new view camera instance with zero length vectors.
Top
Properties
  Name Description
Public property Location
The clip plane location in global coordinates (XYZ).
Public property UpVector
The clip plane up vector in global coordinates (XYZ).
Public property View
The view the clip plane belongs to.
Top
Methods
  Name Description
Public method Delete
Deletes the clip plane from the application view. The application view must be visible.
Public method Insert
Creates a new clip plane to the application view. The application view must be visible.
Public method Modify
Modifies the clip plane position in the application view. The application view must be visible.
Top
Examples
The following example shows how three ClipPlanes are created to the first visible view:
using System;
using Tekla.Structures.Model.UI;
using Tekla.Structures.Geometry3d;

public class ClipPlaneExample
{
    public void ClipPlaneExample1()
    {
        ModelViewEnumerator ViewEnum = ViewHandler.GetVisibleViews();
        ViewEnum.MoveNext();
        View ActiveView = ViewEnum.Current;
        ClipPlane CPlane = new ClipPlane();
        CPlane.View = ActiveView;
        CPlane.UpVector = new Vector(1, 0, 0);
        CPlane.Location = new Point(20000, 10000, 5000);
        CPlane.Insert();

        CPlane.UpVector = new Vector(0, 1, 0);
        CPlane.Location = new Point(10000, 20000, 2000);
        CPlane.Insert();

        CPlane.UpVector = new Vector(0, 0, 1);
        CPlane.Location = new Point(20000, 20000, 6000);
        CPlane.Insert();
    }
}
See Also