SpinField

VectorFieldField
[IoId("00000000-4DAD-471D-9218-66B23F25732B")] public class SpinField : VectorField
Represents a directional field with custom falloff and charges for multiple points.

Constructors

SpinField

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

SpinField

#
public SpinField(Plane plane, Function radial = null, Function perpendicular = null)
Create a vector spin field.
Parameters:
plane (Plane)Spin plane.
radial (Function = null)Falloff of spin force with radial distance to spin plane origin.
perpendicular (Function = null)Falloff of spin force with perpendicular distance to spin plane. The default falloff is a constant, resulting in a cylindrical spin volume.

Properties

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 override string Name { get; }
Overrides: Field.Name

Type

public sealed override FieldType Type { get; }
inherited fromVectorField
Overrides: Field.Type

Methods

Format

#
public override string Format()
Overrides: Field.Format

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>).

ScalarAt

public sealed override double ScalarAt(Point3d point)
Evaluate the field scalar component at a specific point in space.
inherited fromVectorField
Parameters:
point (Point3d)The point at which to evaluate the field.
Returns: True if the field could be evaluated at the given coordinate.
Overrides: Field.ScalarAt

Store

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

ToString

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

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 override 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.

Parameters:
text (string)Modifier notation.
Returns: Result of parsing operation.
Overrides: Field.TryModify

VectorAt

#
public override Vector3d VectorAt(Point3d point)
Parameters:
point (Point3d)
Overrides: Field.VectorAt