Click or drag to resize

GH_Line Class

Represents a 3D line segment. GH_Line re-implements the OpenNURBS OnLine class.
Inheritance Hierarchy
SystemObject
  Grasshopper.Kernel.TypesGH_GooLine
    Grasshopper.Kernel.TypesGH_GeometricGooLine
      Grasshopper.Kernel.TypesGH_Line

Namespace:  Grasshopper.Kernel.Types
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
public class GH_Line : GH_GeometricGoo<Line>, 
	IGH_BakeAwareData, IGH_PreviewData

The GH_Line type exposes the following members.

Constructors
  NameDescription
Public methodGH_Line
Default constructor
Public methodGH_Line(GH_Line)
Create a duplicate of another line.
Public methodGH_Line(Line)
Create a duplicate of another line.
Top
Properties
  NameDescription
Public propertyBoundingbox (Overrides GH_GeometricGooTBoundingbox.)
Public propertyClippingBox
Public propertyIsGeometryLoaded
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 from GH_GeometricGooT.)
Public propertyIsReferencedGeometry
Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.)
Public propertyIsValid
Gets the validity of this instance. Lines with zero length are not considered to be valid.
(Overrides GH_GeometricGooTIsValid.)
Public propertyIsValidWhyNot
Gets a string describing the state of "invalidness". If the instance is valid, then this property should return Nothing or String.Empty.
(Overrides GH_GooTIsValidWhyNot.)
Public propertyReferenceID
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 from GH_GeometricGooT.)
Public propertyTypeDescription (Overrides GH_GooTTypeDescription.)
Public propertyTypeName (Overrides GH_GooTTypeName.)
Public propertyValue
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 from GH_GeometricGooT.)
Top
Methods
  NameDescription
Public methodBakeGeometry
Public methodCastFrom
Remote to Local caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastFrom(Object).)
Public methodCastToQ(Q)
Attempt a cast to type T.
(Inherited from GH_GeometricGooT.)
Public methodCastToQ(Q)
Attempt a cast to type Q.
(Inherited from GH_GooT.)
Public methodCastToT(T)
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastToQ(Q).)
Public methodClearCaches
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 from GH_GeometricGooT.)
Public methodDrawViewportMeshes
Public methodDrawViewportWires
Public methodDuplicate (Overrides GH_GeometricGooTDuplicate.)
Public methodDuplicateGeometry
Create a duplicate of this line.
(Overrides GH_GeometricGooTDuplicateGeometry.)
Public methodDuplicateLine
Create a duplicate of this line.
Public methodEmitProxy
Returns a proxy that represents this line. Do not call this function unless you're
(Overrides GH_GeometricGooTEmitProxy.)
Public methodGetBoundingBox (Overrides GH_GeometricGooTGetBoundingBox(Transform).)
Public methodLoadGeometry
If the geometry is referenced and currently unloaded, forces loading of the geometry. Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.)
Public methodLoadGeometry(RhinoDoc)
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 from GH_GeometricGooT.)
Public methodMorph (Overrides GH_GeometricGooTMorph(SpaceMorph).)
Public methodRead (Overrides GH_GooTRead(GH_IReader).)
Public methodScriptVariable
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 from GH_GooT.)
Public methodToString
Format the line using default grasshopper formatting logic.
(Overrides GH_GooTToString.)
Public methodTransform (Overrides GH_GeometricGooTTransform(Transform).)
Public methodWrite (Overrides GH_GooTWrite(GH_IWriter).)
Top
Fields
See Also