GH_Box

GH_GeometricGoo<1>GH_Goo<1>References

public class GH_Box : GH_GeometricGoo<Box>, IGH_BakeAwareData, IGH_PreviewData, IGH_RenderAwareData

Represents a 3D oriented Box volume.

Constructors

GH_Box

public GH_Box()

GH_Box

public GH_Box(BoundingBox box)

Parameters:

box (BoundingBox)

GH_Box

public GH_Box(Box box)

Parameters:

box (Box)

GH_Box

public GH_Box(GH_Box other)

Parameters:

other (GH_Box)

GH_Box

public GH_Box(Guid id)

Parameters:

id (Guid)

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; }

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; }

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 Box Value { get; set; }

Overrides: GH_GeometricGoo<T>.Value

Methods

AppendRenderGeometry

public void AppendRenderGeometry(GH_RenderArgs args, RenderMaterial materialHint)

Parameters:

args (GH_RenderArgs)
materialHint (RenderMaterial)

Implements: AppendRenderGeometry

BakeGeometry

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

Parameters:

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

Implements: BakeGeometry

Brep

public Brep Brep()

Differs from Rhino.Geometry.Brep.FromBox() because it Handles degenerate cases.

CastFrom

public override bool CastFrom(object source)

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)

Parameters:

target (ref T)

Overrides: GH_GeometricGoo<T>.CastTo

ClearCaches

public override void ClearCaches()

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

DuplicateBox

public GH_Box DuplicateBox()

DuplicateGeometry

public override IGH_GeometricGoo DuplicateGeometry()

Overrides: GH_GeometricGoo<T>.DuplicateGeometry

EmitProxy

public override IGH_GooProxy EmitProxy()

Overrides: GH_GeometricGoo<T>.EmitProxy

Geometry

public bool Geometry(ref Brep brp, ref Curve crv, ref Point pt)

Convert the box to a GeometryBase instance.

Parameters:

brp (ref Brep)	If the box is at most degenerate in one direction, the brp parameter will be filled out.
crv (ref Curve)	If the box is degenerate in exactly two directions, the crv parameter will be filled out.
pt (ref Point)	If the box is degenerate in all three directions, the pt parameter will be filled out.

Returns: True on success, false on failure.

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 override bool LoadGeometry(RhinoDoc doc)

Parameters:

doc (RhinoDoc)

Overrides: GH_GeometricGoo<T>.LoadGeometry

Mesh

public Mesh Mesh()

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

ToString

public override string ToString()

Overrides: GH_Goo<T>.ToString

Transform

public override IGH_GeometricGoo Transform(Transform xform)

Parameters:

xform (Transform)

Overrides: GH_GeometricGoo<T>.Transform

Write

public override bool Write(GH_IWriter writer)

Parameters:

writer (GH_IWriter)

Overrides: GH_Goo<T>.Write