GH_Plane Class |
Namespace: Grasshopper.Kernel.Types
The GH_Plane type exposes the following members.
| Name | Description | |
|---|---|---|
| GH_Plane |
Default constructor. Creates a world XY plane.
| |
| GH_Plane(GH_Plane) |
Create a duplicate of another plane.
| |
| GH_Plane(Guid) | Initializes a new instance of the GH_Plane class | |
| GH_Plane(Plane) |
Create a duplicate of another plane.
|
| Name | Description | |
|---|---|---|
| Boundingbox | (Overrides GH_GeometricGooTBoundingbox.) | |
| ClippingBox | ||
| IsGeometryLoaded |
Gets the load state of this plane. The plane is considered to be loaded when it is valid.
(Overrides GH_GeometricGooTIsGeometryLoaded.) | |
| IsReferencedGeometry |
Gets a value indicating whether or not this geometry is referenced.
Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.) | |
| IsValid |
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.) | |
| IsValidWhyNot |
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.) | |
| ReferenceID | (Overrides GH_GeometricGooTReferenceID.) | |
| TypeDescription | (Overrides GH_GooTTypeDescription.) | |
| TypeName | (Overrides GH_GooTTypeName.) | |
| Value |
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.) |
| Name | Description | |
|---|---|---|
| BakeGeometry | ||
| CastFrom |
Remote to Local caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastFrom(Object).) | |
| CastToQ(Q) |
Attempt a cast to type T.
(Inherited from GH_GeometricGooT.) | |
| CastToQ(Q) |
Attempt a cast to type Q.
(Inherited from GH_GooT.) | |
| CastToT(T) |
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastToQ(Q).) | |
| 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 from GH_GeometricGooT.) | |
| DrawPlane(DisplayPipeline, Plane) |
Draw a plane with default colours and default size.
| |
| DrawPlane(DisplayPipeline, Plane, Double, Int32) | ||
| DrawPlane(DisplayPipeline, Plane, Double, Int32, Color, Color, Color) | ||
| DrawPlane(DisplayPipeline, Plane, Double, Int32, Color, Color, Color, Color) | ||
| DrawPlaneIcon | ||
| DrawViewportMeshes | ||
| DrawViewportWires | ||
| Duplicate | (Overrides GH_GeometricGooTDuplicate.) | |
| DuplicateGeometry |
Create a duplicate of this plane.
(Overrides GH_GeometricGooTDuplicateGeometry.) | |
| DuplicatePlane |
Create a duplicate of this plane.
| |
| EmitProxy |
Returns a proxy that represents this plane. Do not call this function unless you're
(Overrides GH_GeometricGooTEmitProxy.) | |
| GetBoundingBox | (Overrides GH_GeometricGooTGetBoundingBox(Transform).) | |
| LoadGeometry |
If the geometry is referenced and not yet loaded, attempts to load the geometry.
(Overrides GH_GeometricGooTLoadGeometry.) | |
| LoadGeometry(RhinoDoc) | (Overrides GH_GeometricGooTLoadGeometry(RhinoDoc).) | |
| Morph | (Overrides GH_GeometricGooTMorph(SpaceMorph).) | |
| Read | (Overrides GH_GooTRead(GH_IReader).) | |
| 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 from GH_GooT.) | |
| ToString |
Format the plane using default grasshopper formatting logic.
(Overrides GH_GooTToString.) | |
| Transform | (Overrides GH_GeometricGooTTransform(Transform).) | |
| Write | (Overrides GH_GooTWrite(GH_IWriter).) |