GH_ClippingPlane

GH_GeometricGoo<1>GH_Goo<1>References
public class GH_ClippingPlane : GH_GeometricGoo<ClippingPlaneSurface>, IGH_BakeAwareData, IGH_PreviewData, IGH_GeometricGoo
Represents an implementation of a Rhino clipping plane.

Constructors

GH_ClippingPlane

#
public GH_ClippingPlane()
Default constructor, creates an invalid clipping plane.

GH_ClippingPlane

#
public GH_ClippingPlane(ClippingPlaneSurface clippingPlane)
Create a duplicate of an existing clipping plane.
Parameters:
clippingPlane (ClippingPlaneSurface)clipping plane to duplicate

GH_ClippingPlane

#
public GH_ClippingPlane(GH_ClippingPlane other)
Create a duplicate of another GH_ClippingPlane. This constructor also copies reference data.
Parameters:
other (GH_ClippingPlane)Clipping plane to duplicate

GH_ClippingPlane

#
public GH_ClippingPlane(Guid ref_guid)
Create a new referenced clipping plane that references a clipping plane in a Rhino document with a specified ID.
Parameters:
ref_guid (Guid)ID of clipping plane to reference.

Fields

m_value

protected T m_value
inherited fromGH_Goo<T>

Properties

AnnotationStyle

#
public ModelAnnotationStyle AnnotationStyle { get; set; }

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 clipping plane. The clipping plane is considered to be loaded when the local clipping plane instance is not null.
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 this clipping plane. If the clipping plane is referenced but cannot be loaded, the clipping plane is not valid.
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

LabelStyle

#
public SectionLabelStyle LabelStyle { get; set; }

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 ClippingPlaneSurface Value { get; set; }
Overrides: GH_GeometricGoo<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 override void 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_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

DuplicateClippingPlane

#
public GH_ClippingPlane DuplicateClippingPlane()
Create a duplicate of this clipping plane.

DuplicateGeometry

#
public override IGH_GeometricGoo DuplicateGeometry()
Create a duplicate of this clipping plane.
Overrides: GH_GeometricGoo<T>.DuplicateGeometry

EmitProxy

#
public override IGH_GooProxy EmitProxy()
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)
If the clipping plane is referenced and not yet loaded, attempts to load the clipping plane.
Parameters:
doc (RhinoDoc)
Returns: True if the clipping plane is loaded (or if it was already loaded), False on failure.
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 override object ScriptVariable()
Overrides: GH_Goo<T>.ScriptVariable

ToString

#
public override string ToString()
Format the clipping plane using default grasshopper formatting logic.
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