Unroller

public class Unroller

Represents the operation of unrolling a single surface.

Constructors

Unroller

#Since v5.0

public Unroller(Brep brep)

Initializes a new instance of the Unroller class with a brep.

Parameters:

brep (Brep)

A brep to be unrolled.

Unroller

#Since v5.0

public Unroller(Surface surface)

Initializes a new instance of the Unroller class with surface.

Parameters:

surface (Surface)

A surface to be unrolled.

Properties

AbsoluteTolerance

#Since v5.0

public double AbsoluteTolerance { get; set; }

Gets or sets the absolute tolerance for the unrolling operation.

Absolute tolerance is used in the evaluation of new entities, such as intersections, re-projections and splits.

In the current implementation, absolute tolerance is used in tessellating rails, fitting curves and pulling back trims.

ExplodeOutput

#Since v5.0

public bool ExplodeOutput { get; set; }

Gets or sets a value determining whether geometry should be exploded.

ExplodeSpacing

#Since v5.0

public double ExplodeSpacing { get; set; }

Gets or sets a value determining whether spacing should be exploded.

RelativeTolerance

#Since v5.0

public double RelativeTolerance { get; set; }

Gets or sets the relative tolerance for the unrolling operation.

Relative tolerance is used in the evaluation of intrinsic properties, such as computations "along" the surface or brep.

In the current implementation, relative tolerance is used to decide if a surface is flat enough to try to unroll. That helps ease the scale dependency. The surface has to be linear in one direction within (length * RelativeTolerance) to be considered linear for that purpose. Otherwise smash will ignore that tolerance and unroll anything.

Methods

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(Curve curve)

Adds a curve that should be unrolled along with the surface/brep.

Parameters:

curve (Curve)

The curve.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(IEnumerable<Curve> curves)

Adds curves that should be unrolled along with the surface/brep.

Parameters:

curves (IEnumerable<Curve>)

An array, a list or any enumerable set of curves.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(IEnumerable<Point3d> dotLocations, IEnumerable<string> dotText)

Adds text dots that should be unrolled along with the surface/brep.

Parameters:

dotLocations (IEnumerable<Point3d>)	An array, a list, or any enumerable set of dot locations.
dotText (IEnumerable<string>)	An array, a list, or any enumerable set of dot strings.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(IEnumerable<Point3d> points)

Adds points that should be unrolled along with the surface/brep.

Parameters:

points (IEnumerable<Point3d>)

An array, a list or any enumerable set of points.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(IEnumerable<TextDot> dots)

Adds text dots that should be unrolled along with the surface/brep.

Parameters:

dots (IEnumerable<TextDot>)

An array, a list or any enumerable set of text dots.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(Point point)

Adds a point that should be unrolled along with the surface/brep.

Parameters:

point (Point)

A point.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(Point3d dotLocation, string dotText)

Adds a text dot that should be unrolled along with the surface/brep.

Parameters:

dotLocation (Point3d)	A dot point.
dotText (string)	A dot text.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(Point3d point)

Adds a point that should be unrolled along with the surface/brep.

Parameters:

point (Point3d)

A point.

AddFollowingGeometry

#Since v5.0

public void AddFollowingGeometry(TextDot dot)

Adds a text dot that should be unrolled along with the surface/brep.

Parameters:

dot (TextDot)

A text dot.

FollowingGeometryIndex

#Since v6.0

public int FollowingGeometryIndex(Curve curve)

Given an unrolled curve, returns the index of the source, or following curve.

Parameters:

curve (Curve)

An unrolled curve returned by Unroller.PerformUnroll.

Returns: The index of the curve added by Unroller.AddFollowingGeometry if successful, otherwise -1.

FollowingGeometryIndex

#Since v6.0

public int FollowingGeometryIndex(TextDot dot)

Given an unrolled text dot, returns the index of the source, or following text dot.

Parameters:

dot (TextDot)

An unrolled text dot returned by Unroller.PerformUnroll.

Returns: The index of the text dot added by Unroller.AddFollowingGeometry if successful, otherwise -1.

PerformUnroll

#Since v5.0

public Brep[] PerformUnroll(out Curve[] unrolledCurves, out Point3d[] unrolledPoints, out TextDot[] unrolledDots)

Executes unrolling operations.

Parameters:

unrolledCurves (out Curve[])	An array of unrolled curves is assigned during the call in this out parameter.
unrolledPoints (out Point3d[])	An array of unrolled points is assigned during the call in this out parameter.
unrolledDots (out TextDot[])	An array of unrolled text dots is assigned during the call in this out parameter.

Returns: An array of breps. This array can be empty.

PerformUnroll

#Since v6.0

public int PerformUnroll(List<Brep> flatbreps)

Executes unrolling operations.

Parameters:

flatbreps (List<Brep>)

List of breps containing flattened results.

Returns: Number of breps in result