Represents a simple object table for a file that is open externally.

This class mimics Rhino.DocObjects.Tables.ObjectTable while providing external access to the file.

Properties

ComponentType

#Since v6.0
public override ModelComponentType ComponentType { get; }

Count

#Since v5.0
Returns the total amount of items in the object table, including lights.
public override int Count { get; }

Methods

Add

#Since v6.0
Duplicates the object, then adds a copy of the object to the document.
public Guid Add(
item,
The item to duplicate and add.
attributes
The attributes to link with geometry.
)

Add

#Since v6.0
Duplicates the object, then adds a copy of the object to the document.
public override void Add(
item
The item to duplicate and add.
)

AddAngularDimension

#Since v6.5
Adds a angular dimension object to the 3dm file object table.
public Guid AddAngularDimension(
dimension,
Dimension object to add.
attributes
Attributes to apply to dimension.
)
A unique identifier for the object.

AddAngularDimension

#Since v6.5
Adds a angular dimension object to the 3dm file object table.
public Guid AddAngularDimension(
dimension
Dimension object to add.
)
A unique identifier for the object.

AddArc

#Since v5.0
Adds a curve object to the document representing an arc.
public Guid AddArc(
arc,
An arc to add.
attributes
attributes to apply to arc.
)
A unique identifier for the object.

AddArc

#Since v5.0
Adds a curve object to the document representing an arc.
public Guid AddArc(
arc
An arc.
)
A unique identifier for the object.

AddBrep

#Since v5.0
Adds a brep object to Rhino.
public Guid AddBrep(
brep,
A duplicate of this brep is added to Rhino.
attributes
Attributes to apply to brep.
)
A unique identifier for the object.

AddBrep

#Since v5.0
Adds a brep object to Rhino.
public Guid AddBrep(
brep
A duplicate of this brep is added to Rhino.
)
A unique identifier for the object.

AddCircle

#Since v5.0
Adds a curve object to the document representing a circle.
public Guid AddCircle(
circle,
A circle to add.
attributes
attributes to apply to circle.
)
A unique identifier for the object.

AddCircle

#Since v5.0
Adds a curve object to the document representing a circle.
public Guid AddCircle(
circle
A circle to add.
)
A unique identifier for the object.

AddClippingPlane

#ExampleSince v5.0
Adds a clipping plane object to Rhino.
public Guid AddClippingPlane(
plane,
A plane.
uMagnitude,
The size in U direction.
vMagnitude,
The size in V direction.
clippedViewportId
The viewport id that the new clipping plane will clip.
)
A unique identifier for the object.

AddClippingPlane

#Since v5.0
Adds a clipping plane object to Rhino.
public Guid AddClippingPlane(
plane,
A plane.
uMagnitude,
The size in U direction.
vMagnitude,
The size in V direction.
clippedViewportIds,
list of viewport ids that the new clipping plane will clip.
attributes
Attributes to apply to point cloud.
)
A unique identifier for the object.

AddClippingPlane

#Since v5.0
Adds a clipping plane object to Rhino.
public Guid AddClippingPlane(
plane,
A plane.
uMagnitude,
The size in U direction.
vMagnitude,
The size in V direction.
clippedViewportIds
A list, an array or any enumerable of viewport ids that the new clipping plane will clip.
)
A unique identifier for the object.

AddCurve

#Since v5.0
Adds a curve object to the table.
public Guid AddCurve(
curve,
A duplicate of this curve is added to Rhino.
attributes
Attributes to apply to curve.
)
A unique identifier for the object.

AddCurve

#Since v5.0
Adds a curve object to the table.
public Guid AddCurve(
curve
A curve to add.
)
A unique identifier for the object.

AddEllipse

#Since v5.0
Adds a curve object to the document representing an ellipse.
public Guid AddEllipse(
ellipse,
An ellipse to add.
attributes
attributes to apply to ellipse.
)
A unique identifier for the object.

AddEllipse

#Since v5.0
Adds a curve object to the document representing an ellipse.
public Guid AddEllipse(
ellipse
An ellipse to add.
)
A unique identifier for the object.

AddExtrusion

#Since v5.0
Adds an extrusion object to Rhino.
public Guid AddExtrusion(
extrusion,
A duplicate of this extrusion is added to Rhino.
attributes
Attributes to link to the object.
)
A unique identifier for the object.

AddExtrusion

#Since v5.0
Adds an extrusion object to Rhino.
public Guid AddExtrusion(
extrusion
A duplicate of this extrusion is added to Rhino.
)
A unique identifier for the object.

AddHatch

#Since v5.0
Adds a hatch to the document.
public Guid AddHatch(
hatch,
A hatch.
attributes
Attributes to apply
)
A unique identifier for the hatch, or Guid.Empty on failure.

AddHatch

#Since v5.0
Adds a hatch to the document.
public Guid AddHatch(
hatch
A hatch.
)
A unique identifier for the hatch, or Guid.Empty on failure.

AddInstanceObject

#Since v6.5
Adds an instance reference geometry object to the table.
public Guid AddInstanceObject(
instanceReference,
The instance reference geometry object.
attributes
The attributes to link with the object.
)
A unique identifier for the object.

AddInstanceObject

#Since v6.5
Adds an instance reference geometry object to the table.
public Guid AddInstanceObject(
instanceReference
The instance reference geometry object.
)
A unique identifier for the object.

AddInstanceObject

#Since v6.5
Adds an instance reference geometry object to the table.
public Guid AddInstanceObject(
instanceDefinitionIndex,
The index of the instance definition geometry object.
instanceXform,
The transformation.
attributes
The object attributes.
)
A unique identifier for the object.

AddInstanceObject

#Since v6.5
Adds an instance reference geometry object to the table.
public Guid AddInstanceObject(
instanceDefinitionIndex,
The index of the instance definition geometry object.
instanceXform
The transformation.
)
A unique identifier for the object.

AddLeader

#Since v5.0
Adds an annotation leader to the document. This overload is only provided in the Rhino SDK.
public Guid AddLeader(
points
A list, an array or any enumerable set of 2d points.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLeader

#Since v5.0
Adds an annotation leader to the document.
public Guid AddLeader(
plane,
A plane.
points,
A list, an array or any enumerable set of 2d points.
attributes
Attributes to apply to brep.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLeader

#Since v5.0
Adds an annotation leader to the document.
public Guid AddLeader(
plane,
A plane.
points
A list, an array or any enumerable set of 2d points.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLeader

#Since v5.0
Adds an annotation leader to the document. This overload is only provided in the Rhino SDK.
public Guid AddLeader(
text,
The text.
points
A list, an array or any enumerable set of 2d points.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLeader

#Since v5.0
Adds an annotation leader to the document.
public Guid AddLeader(
text,
The text.
plane,
A plane.
points,
A list, an array or any enumerable set of 2d points.
attributes
Attributes to apply to brep.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLeader

#Since v5.0
Adds an annotation leader to the document.
public Guid AddLeader(
text,
The text.
plane,
A plane.
points
A list, an array or any enumerable set of 2d points.
)
A unique identifier for the object; or Guid.Empty on failure.

AddLine

#Since v5.0
Adds a line object to Rhino.
public Guid AddLine(
line,
A line.
attributes
Attributes to apply to line.
)
A unique identifier for the object.

AddLine

#Since v5.0
Adds a line object to Rhino.
public Guid AddLine(
line
)
A unique identifier for the object.

AddLine

#Since v5.0
Adds a line object to Rhino.
public Guid AddLine(
from,
The start point of the line.
to,
The end point of the line.
attributes
Attributes to apply to line.
)
A unique identifier for the object.

AddLine

#Since v5.0
Adds a line object to Rhino.
public Guid AddLine(
from,
A line start point.
to
A line end point.
)
A unique identifier of new rhino object.

AddLinearDimension

#Since v5.0
Adds a linear dimension to the 3dm file object table.
public Guid AddLinearDimension(
dimension,
A dimension.
attributes
Attributes to apply to dimension.
)
A unique identifier for the object.

AddLinearDimension

#Since v5.0
Adds a linear dimension to the 3dm file object table.
public Guid AddLinearDimension(
dimension
A dimension.
)
A unique identifier for the object.

AddMesh

#Since v5.0
Adds a mesh object to Rhino.
public Guid AddMesh(
Mesh
mesh,
A duplicate of this mesh is added to Rhino.
attributes
Attributes to link to the object.
)
A unique identifier for the object.

AddMesh

#Since v5.0
Adds a mesh object to Rhino.
public Guid AddMesh(
Mesh
mesh
A duplicate of this mesh is added to Rhino.
)
A unique identifier for the object.

AddOrdinateDimension

#Since v7.32
Adds an ordinate dimension object to the 3dm file object table.
public Guid AddOrdinateDimension(
dimension,
Dimension object to add.
attributes
Attributes to apply to dimension.
)
A unique identifier for the object.

AddOrdinateDimension

#Since v7.32
Adds an ordinate dimension object to the 3dm file object table.
public Guid AddOrdinateDimension(
dimension
Dimension object to add.
)
A unique identifier for the object.

AddPoint

#Since v5.0
Adds a point object to the table.
public Guid AddPoint(
x,
X component of point coordinate.
y,
Y component of point coordinate.
z
Z component of point coordinate.
)
id of new object.

AddPoint

#Since v5.0
Adds a point object to the document.
public Guid AddPoint(
point,
A location for point.
attributes
attributes to apply to point.
)
A unique identifier for the object.

AddPoint

#Since v5.0
Adds a point object to the table.
public Guid AddPoint(
point
A location for point.
)
Id of new object.

AddPoint

#Since v5.0
Adds a point object to the document.
public Guid AddPoint(
point,
location of point.
attributes
attributes to apply to point.
)
A unique identifier for the object.

AddPoint

#Since v5.0
Adds a point object to the document.
public Guid AddPoint(
point
location of point.
)
A unique identifier for the object.

AddPointCloud

#Since v5.0
Adds a point cloud object to the document.
public Guid AddPointCloud(
points,
A list, an array or any enumerable set of Point3d.
attributes
Attributes to apply to point cloud.
)
A unique identifier for the object.

AddPointCloud

#Since v5.0
Adds a point cloud object to the document.
public Guid AddPointCloud(
points
A list, an array or any enumerable set of Point3d.
)
A unique identifier for the object.

AddPointCloud

#Since v5.0
Adds a point cloud object to the document.
public Guid AddPointCloud(
cloud,
PointCloud to add.
attributes
attributes to apply to point cloud.
)
A unique identifier for the object.

AddPointCloud

#Since v5.0
Adds a point cloud object to the document.
public Guid AddPointCloud(
cloud
PointCloud to add.
)
A unique identifier for the object.

AddPoints

#Since v5.0
Adds multiple points to the document.
public Guid[] AddPoints(
points,
Points to add.
attributes
Attributes to apply to point objects.
)
An array of object unique identifiers.

AddPoints

#Since v5.0
Adds multiple points to the document.
public Guid[] AddPoints(
points
Points to add.
)
List of object ids.

AddPoints

#Since v5.0
Adds multiple points to the document.
public Guid[] AddPoints(
points,
Points to add.
attributes
Attributes to apply to point objects.
)
An array of object unique identifiers.

AddPoints

#Since v5.0
Adds multiple points to the document.
public Guid[] AddPoints(
points
Points to add.
)
An array of object unique identifiers.

AddPolyline

#Since v5.0
Adds a polyline object to Rhino.
public Guid AddPolyline(
points,
A list, an array or any enumerable set of Point3d.
attributes
Attributes to apply to line.
)
A unique identifier for the object.

AddPolyline

#Since v5.0
Adds a polyline object to Rhino.
public Guid AddPolyline(
points
A list, an array or any enumerable set of Point3d.
)
A unique identifier for the object.

AddRadialDimension

#Since v7.32
Adds a radial dimension object to the 3dm file object table.
public Guid AddRadialDimension(
dimension,
Dimension object to add.
attributes
Attributes to apply to dimension.
)
A unique identifier for the object.

AddRadialDimension

#Since v7.32
Adds a radial dimension object to the 3dm file object table.
public Guid AddRadialDimension(
dimension
Dimension object to add.
)
A unique identifier for the object.

AddSphere

#Since v5.0
Adds a surface object to the document representing a sphere.
public Guid AddSphere(
sphere,
A sphere to add.
attributes
Attributes to link with the sphere.
)
A unique identifier for the object.

AddSphere

#Since v5.0
Adds a surface object to the document representing a sphere.
public Guid AddSphere(
sphere
A sphere to add.
)
A unique identifier for the object.

AddSubD

#Since v7.1
Adds a SubD to the document
public Guid AddSubD(
subd,
the Subd to add
attributes
Attributes to apply
)
A unique identifier for the SubD, or Guid.Empty on failure

AddSubD

#Since v7.1
Adds a SubD to the document
public Guid AddSubD(
subd
the Subd to add
)
A unique identifier for the SubD, or Guid.Empty on failure

AddSurface

#Since v5.0
Adds a surface object to Rhino.
public Guid AddSurface(
surface,
A duplicate of this surface is added to Rhino.
attributes
Attributes to link to the object.
)
A unique identifier for the object.

AddSurface

#Since v5.0
Adds a surface object to Rhino.
public Guid AddSurface(
surface
A duplicate of this surface is added to Rhino.
)
A unique identifier for the object.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text,
Text string.
plane,
Plane of text.
height,
Height of text.
fontName,
Name of FontFace.
bold,
Bold flag.
italic,
Italic flag.
attributes
Object Attributes.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text,
Text string.
plane,
Plane of text.
height,
Height of text.
fontName,
Name of FontFace.
bold,
Bold flag.
italic,
Italic flag.
justification,
The justification of the text.
attributes
Attributes to link to the object.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text,
Text string.
plane,
Plane of text.
height,
Height of text.
fontName,
Name of FontFace.
bold,
Bold flag.
italic,
Italic flag.
justification
The justification of the text.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text,
Text string.
plane,
Plane of text.
height,
Height of text.
fontName,
Name of FontFace.
bold,
Bold flag.
italic
Italic flag.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text3d,
The text object to add.
attributes
Attributes to link to the object.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds an annotation text object to the document.
public Guid AddText(
text3d
The text object to add.
)
The Guid of the newly added object or Guid.Empty on failure.

AddTextDot

#Since v5.0
Adds a text dot object to the table.
public Guid AddTextDot(
text,
The text.
location,
The location.
attributes
Attributes to link with curve.
)
A unique identifier for the object.

AddTextDot

#Since v5.0
Adds a text dot object to the table.
public Guid AddTextDot(
text,
The text.
location
The location.
)
A unique identifier for the object.

AddTextDot

#Since v5.0
Adds a text dot object to the table.
public Guid AddTextDot(
dot,
The text dot.
attributes
Attributes to link with text dot.
)
A unique identifier for the object.

AddTextDot

#Since v5.0
Adds a text dot object to the table.
public Guid AddTextDot(
dot
The text dot.
)
A unique identifier for the object.

Clear

Marks all items as deleted.
public void Clear()
inherited fromCommonComponentTable<T>

Delete

#Since v5.2
Deletes object from document.
public bool Delete(
objectId
Id of the object to delete.
)
true on success, false on failure.

Delete

Flags a component as deleted.
public override bool Delete(
T
item
The item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Delete

#Since v5.2
Deletes a collection of objects from the document.
public int Delete(
objectIds
Ids of all objects to delete.
)
The number of successfully deleted objects.

Delete

Flags a component as deleted.
public virtual void Delete(
index
The index of the item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Dump

Prepares a text dump of object table.
public string Dump()
inherited fromFile3dmCommonComponentTable<T>
A string containing the dump.

FindByGroup

#Since v6.20
Finds all File3dmObject that are in a given group.
public File3dmObject[] FindByGroup(
group
A group instance.
)
Array of objects that belong to the specified group or empty array if no objects could be found.
ArgumentNullExceptionIf group is null.

FindByLayer

#Since v6.0
Finds all File3dmObject that are in a given layer.
public File3dmObject[] FindByLayer(
layer
A layer instance.
)
Array of objects that belong to the specified layer or empty array if no objects could be found.
ArgumentNullExceptionIf layer is null.

FindByLayer

#Since v5.0
Finds all File3dmObject that are in a given layer.
public File3dmObject[] FindByLayer(
layer
Layer to search.
)
Array of objects that belong to the specified layer or empty array if no objects could be found.

FindId

Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
public virtual T FindId(
id
ID of model component to search for.
)
inherited fromCommonComponentTable<T>
Reference to the rhino object with the objectId or null if no such object could be found.
FindId

GetBoundingBox

#Since v5.0
Gets the bounding box containing every object in this table.
public BoundingBox GetBoundingBox()
The computed bounding box.

GetEnumerator

#Since v5.0
Returns an enumerator that yields all objects in this document. Like in Rhino, this includes lights. Unlike in Rhino, however, all lights are returned in the end of the list.
public override IEnumerator<File3dmObject> GetEnumerator()
An enumerator that yields all objects in a document.