ShapeField

FieldReferences
public abstract class ShapeField : Field

Constructors

ShapeField

#
public ShapeField(IPear[] shapes)
Create a shape field for various shapes.
Parameters:
shapes (IPear[])Shapes to flee.

ShapeField

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

Properties

Count

#
protected int Count { get; }

FormatLabel

protected string FormatLabel { get; }
Gets the name of this field condensed into a single word, which is how the name appears in formatted values.
inherited fromField

Name

public abstract string Name { get; }
Gets the name of this field.
inherited fromField

Type

public abstract FieldType Type { get; }
Gets the type of this field.
inherited fromField

Methods

Distance

#
protected double Distance(int index, Point3d point)
Parameters:
index (int)
point (Point3d)

Filter

#
protected int Filter(params ShapeType[] allowedTypes)
Remove all shape which are of a different type.
Parameters:
allowedTypes (params ShapeField.ShapeType[])All allowed types.
Returns: Number of shapes removed.

Format

public virtual string Format()
Create a string representation of this field.
inherited fromField

ModifierArguments

protected Fragments ModifierArguments(string text)
Reduce modifier notation to just the arguments. The labelled form written by Field.Format() ("ScalarNoise min:0 max:1"), the bracketed form ("Scalar Noise (0, 1)") and a bare list of arguments ("0, 1") are all accepted, so that a displayed value can be edited by changing only the parts which matter.
inherited fromField
Parameters:
text (string)Modifier notation.
Returns: View of the arguments, ready for Interpret.Bind<T>(Fragments, ArgumentSyntax[], Argument[], Result<T>).

NearestShape

#
protected int NearestShape(Point3d point, out double distance)
Parameters:
point (Point3d)
distance (out double)

NearestShape

#
protected int NearestShape(Point3d point, out Point3d closestPoint, out Vector3d closestNormal)
Parameters:
point (Point3d)
closestPoint (out Point3d)
closestNormal (out Vector3d)

Project

#
protected (Point3d point, Vector3d normal) Project(int index, Point3d point)
Parameters:
index (int)
point (Point3d)

ScalarAt

public abstract double ScalarAt(Point3d point)
Evaluate the field scalar component at a specific point in space. If this is a vector-field, the returned value is *probably* the magnitude of the vector, but this is not guaranteed.
inherited fromField
Parameters:
point (Point3d)The point at which to evaluate the field.
Returns: The scalar value at the given coordinate.

Store

#
public override void Store(IWriter writer)
Parameters:
writer (IWriter)
Overrides: Field.Store

Trace

public IEnumerable<Point3d> Trace(Point3d start, Angle maximumAngle, DifferentialSolver solver)
Approximate a trajectory through a vector field.
inherited fromField
Parameters:
start (Point3d)Start point of trajectory.
maximumAngle (Angle)Maximum allowed kink angle between segments.
solver (DifferentialSolver)Differential interpolation scheme to use.
Returns: Points along the trajectory.

Trace

public IEnumerable<Point3d> Trace(Point3d start, double stepSize, DifferentialSolver solver)
Approximate a trajectory through a vector field.
inherited fromField
Parameters:
start (Point3d)Start point of trajectory.
stepSize (double)Size of intermediate steps.
solver (DifferentialSolver)Differential interpolation scheme to use.
Returns: Points along the trajectory.

Trace

public Polyline Trace(Point3d start, double accuracy, double targetLength, DifferentialSolver solver)
Approximate a trajectory through a vector field.
inherited fromField
Parameters:
start (Point3d)Start point of trajectory.
accuracy (double)Accuracy of intermediate steps. When negative, trajectory is traced backwards.
targetLength (double)Length of trajectory.
solver (DifferentialSolver)Differential interpolation scheme to use.
Returns: Point at end of trajectory.

TryModify

public virtual Result<Field> TryModify(string text)
Try and create a new field based on this field and modifier notation.

Only the salient properties of a field are exposed to text, the rest are copied from this instance. That is why there is no way to write a field of a specific type from nothing; there has to be one already to serve as the template. Constant scalar and vector fields are the exception, they are entirely described by a number or a vector.

Implementations are expected to accept whatever their Field.Format() writes, so a value can be edited by changing the text it is displayed as. Field.ModifierArguments(string) deals with the label in front of the arguments.

inherited fromField
Parameters:
text (string)Modifier notation.
Returns: Result of parsing operation.

VectorAt

public abstract Vector3d VectorAt(Point3d point)
Evaluate the field vector component at a specific point in space. If this is a scalar-field, the returned value is *probably* a vector in the form (0,0,scalar), but this is not guaranteed.
inherited fromField
Parameters:
point (Point3d)The point at which to evaluate the field.
Returns: The vector value at the given coordinate