GH_DetailView

GH_GeometricGoo<1>GH_Goo<1>References
public class GH_DetailView : GH_GeometricGoo<DetailView>, IGH_GeometricGoo, IGH_PreviewData
Represents a Rhino model detail view. Wraps the functionality of the DetailView type.

Constructors

GH_DetailView

#
public GH_DetailView()
Default constructor, creates an invalid detail view.

GH_DetailView

#
public GH_DetailView(DetailView detailView)
Create a duplicate of an existing detail view.
Parameters:
detailView (DetailView)DetailView to duplicate

GH_DetailView

#
public GH_DetailView(GH_DetailView other)
Create a duplicate of another GH_DetailView. This constructor also copies reference data.
Parameters:
other (GH_DetailView)Detail View to duplicate

GH_DetailView

#
public GH_DetailView(Guid ref_guid)
Create a new referenced detail view that references a Rhino detail view with the specified ID.
Parameters:
ref_guid (Guid)ID of detail view object to reference.

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 detail view object. The detail view is considered to be loaded when the local detail view 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 detail view. If the detail view is referenced but cannot be loaded, the detail view 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

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 DetailView Value { get; set; }
Overrides: GH_GeometricGoo<T>.Value

Viewport

#
public ModelDetailViewport Viewport { get; set; }

Methods

CastFrom

public override bool CastFrom(object source)
Attempt a cast from generic object.
inherited fromGH_GeometricGoo<T>
Remarks: If False, the contents of this instance are not to be trusted.
Parameters:
source (object)Reference to source of cast.
Returns: True on success, false on failure.
Overrides: GH_Goo<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()
Clears all volatile caches for this instance. The boundingbox is cleared, and if the detail view is referenced, the local instance of the detail view 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

DuplicateDetailView

#
public GH_DetailView DuplicateDetailView()
Create a duplicate of this hatch.

DuplicateGeometry

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

EmitProxy

public override IGH_GooProxy EmitProxy()
Create a new proxy for this instance. Return Null if this class does not support proxies.
inherited fromGH_GeometricGoo<T>
Overrides: GH_Goo<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 detail view is referenced and not yet loaded, attempts to load the detail view.
Parameters:
doc (RhinoDoc)
Returns: True if the detail view 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 detail view 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