GH_Line

GH_GeometricGoo<1>GH_Goo<1>References

public class GH_Line : GH_GeometricGoo<Line>, IGH_BakeAwareData, IGH_PreviewData

Represents a 3D line segment. GH_Line re-implements the OpenNURBS OnLine class.

Constructors

GH_Line

public GH_Line()

Default constructor

GH_Line

public GH_Line(GH_Line other)

Create a duplicate of another line.

Parameters:

other (GH_Line)

Line to copy. If null, a default line will be created.

GH_Line

public GH_Line(Line line)

Create a duplicate of another line.

Parameters:

line (Line)

Line to copy. If null, a default line will be created.

Fields

m_value

protected T m_value

inherited fromGH_Goo<T>

Properties

Boundingbox

public override BoundingBox Boundingbox { get; }

Overrides: GH_GeometricGoo<T>.Boundingbox

ClippingBox

public BoundingBox ClippingBox { get; }

Implements: ClippingBox

IsGeometryLoaded

public virtual bool IsGeometryLoaded { get; }

Gets a value indicating whether or not this geometry is currently loaded (assuming it is referenced). Not all IGH_GeometricGoo implementations support referenced geometry. The default is to always return True.

inherited fromGH_GeometricGoo<T>

Implements: IsGeometryLoaded

IsReferencedGeometry

public virtual bool IsReferencedGeometry { get; }

Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.

inherited fromGH_GeometricGoo<T>

Implements: IsReferencedGeometry

IsValid

public override bool IsValid { get; }

Gets the validity of this instance. Lines with zero length are not considered to be valid.

Overrides: GH_GeometricGoo<T>.IsValid

IsValidWhyNot

public override string IsValidWhyNot { get; }

Gets a string describing the state of "invalidness". If the instance is valid, then this property should return Nothing or String.Empty.

Overrides: GH_Goo<T>.IsValidWhyNot

ReferenceID

public virtual Guid ReferenceID { get; set; }

Gets or sets the Guid of the object that is referenced. Not all IGH_GeometricGoo implementations support referenced geometry. The default implementation is to always return Guid.Empty.

inherited fromGH_GeometricGoo<T>

Implements: ReferenceID

TypeDescription

public override string TypeDescription { get; }

Overrides: GH_Goo<T>.TypeDescription

TypeName

public override string TypeName { get; }

Overrides: GH_Goo<T>.TypeName

Value

public override T Value { get; set; }

Gets or sets the value of this type. Note that if the type has a ReferenceID this value might get destroyed in the future.

inherited fromGH_GeometricGoo<T>

Overrides: GH_Goo<T>.Value

Methods

BakeGeometry

public bool BakeGeometry(RhinoDoc doc, ObjectAttributes att, ref Guid obj_guid)

Parameters:

doc (RhinoDoc)
att (ObjectAttributes)
obj_guid (ref Guid)

Implements: BakeGeometry

CastFrom

public override bool CastFrom(object source)

Remote to Local caster function. This stuff is complex, don't concern yourself with casting logic.

Parameters:

source (object)

Overrides: GH_GeometricGoo<T>.CastFrom

CastTo<Q>

public virtual bool CastTo<Q>(ref Q target)

Attempt a cast to type Q.

inherited fromGH_Goo<T>

Remarks: If false, the target instance contents are not guaranteed to be valid.

Parameters:

target (ref Q)

Pointer to target of cast.

Returns: True on success, false on failure.

Implements: CastTo

CastTo<T>

public override bool CastTo<T>(ref T target)

Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.

Parameters:

target (ref T)

Overrides: GH_GeometricGoo<T>.CastTo

ClearCaches

public virtual void ClearCaches()

Clears all caches. Typically if the geometry is referenced, this will erase the local copy. If your T is a value-type, you must override this function and specifically unset the local value.

inherited fromGH_GeometricGoo<T>

Implements: ClearCaches

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 override IGH_Goo Duplicate()

Overrides: GH_GeometricGoo<T>.Duplicate

DuplicateGeometry

public override IGH_GeometricGoo DuplicateGeometry()

Create a duplicate of this line.

Overrides: GH_GeometricGoo<T>.DuplicateGeometry

DuplicateLine

public GH_Line DuplicateLine()

Create a duplicate of this line.

EmitProxy

public override IGH_GooProxy EmitProxy()

Returns a proxy that represents this line. Do not call this function unless you're

Overrides: GH_GeometricGoo<T>.EmitProxy

GetBoundingBox

public override BoundingBox GetBoundingBox(Transform xform)

Parameters:

xform (Transform)

Overrides: GH_GeometricGoo<T>.GetBoundingBox

LoadGeometry

public virtual bool LoadGeometry()

If the geometry is referenced and currently unloaded, forces loading of the geometry. Not all IGH_GeometricGoo implementations support referenced geometry.

inherited fromGH_GeometricGoo<T>

Implements: LoadGeometry

LoadGeometry

public virtual bool LoadGeometry(RhinoDoc doc)

If the geometry is referenced and currently unloaded, forces loading of the geometry. Not all IGH_GeometricGoo implementations support referenced geometry. The default is to always return True.

inherited fromGH_GeometricGoo<T>

Parameters:

doc (RhinoDoc)

Document to use for loading.

Implements: LoadGeometry

Morph

public override IGH_GeometricGoo Morph(SpaceMorph xmorph)

Parameters:

xmorph (SpaceMorph)

Overrides: GH_GeometricGoo<T>.Morph

Read

public override bool Read(GH_IReader reader)

Parameters:

reader (GH_IReader)

Overrides: GH_Goo<T>.Read

ScriptVariable

public virtual object ScriptVariable()

This function will be called when the local IGH_Goo instance disappears into a user Script. This would be an excellent place to cast your IGH_Goo type to a simple data type.

inherited fromGH_Goo<T>

Returns: The default implementation of this function returns the Value instance.

Implements: ScriptVariable