ObjRef

Public Class

Represents a reference to a Rhino object.

Inheritance Hierarchy

System.Object
Rhino.DocObjects.ObjRef

Namespace: Rhino.DocObjects

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class ObjRef : IDisposable

The ObjRef type exposes the following members.

Constructors

Name

Description

---

Public Method

ObjRef(Guid)

Obsolete.

Initializes a new object reference from a globally unique identifier (Guid).

---

Public Method

ObjRef(ObjRef)

Copy constructor

---

Public Method

ObjRef(RhinoObject)

Initializes a new object reference from a Rhino object.

---

Public Method

ObjRef(Guid, ComponentIndex)

Obsolete.

Initializes a new object reference from a guid and component index. The component index is used to specify a “piece” of the geometry

---

Public Method

ObjRef(RhinoDoc, Guid)

Initializes a new object reference from a globally unique identifier (Guid).

---

Public Method

ObjRef(RhinoObject, PickContext)

Initialized a new object reference from a Rhino object and pick context

---

Public Method

ObjRef(RhinoDoc, Guid, ComponentIndex)

Initializes a new object reference from a guid and component index. The component index is used to specify a “piece” of the geometry

---

Properties

Name

Description

---

Public Property

Document

Gets the document that owns this object reference.

---

Public Property

GeometryComponentIndex

Gets the component index of the referenced (sub) geometry. Some objects have sub-objects that are valid pieces of geometry. For example, breps have edges and faces that are valid curves and surfaces. Each sub-object has a component index that is > 0. The parent geometry has a component index = -1.

---

Public Property

ObjectId

Returns the id of the referenced Rhino object.

---

Public Property

RuntimeSerialNumber

If > 0, then this is the value of a Rhino object’s serial number field. The serial number is used instead of the pointer to prevent crashes in cases when the RhinoObject is deleted but an ObjRef continues to reference the Rhino object. The value of RuntimeSerialNumber is not saved in archives because it generally changes if you save and reload an archive.

---

Methods

Name

Description

---

Public Method
Code Example

Brep

Gets the brep if this reference geometry is one.

---

Public Method

ClippingPlaneSurface

Gets the clipping plane surface if this reference targeted one.

---

Public Method
Code Example

Curve

Gets the curve if this reference targeted one.

---

Public Method
Code Example
CurveParameter

If the reference geometry is a curve or edge with a selection point, then this gets the parameter of the selection point.

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

---

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

---

Public Method

Edge

Gets the edge if this reference geometry is one.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Public Method

Face

If the referenced geometry is a brep face, a brep with one face, or a surface, this returns the brep face.

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Overrides Object.Finalize..)

---

Public Method

Geometry

Gets the geometry linked to the object targeted by this reference.

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

Hatch

Gets the hatch if the referenced geometry is one.

---

Public Method

InstanceDefinitionPart

If sub-object selection is enabled and a piece of an instance reference is selected, this will return the selected piece.

---

Public Method

Light

Gets the light if the referenced geometry is one.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

Mesh

Gets the mesh if the referenced geometry is one.

---

Public Method
Code Example

Object

Returns the referenced Rhino object.

---

Public Method

Point

Gets the point if the referenced geometry is one.

---

Public Method

PointCloud

Gets the point cloud if the referenced geometry is one.

---

Public Method

SelectionMethod

Gets the method used to select this object.

---

Public Method
Code Example

SelectionPoint

If the object was selected by picking a point on it, then SelectionPoint() returns the point where the selection occurred, otherwise it returns Point3d.Unset.

---

Public Method

SelectionView

If the object was interactively selected in a particular viewport, then SelectionView() returns the view where the object was selected.

---

Public Method

SelectionViewDetailSerialNumber

If the object was interactively selected in a page space detail view, then SelectionViewDetailSerialNumber() returns the CRhinoObject serial number of the detail view object. Use SelectionView() to get the page view that contains the detail view object. If SelectionViewDetailSerialNumber() returns 0, then the selection did not happen in a detail view.

---

Public Method

SetSelectionComponent

When an object is selected by picking a sub-object, SetSelectionComponent may be used to identify the sub-object.

---

Public Method

SubD

Gets the SubD if the referenced geometry is one.

---

Public Method

SubDFace

Gets the SubDFace if the referenced geometry is one.

---

Public Method
Code Example

Surface

Gets the surface if the referenced geometry is one.

---

Public Method

SurfaceParameter

If the reference geometry is a surface, brep with one face, or surface edge with a selection point, then this gets the surface parameters of the selection point.

---

Public Method

TextDot

Gets the text dot if the referenced geometry is one.

---

Public Method

TextEntity

Gets the text entity if the referenced geometry is one.

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

Trim

If the referenced geometry is an edge of a surface, this returns the associated brep trim.

---