GH_Field

References
public class GH_Field : IGH_Goo, IGH_PreviewData
Represents a field of forces.

Constructors

GH_Field

#
public GH_Field()
Blank constructor.

GH_Field

#
public GH_Field(GH_Field other)
Copy constructor.
Parameters:
other (GH_Field)Field to duplicate.

Properties

ClippingBox

#
public BoundingBox ClippingBox { get; }
Implements: ClippingBox

Elements

#
public List<IGH_FieldElement> Elements { get; }
Gets the list of elements of this field.

IsValid

#
public bool IsValid { get; }
Implements: IsValid

IsValidWhyNot

#
public string IsValidWhyNot { get; }
Implements: IsValidWhyNot

TypeDescription

#
public string TypeDescription { get; }
Implements: TypeDescription

TypeName

#
public string TypeName { get; }
Implements: TypeName

Methods

CastFrom

#
public bool CastFrom(object source)
Parameters:
source (object)
Implements: CastFrom

CastTo<T>

#
public bool CastTo<T>(ref T target)
Parameters:
target (ref T)
Implements: CastTo

CurvatureAt

#
public double CurvatureAt(Point3d location)
Parameters:
location (Point3d)

DrawViewportMeshes

#
public void DrawViewportMeshes(GH_PreviewMeshArgs args)
Parameters:
args (GH_PreviewMeshArgs)
Implements: DrawViewportMeshes

DrawViewportWires

#
public void DrawViewportWires(GH_PreviewWireArgs args)
Parameters:
args (GH_PreviewWireArgs)
Implements: DrawViewportWires

Duplicate

#
public IGH_Goo Duplicate()
Implements: Duplicate

EmitProxy

#
public IGH_GooProxy EmitProxy()
Implements: EmitProxy

Read

#
public bool Read(GH_IReader reader)
Parameters:
reader (GH_IReader)
Implements: Read

ScriptVariable

#
public object ScriptVariable()
Implements: ScriptVariable

SolveStep

#
public Vector3d SolveStep(Point3d location, double factor, GH_DifferentialSolver method)
Move a point through the field.
Parameters:
location (Point3d)Point to move from.
factor (double)Multiplication factor to apply to sampling. A low factor results in more accurate sampling, but smaller steps.
method (GH_DifferentialSolver)Estimator to use.
Returns: New point location.

SolveSteps

#
public Point3dList SolveSteps(Point3d location, double accuracy, int count, GH_DifferentialSolver method)
Move a point through a succession of steps.
Parameters:
location (Point3d)Point to move.
accuracy (double)Rough accuracy.
count (int)Number of samples to take.
method (GH_DifferentialSolver)Estimator to use.
Returns: A track (including the original location) of all the samples.

TensorAt

#
public Vector3d TensorAt(Point3d location)
Compute the field tensor at the given location as contributed by all the field elements.
Parameters:
location (Point3d)Location to sample field at.
Returns: The strength and direction of the field at the given location.

ToString

#
public string ToString()
Implements: ToString

Write

#
public bool Write(GH_IWriter writer)
Parameters:
writer (GH_IWriter)
Implements: Write