CurveAssistant<T>

public abstract class CurveAssistant<T> : ICurveAssistant

Specific assistant for curve like types.

Type parameters:

T	Type to assist.

Constructors

CurveAssistant

protected CurveAssistant()

Abstract constructor, assigns Type and TypeId fields based on T.

Properties

IsReimplementation

public bool IsReimplementation { get; }

Gets whether or not this assistant is a type-safe re-implementation of a more generic assistant.

Implements: IsReimplementation

ReimplementationBase

public ICurveAssistant ReimplementationBase { get; }

Gets the base assistant (if any) this assistant is a re-implementation of.

Implements: ReimplementationBase

Type

public Type Type { get; }

Gets the type associated with this assistant.

Implements: Type

Methods

BoundingBox

public virtual BoundingBox BoundingBox(T instance)

Gets the bounding box of a curve.

Parameters:

instance (T)

Curve instance.

Returns: World axis aligned bounding box.

ConvertToNurbsCurve

public virtual NurbsCurve ConvertToNurbsCurve(T instance)

Convert the instance into a Rhino NURBS curve type which best describes the original instance. Note this method need not return a duplicate of the input, if a duplicate is required by the caller then a ReferenceEquals check must be performed.

Parameters:

instance (T)

Instance to convert.

Returns: A Rhino NURBS curve or null if there is no way to describe the curve geometry as NURBS.

ConvertToPolyline

public virtual Polyline ConvertToPolyline(T instance, double deviation, double angle)

Convert the instance into a polyline.

Parameters:

instance (T)	Instance to convert.
deviation (double)	Maximum allowed deviation (absolute tolerance) between original curve and resulting polyline.
angle (double)	Maximum allowed angle between original curve tangents and polyline corners.

ConvertToRhinoCurve

public abstract Curve ConvertToRhinoCurve(T instance)

Convert the instance into a Rhino curve type which best describes the original instance. Note this method need not return a duplicate of the input, if a duplicate is required by the caller then a ReferenceEquals check must be performed.

Parameters:

instance (T)

Instance to convert.

Returns: A Rhino curve or null if there is no Rhino curve type which remotely describes this instance of T.

DivideByCount

public virtual double[] DivideByCount(T instance, int count)

Divide the curve into a number of equal length segments.

Parameters:

instance (T)	Instance.
count (int)	Number of segments.

Returns: Array of division parameters, including the start and end of the domain.

DivideByDistance

public virtual double[] DivideByDistance(T instance, double distance)

Divide a curve into segments whose end-points are a fixed distance apart.

Parameters:

instance (T)	Instance.
distance (double)	Distance between segment start and end-points.

Returns: Array of division parameters. The parameter at the end of the domain is not included if there's a remainder segment.

DivideByLength

public virtual double[] DivideByLength(T instance, double length)

Divide the curve into equal length segments.

Parameters:

instance (T)	Instance.
length (double)	Tier length.

Returns: Array of division parameters. The parameter at the end of the domain is not included if there's a remainder segment.

EvaluateCurvature

public virtual Vector3d EvaluateCurvature(T instance, double parameter, CurveEvaluationSide side)

Evaluate the curvature of the curve at the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Curve parameter.
side (CurveEvaluationSide)	Side of parameter to evaluate.

Returns: Curvature at parameter, or Vector3d.None if the curve cannot be evaluated at the given parameter.

EvaluateDerivatives

public virtual Vector3d[] EvaluateDerivatives(T instance, double parameter, CurveEvaluationSide side, int count)

Evaluate the first N derivatives of the curve at the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Curve parameter.
side (CurveEvaluationSide)	Side of parameter to evaluate.
count (int)	Number of derivatives to compute.

Returns: An array of N+1 derivatives, where the first element describes the position vector.

EvaluatePerpendicular

public virtual Plane EvaluatePerpendicular(T instance, double parameter, CurveEvaluationSide side)

Evaluate the perpendicular plane of the curve at the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Curve parameter.
side (CurveEvaluationSide)	Side of parameter to evaluate.

Returns: Perpendicular at parameter, or Plane.None if the curve cannot be evaluated at the given parameter.

EvaluatePosition

public virtual Point3d EvaluatePosition(T instance, double parameter)

Evaluate the position of the curve at the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Curve parameter.

Returns: Point at parameter, or Point3d.None if the curve cannot be evaluated at the given parameter.

EvaluateTangent

public virtual Vector3d EvaluateTangent(T instance, double parameter, CurveEvaluationSide side)

Evaluate the tangent of the curve at the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Curve parameter.
side (CurveEvaluationSide)	Side of parameter to evaluate.

Returns: Tangent at parameter, or Vector3d.None if the curve cannot be evaluated at the given parameter.

Explode

public virtual object[] Explode(T instance)

Explode a curve into smaller segments, each representing a subtype of curve.

Parameters:

instance (T)

Instance.

Returns: Array of subcurves.

ExplodeRecursive

public virtual object[] ExplodeRecursive(T instance)

Explode a curve into the smallest possible segments.

Parameters:

instance (T)

Instance.

Returns: Array of subcurves.

Extend

public virtual object Extend(T instance, CurveExtension start, CurveExtension end)

Extend the curve.

Parameters:

instance (T)	Instance of T.
start (CurveExtension)	Extension properties at start.
end (CurveExtension)	Extension properties at end.

Returns: Modified curve.

FindClosestParameter

public virtual double FindClosestParameter(T instance, Point3d point)

Find the point on the curve closest to a test point.

Parameters:

instance (T)	Instance of T.
point (Point3d)	Test point.

Returns: Parameter or double.NaN if no parameter could be found.

FindCurvatureExtremes

public virtual void FindCurvatureExtremes(T instance, out double minimum, out double maximum)

Find the two parameters with the lowest and highest curvature.

Parameters:

instance (T)	Instance.
minimum (out double)	The (or one of the) parameters on the curve with the lowest curvature.
maximum (out double)	The (or one of the) parameters on the curve with the highest curvature.

FindDiscontinuities

public virtual Discontinuity[] FindDiscontinuities(T instance, DiscontinuityLevel order)

Find all discontinuities along the curve up to and including a target continuity type.

Parameters:

instance (T)	Instance.
order (DiscontinuityLevel)	Maximum continuity order to search for.

Returns: Array of curve discontinuities.

FindFurthestParameter

public virtual double FindFurthestParameter(T instance, Point3d point)

Find the point on the curve furthest from a test point.

Parameters:

instance (T)	Instance of T.
point (Point3d)	Test point.

Returns: Parameter or double.NaN if no parameter could be found.

FindInflections

public virtual double[] FindInflections(T instance)

Find all inflection points along the curve.

Parameters:

instance (T)

Instance.

Returns: Array of curve parameters.

FindPositionExtremes

public virtual void FindPositionExtremes(T instance, Plane plane, out double minimum, out double maximum)

Find the two parameters closest to and furthest away from a plane.

Parameters:

instance (T)	Instance.
plane (Plane)	Plane.
minimum (out double)	The (or one of the) parameters on the curve closest to the plane.
maximum (out double)	The (or one of the) parameters on the curve furthest from the plane.

FlipDirection

public virtual object FlipDirection(T instance)

Flip the curve.

Parameters:

instance (T)

Instance to flip.

Returns: Flipped curve.

GetDomain

public virtual Interval GetDomain(T instance)

Get the domain of an instance of T.

Parameters:

instance (T)

Instance of T.

Returns: Domain of curve.

GetEndPoints

public virtual void GetEndPoints(T instance, out Point3d start, out Point3d end)

Get the end-points of a curve.

Parameters:

instance (T)	Instance.
start (out Point3d)	Point at start.
end (out Point3d)	Point at end.

GetEndTangents

public virtual void GetEndTangents(T instance, out Vector3d start, out Vector3d end)

Get the tangents at the ends of a curve.

Parameters:

instance (T)	Instance.
start (out Vector3d)	Tangent at start.
end (out Vector3d)	Tangent at end.

GetLength

public virtual double GetLength(T instance)

Measure the total length of this curve.

Parameters:

instance (T)

Instance.

Returns: Length.

GetSpans

public virtual Interval[] GetSpans(T instance)

Gets an array of curve domain spans. A span is a section of the curve that is reasonably simple in shape. Discontinuities in curves typically signal transitions from one span to another, but it depends on the curve type how it divides itself up.

Parameters:

instance (T)

Instance.

Returns: Span domains.

Explicit

ICurveAssistant.BoundingBox

BoundingBox ICurveAssistant.BoundingBox(object instance)

Parameters:

instance (object)

Implements: BoundingBox

Explicit

ICurveAssistant.ConvertToNurbsCurve

NurbsCurve ICurveAssistant.ConvertToNurbsCurve(object instance)

Parameters:

instance (object)

Implements: ConvertToNurbsCurve

Explicit

ICurveAssistant.ConvertToPolyline

Polyline ICurveAssistant.ConvertToPolyline(object instance, double deviation, double angle)

Parameters:

instance (object)
deviation (double)
angle (double)

Implements: ConvertToPolyline

Explicit

ICurveAssistant.ConvertToRhinoCurve

Curve ICurveAssistant.ConvertToRhinoCurve(object instance)

Parameters:

instance (object)

Implements: ConvertToRhinoCurve

Explicit

ICurveAssistant.DivideByCount

double[] ICurveAssistant.DivideByCount(object instance, int count)

Parameters:

instance (object)
count (int)

Implements: DivideByCount

Explicit

ICurveAssistant.DivideByDistance

double[] ICurveAssistant.DivideByDistance(object instance, double distance)

Parameters:

instance (object)
distance (double)

Implements: DivideByDistance

Explicit

ICurveAssistant.DivideByLength

double[] ICurveAssistant.DivideByLength(object instance, double length)

Parameters:

instance (object)
length (double)

Implements: DivideByLength

Explicit

ICurveAssistant.EvaluateCurvature

Vector3d ICurveAssistant.EvaluateCurvature(object instance, double parameter, CurveEvaluationSide side)

Parameters:

instance (object)
parameter (double)
side (CurveEvaluationSide)

Implements: EvaluateCurvature

Explicit

ICurveAssistant.EvaluateDerivatives

Vector3d[] ICurveAssistant.EvaluateDerivatives(object instance, double parameter, CurveEvaluationSide side, int count)

Parameters:

instance (object)
parameter (double)
side (CurveEvaluationSide)
count (int)

Implements: EvaluateDerivatives

Explicit

ICurveAssistant.EvaluatePerpendicular

Plane ICurveAssistant.EvaluatePerpendicular(object instance, double parameter, CurveEvaluationSide side)

Parameters:

instance (object)
parameter (double)
side (CurveEvaluationSide)

Implements: EvaluatePerpendicular

Explicit

ICurveAssistant.EvaluatePosition

Point3d ICurveAssistant.EvaluatePosition(object instance, double parameter)

Parameters:

instance (object)
parameter (double)

Implements: EvaluatePosition

Explicit

ICurveAssistant.EvaluateTangent

Vector3d ICurveAssistant.EvaluateTangent(object instance, double parameter, CurveEvaluationSide side)

Parameters:

instance (object)
parameter (double)
side (CurveEvaluationSide)

Implements: EvaluateTangent

Explicit

ICurveAssistant.Explode

object[] ICurveAssistant.Explode(object instance)

Parameters:

instance (object)

Implements: Explode

Explicit

ICurveAssistant.ExplodeRecursive

object[] ICurveAssistant.ExplodeRecursive(object instance)

Parameters:

instance (object)

Implements: ExplodeRecursive

Explicit

ICurveAssistant.Extend

object ICurveAssistant.Extend(object instance, CurveExtension start, CurveExtension end)

Parameters:

instance (object)
start (CurveExtension)
end (CurveExtension)

Implements: Extend

Explicit

ICurveAssistant.FindClosestParameter

double ICurveAssistant.FindClosestParameter(object instance, Point3d point)

Parameters:

instance (object)
point (Point3d)

Implements: FindClosestParameter

Explicit

ICurveAssistant.FindCurvatureExtremes

void ICurveAssistant.FindCurvatureExtremes(object instance, out double minimum, out double maximum)

Parameters:

instance (object)
minimum (out double)
maximum (out double)

Implements: FindCurvatureExtremes

Explicit

ICurveAssistant.FindDiscontinuities

Discontinuity[] ICurveAssistant.FindDiscontinuities(object instance, DiscontinuityLevel order)

Parameters:

instance (object)
order (DiscontinuityLevel)

Implements: FindDiscontinuities

Explicit

ICurveAssistant.FindFurthestParameter

double ICurveAssistant.FindFurthestParameter(object instance, Point3d point)

Parameters:

instance (object)
point (Point3d)

Implements: FindFurthestParameter

Explicit

ICurveAssistant.FindInflections

double[] ICurveAssistant.FindInflections(object instance)

Parameters:

instance (object)

Implements: FindInflections

Explicit

ICurveAssistant.FindPositionExtremes

void ICurveAssistant.FindPositionExtremes(object instance, Plane plane, out double minimum, out double maximum)

Parameters:

instance (object)
plane (Plane)
minimum (out double)
maximum (out double)

Implements: FindPositionExtremes

Explicit

ICurveAssistant.FlipDirection

object ICurveAssistant.FlipDirection(object instance)

Parameters:

instance (object)

Implements: FlipDirection

Explicit

ICurveAssistant.GetDomain

Interval ICurveAssistant.GetDomain(object instance)

Parameters:

instance (object)

Implements: GetDomain

Explicit

ICurveAssistant.GetEndPoints

void ICurveAssistant.GetEndPoints(object instance, out Point3d start, out Point3d end)

Parameters:

instance (object)
start (out Point3d)
end (out Point3d)

Implements: GetEndPoints

Explicit

ICurveAssistant.GetEndTangents

void ICurveAssistant.GetEndTangents(object instance, out Vector3d start, out Vector3d end)

Parameters:

instance (object)
start (out Vector3d)
end (out Vector3d)

Implements: GetEndTangents

Explicit

ICurveAssistant.GetLength

double ICurveAssistant.GetLength(object instance)

Parameters:

instance (object)

Implements: GetLength

Explicit

ICurveAssistant.GetSpans

Interval[] ICurveAssistant.GetSpans(object instance)

Parameters:

instance (object)

Implements: GetSpans

Explicit

ICurveAssistant.IntersectWith

double[] ICurveAssistant.IntersectWith(object instance, Plane plane)

Parameters:

instance (object)
plane (Plane)

Implements: IntersectWith

Explicit

ICurveAssistant.IsClosed

bool ICurveAssistant.IsClosed(object instance)

Parameters:

instance (object)

Implements: IsClosed

Explicit

ICurveAssistant.IsLinear

bool ICurveAssistant.IsLinear(object instance, double tolerance)

Parameters:

instance (object)
tolerance (double)

Implements: IsLinear

Explicit

ICurveAssistant.IsLinear

void ICurveAssistant.IsLinear(object instance, out Line line, out double deviation)

Parameters:

instance (object)
line (out Line)
deviation (out double)

Implements: IsLinear

Explicit

ICurveAssistant.IsPeriodic

bool ICurveAssistant.IsPeriodic(object instance)

Parameters:

instance (object)

Implements: IsPeriodic

Explicit

ICurveAssistant.IsPlanar

bool ICurveAssistant.IsPlanar(object instance, double tolerance)

Parameters:

instance (object)
tolerance (double)

Implements: IsPlanar

Explicit

ICurveAssistant.IsPlanar

void ICurveAssistant.IsPlanar(object instance, out Plane plane, out double deviation)

Parameters:

instance (object)
plane (out Plane)
deviation (out double)

Implements: IsPlanar

Explicit

ICurveAssistant.LengthAtParameter

bool ICurveAssistant.LengthAtParameter(object instance, double parameter, out double length)

Parameters:

instance (object)
parameter (double)
length (out double)

Implements: LengthAtParameter

Explicit

ICurveAssistant.ParameterAtLength

bool ICurveAssistant.ParameterAtLength(object instance, double length, out double parameter)

Parameters:

instance (object)
length (double)
parameter (out double)

Implements: ParameterAtLength

Explicit

ICurveAssistant.SetDomain

object ICurveAssistant.SetDomain(object instance, Interval domain)

Parameters:

instance (object)
domain (Interval)

Implements: SetDomain

Explicit

ICurveAssistant.Split

void ICurveAssistant.Split(object instance, double parameter, out object below, out object above)

Parameters:

instance (object)
parameter (double)
below (out object)
above (out object)

Implements: Split

Explicit

ICurveAssistant.Trim

object ICurveAssistant.Trim(object instance, Interval domain)

Parameters:

instance (object)
domain (Interval)

Implements: Trim

IntersectWith

public virtual double[] IntersectWith(T instance, Plane plane)

Find all the intersection parameters between this curve and a plane.

Parameters:

instance (T)	Curve.
plane (Plane)	Plane.

Returns: Collection of zero or more curve parameters.

IsClosed

public virtual bool IsClosed(T instance)

Determine whether the curve is closed.

Parameters:

instance (T)

Instance of T.

Returns: Boolean value indicating closedness.

IsLinear

public virtual bool IsLinear(T instance, double tolerance)

Determine whether the curve is linear.

Parameters:

instance (T)	Instance.
tolerance (double)	Maximum allowed linearity deviation.

Returns: True if curve is linear.

IsLinear

public virtual void IsLinear(T instance, out Line line, out double deviation)

Determine the best fit line for this curve.

Parameters:

instance (T)	Instance.
line (out Line)	Line which best approximates curve.
deviation (out double)	Maximum deviation from line.

IsPeriodic

public virtual bool IsPeriodic(T instance)

Determine whether the curve is periodic.

Parameters:

instance (T)

Instance of T.

Returns: Boolean value indicating periodicity.

IsPlanar

public virtual bool IsPlanar(T instance, double tolerance)

Determine whether the curve is planar.

Parameters:

instance (T)	Instance of T.
tolerance (double)	Maximum allowed planarity deviation.

Returns: Boolean value indicating planarity.

IsPlanar

public virtual void IsPlanar(T instance, out Plane plane, out double deviation)

Determine the best fit plane for this curve.

Parameters:

instance (T)	Instance of T.
plane (out Plane)	Plane of curve or Plane.None if curve is not planar.
deviation (out double)	Maximum deviation from plane.

LengthAtParameter

public virtual bool LengthAtParameter(T instance, double parameter, out double length)

Gets the length from the start of the curve to the given parameter.

Parameters:

instance (T)	Instance of T.
parameter (double)	Parameter on curve.
length (out double)	Length from start of curve to parameter.

Returns: Success or failure.

ParameterAtLength

public virtual bool ParameterAtLength(T instance, double length, out double parameter)

Get the parameter of a curve at a given length from the start.

Parameters:

instance (T)	Instance.
length (double)	Length along curve to measure.
parameter (out double)	Parameter at the given length.

Returns: True if length measurement was possible.

SetDomain

public virtual object SetDomain(T instance, Interval domain)

Assign a new parameter domain to the curve.

Parameters:

instance (T)	Instance.
domain (Interval)	New domain to assign.

Returns: Curve with new domain.

Split

public virtual void Split(T instance, double parameter, out object below, out object above)

Split a curve into two parts.

Parameters:

instance (T)	Instance.
parameter (double)	Splitting parameter.
below (out object)	Part from start of curve to parameter.
above (out object)	Part from parameter to end of curve.

Trim

public virtual object Trim(T instance, Interval domain)

Extract a subcurve from an instance of T.

Parameters:

instance (T)	Instance of T.
domain (Interval)	Domain of subcurve.

Returns: Sub curve.