GH_ClippingPlane Class |
Represents an implementation of a Rhino clipping plane.
Inheritance HierarchySystemObject
Grasshopper.Kernel.TypesGH_GooClippingPlaneSurface
Grasshopper.Kernel.TypesGH_GeometricGooClippingPlaneSurface
Grasshopper.Kernel.TypesGH_ClippingPlane
Grasshopper.Kernel.TypesGH_GooClippingPlaneSurface
Grasshopper.Kernel.TypesGH_GeometricGooClippingPlaneSurface
Grasshopper.Kernel.TypesGH_ClippingPlane
Namespace: Grasshopper.Kernel.Types
Assembly: Grasshopper (in Grasshopper.dll)
SyntaxThe GH_ClippingPlane type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GH_ClippingPlane |
Default constructor, creates an invalid clipping plane.
|
| GH_ClippingPlane(ClippingPlaneSurface) |
Create a duplicate of an existing clipping plane.
|
| GH_ClippingPlane(GH_ClippingPlane) |
Create a duplicate of another GH_ClippingPlane. This constructor also copies reference data.
|
| GH_ClippingPlane(Guid) |
Create a new referenced clipping plane that references a clipping plane in a Rhino document with a specified ID.
|
Properties| Name | Description | |
|---|---|---|
 | AnnotationStyle | |
| Boundingbox | (Overrides GH_GeometricGooTBoundingbox.) |
| ClippingBox | |
| IsGeometryLoaded |
Gets the load state of this clipping plane. The clipping plane is considered to be loaded when the local clipping plane instance is not null.
(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 this clipping plane. If the clipping plane is referenced but cannot be loaded, the clipping plane is not valid.
(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.) |
| LabelStyle | |
| ReferenceID | (Overrides GH_GeometricGooTReferenceID.) |
| TypeDescription | (Overrides GH_GooTTypeDescription.) |
| TypeName | (Overrides GH_GooTTypeName.) |
| Value | (Overrides GH_GeometricGooTValue.) |
Methods| Name | Description | |
|---|---|---|
| BakeGeometry | |
| CastFrom |
Remote to Local caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastFrom(Object).) |
| CastToT(T) |
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastToQ(Q).) |
| CastToQ(Q) |
Attempt a cast to type T.
(Inherited from GH_GeometricGooT.) |
| CastToQ(Q) |
Attempt a cast to type Q.
(Inherited from GH_GooT.) |
| ClearCaches |
Clears all volatile caches for this instance. The boundingbox is cleared, and if the clipping plane is referenced,
the local instance of the clipping plane is erased.
(Overrides GH_GeometricGooTClearCaches.) |
| DrawViewportMeshes | |
| DrawViewportWires | |
| Duplicate | (Overrides GH_GeometricGooTDuplicate.) |
| DuplicateClippingPlane |
Create a duplicate of this clipping plane.
|
| DuplicateGeometry |
Create a duplicate of this clipping plane.
(Overrides GH_GeometricGooTDuplicateGeometry.) |
| EmitProxy | (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) |
If the clipping plane is referenced and not yet loaded, attempts to load the clipping plane.
(Overrides GH_GeometricGooTLoadGeometry(RhinoDoc).) |
| Morph | (Overrides GH_GeometricGooTMorph(SpaceMorph).) |
| Read | (Overrides GH_GooTRead(GH_IReader).) |
| ScriptVariable | (Overrides GH_GooTScriptVariable.) |
| ToString |
Format the clipping plane using default grasshopper formatting logic.
(Overrides GH_GooTToString.) |
| Transform | (Overrides GH_GeometricGooTTransform(Transform).) |
| Write | (Overrides GH_GooTWrite(GH_IWriter).) |
Fields
See Also