Click or drag to resize

GH_Plane Class

Represents a 3D plane. GH_Plane re-implements the OpenNURBS OnPlane class.
Inheritance Hierarchy
SystemObject
  Grasshopper.Kernel.TypesGH_GooPlane
    Grasshopper.Kernel.TypesGH_GeometricGooPlane
      Grasshopper.Kernel.TypesGH_Plane

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

The GH_Plane type exposes the following members.

Constructors
  NameDescription
Public methodGH_Plane
Default constructor. Creates a world XY plane.
Public methodGH_Plane(GH_Plane)
Create a duplicate of another plane.
Public methodGH_Plane(Guid)
Initializes a new instance of the GH_Plane class
Public methodGH_Plane(Plane)
Create a duplicate of another plane.
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 the plane. If the plane is invalid, attempts are made to fix the data. If the plane remains invalid, False is returned.
(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 (Overrides GH_GeometricGooTReferenceID.)
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 methodStatic memberDrawPlane(DisplayPipeline, Plane)
Draw a plane with default colours and default size.
Public methodStatic memberDrawPlane(DisplayPipeline, Plane, Double, Int32)
Public methodStatic memberDrawPlane(DisplayPipeline, Plane, Double, Int32, Color, Color, Color)
Public methodStatic memberDrawPlane(DisplayPipeline, Plane, Double, Int32, Color, Color, Color, Color)
Public methodStatic memberDrawPlaneIcon
Public methodDrawViewportMeshes
Public methodDrawViewportWires
Public methodDuplicate (Overrides GH_GeometricGooTDuplicate.)
Public methodDuplicateGeometry
Create a duplicate of this plane.
(Overrides GH_GeometricGooTDuplicateGeometry.)
Public methodDuplicatePlane
Create a duplicate of this plane.
Public methodEmitProxy
Returns a proxy that represents this plane. 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) (Overrides GH_GeometricGooTLoadGeometry(RhinoDoc).)
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 plane 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