CurveLocus

References
[IoId("00000000-11ac-438f-9612-6833666f90d0")] public readonly struct CurveLocus : IStorable, IEquatable<CurveLocus>, IComparable<CurveLocus>
Represents a parameter or locus on or near a curve. This type replaces the simple numeric curve parameter as used in RhinoCommon and Grasshopper 1.0 with a more flexible and forgiving approach.

Constructors

CurveLocus

#
public CurveLocus(IReader reader)
Parameters:
reader (IReader)

Properties

Kind

#
public CurveLocusKind Kind { get; }
Gets the kind of locus this is.

Value

#
public object Value { get; }
Gets the value of this locus. The type of value depends on the Kind.

Methods

CompareTo

#
public int CompareTo(CurveLocus other)
Parameters:
other (CurveLocus)

Equals

#
public bool Equals(CurveLocus other)
Parameters:
other (CurveLocus)

Equals

#
public override bool Equals(object obj)
Parameters:
obj (object)
Overrides: ValueType.Equals

FromLength

#
public static CurveLocus FromLength(double length)
Create a curve locus from a length value.
Parameters:
length (double)

FromParameter

#
public static CurveLocus FromParameter(double parameter)
Create a curve locus from a curve parameter.
Parameters:
parameter (double)

FromPoint

#
public static CurveLocus FromPoint(Point3d point)
Create a curve locus from a 3D point.
Parameters:
point (Point3d)

FromRatio

#
public static CurveLocus FromRatio(double ratio)
Create a curve locus from a normalised length ratio.
Parameters:
ratio (double)

GetHashCode

#
public override int GetHashCode()
Overrides: ValueType.GetHashCode
Explicit

IStorable.Store

#
void IStorable.Store(IWriter writer)
Parameters:
writer (IWriter)
Implements: Store

ResolveToParameter

#
public bool ResolveToParameter(Arc curve, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
curve (Arc)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Circle circle, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
circle (Circle)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Curve curve, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
curve (Curve)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Line line, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
line (Line)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(object curve, ICurveAssistant assistant, Curve rhinoCurve, out double parameter)
Resolve this locus to an actual curve parameter on a Rhino curve. This resolver is needed when a locus is defined on some unknown curve type, but it needs to be transferred onto the Curve conversion of that unknown curve type. I.e. let's say the locus is defined on an Arc, and the arc has already been converted into an ArcCurve or maybe even a NurbsCurve. Use this method to revolve the parameter on the ArcCurve or NurbsCurve implied by the locus and the original Arc.
Parameters:
curve (object)Curve on which this locus is defined.
assistant (ICurveAssistant)Curve assistant override. If null, a fitting assistant will be found.
rhinoCurve (Curve)Rhino curve whose parameter we're interested in.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(object curve, ICurveAssistant assistant, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
curve (object)Curve to map on to.
assistant (ICurveAssistant)Curve assistant override. If null, a fitting assistant will be found.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Polyline polyline, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
polyline (Polyline)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Rectangle3d rectangle, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
rectangle (Rectangle3d)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ResolveToParameter

#
public bool ResolveToParameter(Triangle triangle, out double parameter)
Resolve this locus to an actual curve parameter.
Parameters:
triangle (Triangle)Curve to map on to.
parameter (out double)Resulting curve parameter.
Returns: True if mapping was successful, even if the mapping went beyond the curve domain.

ToString

#
public override string ToString()
Overrides: ValueType.ToString

ToString

#
public string ToString(NumberFormat format)
Parameters:
format (NumberFormat)

TryParse

#
public static Result<CurveLocus> TryParse(string text)
Parameters:
text (string)

Convertors

OperationResultDescription
implicitdoubleCurveLocusCreate a curve locus from a parameter.
implicitPoint3dCurveLocusCreate a curve locus from a point.