GH_Plane

GH_GeometricGoo<1>GH_Goo<1>References

public class GH_Plane : GH_GeometricGoo<Plane>, IGH_BakeAwareData, IGH_PreviewData, IGH_GeometricGoo

Represents a 3D plane. GH_Plane re-implements the OpenNURBS OnPlane class.

Constructors

GH_Plane

public GH_Plane()

Default constructor. Creates a world XY plane.

GH_Plane

public GH_Plane(GH_Plane other)

Create a duplicate of another plane.

Parameters:

other (GH_Plane)

Plane to copy. If null, a default plane will be created.

GH_Plane

public GH_Plane(Guid id)

Parameters:

id (Guid)

GH_Plane

public GH_Plane(Plane plane)

Create a duplicate of another plane.

Parameters:

plane (Plane)

Plane to set.

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 override bool IsGeometryLoaded { get; }

Gets the load state of this plane. The plane is considered to be loaded when it is valid.

Overrides: GH_GeometricGoo<T>.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 the plane. If the plane is invalid, attempts are made to fix the data. If the plane remains invalid, False is returned.

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 override Guid ReferenceID { get; set; }

Overrides: GH_GeometricGoo<T>.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

DrawPlane

public static void DrawPlane(DisplayPipeline display, Plane plane, double size, int frequency, Color grid_color, Color x_color, Color y_color, Color back_color)

Parameters:

display (DisplayPipeline)
plane (Plane)
size (double)
frequency (int)
grid_color (Color)
x_color (Color)
y_color (Color)
back_color (Color)

DrawPlane

public static void DrawPlane(DisplayPipeline display, Plane plane, double size, int frequency, Color grid_color, Color x_color, Color y_color, Color z_color, Color back_color)

Parameters:

display (DisplayPipeline)
plane (Plane)
size (double)
frequency (int)
grid_color (Color)
x_color (Color)
y_color (Color)
z_color (Color)
back_color (Color)

DrawPlane

public static void DrawPlane(DisplayPipeline display, Plane plane, double size, int frequency, Color grid_color, Color x_color, Color y_color)

Parameters:

display (DisplayPipeline)
plane (Plane)
size (double)
frequency (int)
grid_color (Color)
x_color (Color)
y_color (Color)

DrawPlane

public static void DrawPlane(DisplayPipeline display, Plane plane, double size, int frequency)

Parameters:

display (DisplayPipeline)
plane (Plane)
size (double)
frequency (int)

DrawPlane

public static void DrawPlane(DisplayPipeline display, Plane plane)

Draw a plane with default colours and default size.

Parameters:

display (DisplayPipeline)
plane (Plane)

DrawPlaneIcon

public static void DrawPlaneIcon(DisplayPipeline display, Plane plane, double size, Color edgeColour, Color fillColour)

Parameters:

display (DisplayPipeline)
plane (Plane)
size (double)
edgeColour (Color)
fillColour (Color)

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 plane.

Overrides: GH_GeometricGoo<T>.DuplicateGeometry

DuplicatePlane

public GH_Plane DuplicatePlane()

Create a duplicate of this plane.

EmitProxy

public override IGH_GooProxy EmitProxy()

Returns a proxy that represents this plane. 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 override bool LoadGeometry()

If the geometry is referenced and not yet loaded, attempts to load the geometry.

Returns: True if the geometry is loaded (or if it was already loaded), False on failure.

Overrides: GH_GeometricGoo<T>.LoadGeometry

LoadGeometry

public override bool LoadGeometry(RhinoDoc doc)

Parameters:

doc (RhinoDoc)

Overrides: GH_GeometricGoo<T>.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