File3dmShutLining

References
public class File3dmShutLining
Represents the shut-lining attached to file3dm object attributes.

Properties

AutoUpdate

#Since v8.0
public bool AutoUpdate { get; set; }
Specifies whether the shut-lining automatically updates or not.

Faceted

#Since v8.0
public bool Faceted { get; set; }
Specifies whether the shut-lining is faceted or not.

ForceUpdate

#Since v8.0
public bool ForceUpdate { get; set; }
Specifies whether updating is forced or not.

On

#Since v8.0
public bool On { get; set; }
Specifies whether shut-lining is enabled or not.

Methods

AddCurve

#Since v8.0
public Guid AddCurve()
Adds a new curve to the shut-lining. The curve will have an id of Guid.Empty. After adding a curve, you should set the id to that of a curve in the model that will be used to calculate the shut-lining.

CurveEnabled

#Since v8.0
public bool CurveEnabled(Guid curve_id)
Return whether shut-line is created for the given curve.
Parameters:
curve_id (Guid)

CurveIsBump

#Since v8.0
public bool CurveIsBump(Guid curve_id)
Returns whether to create a bump instead of a dent for the given curve.
Parameters:
curve_id (Guid)

CurveProfile

#Since v8.0
public int CurveProfile(Guid curve_id)
Returns the profile of the shut-line for the given curve.
Parameters:
curve_id (Guid)

CurvePull

#Since v8.0
public bool CurvePull(Guid curve_id)
Returns whether the given curve is pulled to the surface before creating the shut-line.
Parameters:
curve_id (Guid)

CurveRadius

#Since v8.0
public double CurveRadius(Guid curve_id)
Returns the radius of the pipe used to create the shut-line for the given curve.
Parameters:
curve_id (Guid)

DeleteAllCurves

#Since v8.0
public void DeleteAllCurves()
Deletes all the curves from the shut-lining.

GetCurves

#Since v8.0
public Guid[] GetCurves()
Gets all the curves on the shut-lining. Each curve is identified by a Guid. If there are no curves present, the array will be empty.

SetCurveEnabled

#Since v8.0
public void SetCurveEnabled(Guid curve_id, bool enabled)
Sets whether shut-line is created for the given curve.
Parameters:
curve_id (Guid)
enabled (bool)

SetCurveIsBump

#Since v8.0
public void SetCurveIsBump(Guid curve_id, bool b)
Sets whether to create a bump instead of a dent for the given curve.
Parameters:
curve_id (Guid)
b (bool)

SetCurveProfile

#Since v8.0
public void SetCurveProfile(Guid curve_id, int profile)
Sets the profile of the shut-line for the given curve.
Parameters:
curve_id (Guid)
profile (int)

SetCurvePull

#Since v8.0
public void SetCurvePull(Guid curve_id, bool pull)
Sets whether the given curve is pulled to the surface before creating the shut-line.
Parameters:
curve_id (Guid)
pull (bool)

SetCurveRadius

#Since v8.0
public void SetCurveRadius(Guid curve_id, double radius)
Sets the radius of the pipe used to create the shut-line for the given curve.
Parameters:
curve_id (Guid)
radius (double)