GH_InstanceReference

GH_GeometricGoo<1>GH_Goo<1>References

public class GH_InstanceReference : GH_GeometricGoo<InstanceReferenceGeometry>, IGH_GeometricGoo, IGH_BakeAwareData, IGH_PreviewData, IGH_PreviewMeshData, IGH_RenderAwareData

Represents block instance reference. Wraps the functionality of the InstanceReferenceGeometry type.

Constructors

GH_InstanceReference

public GH_InstanceReference()

Default constructor.

Remarks: Creates an invalid instance reference

GH_InstanceReference

public GH_InstanceReference(GH_InstanceReference other)

Create a duplicate of another instance reference.

Remarks: This constructor also copies reference data.

Parameters:

other (GH_InstanceReference)

instance reference to duplicate

GH_InstanceReference

public GH_InstanceReference(Guid ref_guid)

Create a new instance reference to a Rhino instance reference object with the specified ID.

Parameters:

ref_guid (Guid)

ID of instance reference object to reference.

GH_InstanceReference

public GH_InstanceReference(InstanceReferenceGeometry iref, ModelInstanceDefinition idef)

Create a new instance reference with the specified instance-reference-geometry and instance-definition.

Parameters:

iref (InstanceReferenceGeometry)	instance reference geometry to reference.
idef (ModelInstanceDefinition)	instance definition to reference.

GH_InstanceReference

public GH_InstanceReference(InstanceReferenceGeometry iref)

Create a new instance reference with the specified instance-reference-geometry.

Parameters:

iref (InstanceReferenceGeometry)

instance reference geometry to reference.

GH_InstanceReference

public GH_InstanceReference(Transform xform, ModelInstanceDefinition idef)

Create a transformed instance reference of the specified instance-definition.

Parameters:

xform (Transform)	instance reference to duplicate
idef (ModelInstanceDefinition)	instance definition object to reference.

GH_InstanceReference

public GH_InstanceReference(Transform xform)

Create a transformed empty instance reference.

Parameters:

xform (Transform)

instance reference to duplicate

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

InstanceDefinition

public ModelInstanceDefinition InstanceDefinition { get; set; }

IsGeometryLoaded

public override bool IsGeometryLoaded { get; }

Gets the load state of this instance reference object. The instance reference is considered to be loaded when the local instance is not null.

Overrides: GH_GeometricGoo<T>.IsGeometryLoaded

IsReferencedGeometry

public override bool IsReferencedGeometry { get; }

Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.

Overrides: GH_GeometricGoo<T>.IsReferencedGeometry

IsValid

public override bool IsValid { get; }

Gets the validity of this instance reference. If the instance reference is referenced but cannot be loaded, the instance reference 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

ModelTransform

public Transform ModelTransform { 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 T Value { get; set; }

Gets or sets the value of this type. Note that if the type has a ReferenceID this value might get destroyed in the future.

inherited fromGH_GeometricGoo<T>

Overrides: GH_Goo<T>.Value

Methods

Explicit

IGH_RenderAwareData.AppendRenderGeometry

void AppendRenderGeometry(GH_RenderArgs args, RenderMaterial material)

Parameters:

args (GH_RenderArgs)
material (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

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 instance reference is referenced, the local instance of the instance reference is erased.

Overrides: GH_GeometricGoo<T>.ClearCaches

Explicit

IGH_PreviewMeshData.DestroyPreviewMeshes

void DestroyPreviewMeshes()

Implements: DestroyPreviewMeshes

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

DuplicateGeometry

public override IGH_GeometricGoo DuplicateGeometry()

Create a duplicate of this GH_InstanceReference.

Overrides: GH_GeometricGoo<T>.DuplicateGeometry

DuplicateInstanceReference

public GH_InstanceReference DuplicateInstanceReference()

Create a duplicate of this GH_InstanceReference.

EmitProxy

public override IGH_GooProxy EmitProxy()

Overrides: GH_GeometricGoo<T>.EmitProxy

Implements: EmitProxy

GetBoundingBox

public override BoundingBox GetBoundingBox(Transform xform)

Parameters:

xform (Transform)

Overrides: GH_GeometricGoo<T>.GetBoundingBox

Explicit

IGH_PreviewMeshData.GetPreviewMeshes

Mesh[] GetPreviewMeshes()

Implements: GetPreviewMeshes

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 instance reference is referenced and not yet loaded, attempts to load the instance reference.

Parameters:

doc (RhinoDoc)

Returns: True if the instance reference 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 instance reference 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