Grasshopper API

GH_Surface Class

Represents a 3D (trimmed) surface. GH_Surface wraps the functionality of the OpenNURBS OnBrepFace class.

Inheritance Hierarchy

Namespace: Grasshopper.Kernel.Types
Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public class GH_Surface : GH_GeometricGoo<Brep>, 
	IGH_BakeAwareData, IGH_PreviewData, IGH_PreviewMeshData, IGH_RenderAwareData

Public Class GH_Surface
	Inherits GH_GeometricGoo(Of Brep)
	Implements IGH_BakeAwareData, IGH_PreviewData, IGH_PreviewMeshData, IGH_RenderAwareData

The GH_Surface type exposes the following members.

Constructors

	Name	Description
	GH_Surface	Initializes a new instance of the GH_Surface class
	GH_Surface(Brep)	Initializes a new instance of the GH_Surface class
	GH_Surface(Surface)	Initializes a new instance of the GH_Surface class
	GH_Surface(Guid)	Initializes a new instance of the GH_Surface class
	GH_Surface(GH_Surface)	Initializes a new instance of the GH_Surface class

Properties

	Name	Description
	Boundingbox	(Overrides GH_GeometricGooTBoundingbox.)
	ClippingBox
	Face
	IsGeometryLoaded	(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	(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	(Overrides GH_GeometricGooTValue.)

Methods

	Name	Description
	AppendRenderGeometry
	BakeGeometry
	CastFrom	(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)	(Overrides GH_GeometricGooTCastToQ(Q).)
	ClearCaches	(Overrides GH_GeometricGooTClearCaches.)
	DestroyPreviewMeshes
	DrawViewportMeshes
	DrawViewportWires
	Duplicate	(Overrides GH_GeometricGooTDuplicate.)
	DuplicateGeometry	(Overrides GH_GeometricGooTDuplicateGeometry.)
	DuplicateSurface
	EmitProxy	(Overrides GH_GeometricGooTEmitProxy.)
	GetBoundingBox	(Overrides GH_GeometricGooTGetBoundingBox(Transform).)
	GetPreviewMeshes
	IsPointOnDomain
	IsPointOnFace
	LoadGeometry	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.)
	LoadGeometry(RhinoDoc)	(Overrides GH_GeometricGooTLoadGeometry(RhinoDoc).)
	Morph	(Overrides GH_GeometricGooTMorph(SpaceMorph).)
	Read	(Overrides GH_GooTRead(GH_IReader).)
	ScriptVariable	(Overrides GH_GooTScriptVariable.)
	ToString	(Overrides GH_GooTToString.)
	Transform	(Overrides GH_GeometricGooTTransform(Transform).)
	Untrim
	Write	(Overrides GH_GooTWrite(GH_IWriter).)

Fields

	Name	Description
	m_value	(Inherited from GH_GooT.)