IGH_FieldElement

References
public interface IGH_FieldElement : GH_ISerializable, IGH_PreviewData
Represents the basic interface for field elements.

Properties

BoundingBox

#
BoundingBox BoundingBox { get; }
Gets the visual boundingbox of all the geometry used to represent this element in 3D.

ClippingBox

BoundingBox ClippingBox { get; }
Gets the clipping box for this data. The clipping box is typically the same as the boundingbox.
inherited fromIGH_PreviewData
Returns: The clipping box for this object.

ElementGuid

#
Guid ElementGuid { get; }
Gets the element Guid for this element.

IsLimited

#
bool IsLimited { get; set; }
Gets or sets whether this element affects a limited region.

Limits

#
Box Limits { get; set; }
Gets or sets the limits of this region. Unless IsLimited equals true, the Limits property is ignored.

Methods

DrawViewportMeshes

void DrawViewportMeshes(GH_PreviewMeshArgs args)
Implement this function to draw all shaded meshes. If the viewport does not support shading, this function will not be called.
inherited fromIGH_PreviewData
Parameters:
args (GH_PreviewMeshArgs)Drawing arguments.

DrawViewportWires

void DrawViewportWires(GH_PreviewWireArgs args)
Implement this function to draw all wire and point previews.
inherited fromIGH_PreviewData
Parameters:
args (GH_PreviewWireArgs)Drawing arguments.

Duplicate

#
IGH_FieldElement Duplicate()
Create an exact copy of this element.

Force

#
Vector3d Force(Point3d location)
Compute the force at a given location.
Parameters:
location (Point3d)

IsCoincident

#
bool IsCoincident(Point3d point, double tolerance)
Computes whether the point can be considered coincident with the element.
Parameters:
point (Point3d)Point to test.
tolerance (double)Tolerance to use.
Returns: True if the point is coincident within tolerance.

Read

bool Read(GH_IReader reader)
This method is called whenever the instance is required to deserialize itself.
inherited fromGH_ISerializable
Parameters:
reader (GH_IReader)Reader object to deserialize from.
Returns: True on success, false on failure.

Write

bool Write(GH_IWriter writer)
This method is called whenever the instance is required to serialize itself.
inherited fromGH_ISerializable
Parameters:
writer (GH_IWriter)Writer object to serialize with.
Returns: True on success, false on failure.