Properties

BoundingBox

#Since v5.0
Gets the bounding box for all objects (normal, locked and hidden) in this document that exist in "model" space. This bounding box does not include objects that exist in layout space.
public BoundingBox BoundingBox { get; }

BoundingBoxVisible

#Since v5.0
Gets the bounding box for all visible objects (normal and locked) in this document that exist in "model" space. This bounding box does not include hidden objects or any objects that exist in layout space.
public BoundingBox BoundingBoxVisible { get; }

ComponentType

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

Count

Returns the count of all items, including deleted ones.
public virtual int Count { get; }
inherited fromCommonComponentTable<T>

Document

#Since v5.0
Gets the document that owns this object table.
public RhinoDoc Document { get; }

HistoryRecordCount

#Since v6.0
Returns the amount of history records in this document.
public int HistoryRecordCount { get; }

Methods

Add

#Since v6.0
Adds geometry that is not further specified.

This is meant, for example, to handle addition of sets of different geometrical entities.

public Guid Add(
geometry,
The base geometry. This cannot be null.
attributes,
The object attributes. This can be null.
history,
The history information that will be saved.
reference
If reference is true, object will not be saved in the 3dm file.
)
The new object ID on success.
ArgumentNullExceptionIf geometry is null.

Add

#Since v5.0
Adds geometry that is not further specified.

This is meant, for example, to handle addition of sets of different geometrical entities.

public Guid Add(
geometry,
The base geometry. This cannot be null.
attributes
The object attributes. This can be null.
)
The new object ID on success.
ArgumentNullExceptionIf geometry is null.

Add

#Since v5.0
Adds geometry that is not further specified.

This is meant, for example, to handle addition of sets of different geometrical entities.

public Guid Add(
geometry
The base geometry. This cannot be null.
)
The new object ID on success.
ArgumentNullExceptionIf geometry is null.

AddAngularDimension

#Since v5.0
Adds an angular dimension object to the document.
public Guid AddAngularDimension(
dimension,
Dimension object to add.
attributes,
Attributes to apply to dimension.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddAngularDimension

#Since v5.0
Adds a angular dimension object to the document.
public Guid AddAngularDimension(
dimension,
Dimension object to add.
attributes
)
The Guid of the newly added object or Guid.Empty on failure.

AddAngularDimension

#Since v5.0
Adds a angular dimension object to the document.
public Guid AddAngularDimension(
dimension
Dimension object to add.
)
The Id of the newly added object or Guid.Empty on failure.

AddArc

#Since v5.0
public Guid AddArc(
arc,
attributes,
history,
reference
)

AddArc

#Since v5.0
Adds a curve object to the document representing an arc.
public Guid AddArc(
arc,
An arc value.
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 value.
)
A unique identifier for the object.

AddBox

#Since v6.0
Adds a box to the object table, as an extrusion.
public Guid AddBox(
box,
The box.
attributes,
Attributes that will be linked with the surface object.
history,
History data records.
reference
If a reference, object will not be saved in the document.
)
The ID.

AddBox

#Since v6.0
Adds a box to the object table.
public Guid AddBox(
box,
The box.
attributes
Attributes that will be linked with the surface object.
)
The ID.

AddBox

#Since v6.0
Adds a box to the object table.
public Guid AddBox(
box
The box.
)
The ID.

AddBrep

#Since v5.0
public Guid AddBrep(
brep,
attributes,
history,
reference,
splitKinkySurfaces
)

AddBrep

#Since v5.0
public Guid AddBrep(
brep,
attributes,
history,
reference
)

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

#ExampleSince 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.

AddCentermark

#Since v6.0
Adds an ordinate dimension object to the document.
public Guid AddCentermark(
centermark,
Dimension object to add.
attributes,
Attributes to apply to dimension.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddCircle

#Since v5.0
public Guid AddCircle(
circle,
attributes,
history,
reference
)

AddCircle

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

AddCircle

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

AddClippingPlane

#Since v5.0
public Guid AddClippingPlane(
plane,
uMagnitude,
vMagnitude,
clippedViewportId,
attributes,
history,
reference
)

AddClippingPlane

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

AddClippingPlane

#Since v5.0
public Guid AddClippingPlane(
plane,
uMagnitude,
vMagnitude,
clippedViewportIds,
attributes,
history,
reference
)

AddClippingPlane

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

AddClippingPlane

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

AddClippingPlaneSurface

#Since v8.11
public Guid AddClippingPlaneSurface(
clippingPlane,
attributes,
history,
reference
)

AddCurve

#Since v5.0
public Guid AddCurve(
curve,
attributes,
history,
reference
)

AddCurve

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

AddCurve

#ExampleSince v5.0
Adds a curve object to Rhino.
public Guid AddCurve(
curve
A curve. A duplicate of this curve is added to Rhino.
)
A unique identifier for the object.

AddEllipse

#Since v5.0
public Guid AddEllipse(
ellipse,
attributes,
history,
reference
)

AddEllipse

#Since v5.0
Adds a curve object to the document representing an ellipse.
public Guid AddEllipse(
ellipse,
An ellipse value.
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 value.
)
A unique identifier for the object.

AddExplodedInstancePieces

#Since v5.11
public Guid[] AddExplodedInstancePieces(
instance,
explodeNestedInstances = true,
deleteInstance = false
)

AddExtrusion

#Since v5.0
public Guid AddExtrusion(
extrusion,
attributes,
history,
reference
)

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 that will be linked with the extrusion 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
public Guid AddHatch(
hatch,
attributes,
history,
reference
)

AddHatch

#Since v5.0
public Guid AddHatch(
hatch,
attributes
)

AddHatch

#ExampleSince v5.0
public Guid AddHatch(
hatch
)

AddInstanceObject

#Since v6.24
Adds an instance object to the document.
public Guid AddInstanceObject(
instanceDefinitionIndex,
The index of the instance definition.
instanceXform,
The instance transformation.
attributes,
The attributes to apply to the instance object.
history,
The history record associated with this instance object.
reference
true if the object is from a reference file. Reference objects do not persist in archives.
)
A unique identifier for the object if successful. Guid.Empty it not successful.

AddInstanceObject

#Since v5.0
Adds an instance object to the document.
public Guid AddInstanceObject(
instanceDefinitionIndex,
The index of the instance definition.
instanceXform,
The instance transformation.
attributes
The attributes to apply to the instance object.
)
A unique identifier for the object if successful. Guid.Empty it not successful.

AddInstanceObject

#Since v5.0
Adds an instance object to the document.
public Guid AddInstanceObject(
instanceDefinitionIndex,
The index of the instance definition.
instanceXform
The instance transformation.
)
A unique identifier for the object if successful. Guid.Empty it not successful.

AddLeader

#Since v5.0
public Guid AddLeader()

AddLeader

#Since v6.0
Adds a Leader object to the document.
public Guid AddLeader(
leader,
The leader object.
attributes,
Attributes to apply to rich text.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddLeader

#Since v6.0
Adds Leader object to the document.
public Guid AddLeader(
leader,
The leader object.
attributes
Attributes to apply to rich text.
)
The Guid of the newly added object or Guid.Empty on failure.

AddLeader

#Since v6.0
Adds a Leader object to the document.
public Guid AddLeader(
leader
The leader object.
)
The Id of the newly added object or Guid.Empty on failure.

AddLeader

#Since v5.0
public Guid AddLeader(
plane,
points,
attributes
)

AddLeader

#ExampleSince v5.0
public Guid AddLeader(
plane,
points
)

AddLeader

#Since v5.0
public Guid AddLeader()

AddLeader

#Since v5.0
public Guid AddLeader(
text,
plane,
points,
attributes,
history,
reference
)

AddLeader

#Since v5.0
public Guid AddLeader(
text,
plane,
points,
attributes
)

AddLeader

#Since v5.0
public Guid AddLeader(
text,
plane,
points
)

AddLine

#Since v5.0
Adds a line object to Rhino.
public Guid AddLine(
line,
The line value.
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
public Guid AddLine(
from,
to,
attributes,
history,
reference
)

AddLine

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

AddLine

#ExampleSince v5.0
Adds a line object to Rhino.
public Guid AddLine(
from,
The line origin.
to
The line end.
)
A unique identifier for the object.

AddLinearDimension

#Since v5.0
Adds a linear dimension object to the document.
public Guid AddLinearDimension(
dimension,
Dimension object to add.
attributes,
Attributes to apply to dimension.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddLinearDimension

#Since v5.0
Adds a linear dimension object to the document.
public Guid AddLinearDimension(
dimension,
Dimension object to add.
attributes
)
The Guid of the newly added object or Guid.Empty on failure.

AddLinearDimension

#ExampleSince v5.0
Adds a linear dimension object to the document.
public Guid AddLinearDimension(
dimension
Dimension object to add.
)
The Id of the newly added object or Guid.Empty on failure.

AddMesh

#Since v6.0
public Guid AddMesh(
Mesh
mesh,
attributes,
history,
reference,
requireValidMesh
)

AddMesh

#Since v5.0
public Guid AddMesh(
Mesh
mesh,
attributes,
history,
reference
)

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 that will be linked with the mesh object.
)
A unique identifier for the object.

AddMesh

#ExampleSince 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.

AddMorphControl

#Since v6.0
public Guid AddMorphControl(
morphControl,
attributes,
history,
reference
)

AddMorphControl

#Since v5.0
public Guid AddMorphControl(
morphControl,
attributes
)

AddMorphControl

#Since v5.0
public Guid AddMorphControl(
morphControl
)

AddOrderedPointCloud

#Since v8.0
Adds a point cloud object to the document.
public Guid AddOrderedPointCloud(
xCt,
Number of points in X dir.
yCt,
Number of points in Y dir.
zCt,
Number of points in Z dir.
min,
point at x0,y0,z0 of bounding box of the pointcloud
max,
point at x1,y1,z1 of bounding box of the pointcloud
attributes,
Attributes to apply to point cloud. null is acceptable
history,
history associated with this point cloud. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
A unique identifier for the object.

AddOrderedPointCloud

#Since v8.0
Adds a point cloud object to the document.
public Guid AddOrderedPointCloud(
xCt,
Number of points in X dir.
yCt,
Number of points in Y dir.
zCt,
Number of points in Z dir.
box,
box to use for output, does not need to be a boundingbox. The function that takes to points assumes it's a bounding box.
attributes,
Attributes to apply to point cloud. null is acceptable
history,
history associated with this point cloud. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
A unique identifier for the object.

AddOrdinateDimension

#Since v6.0
Adds an ordinate dimension object to the document.
public Guid AddOrdinateDimension(
dimordinate,
Dimension object to add.
attributes,
Attributes to apply to dimension.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddPictureFrame

#Since v5.10
Creates a PictureFrame object from a plane and a path to an image file, Note, a PictureFrame object is just a Plane surface or mesh that has a material with a texture assigned to it that displays in all display modes.
public Guid AddPictureFrame(
plane,
Plane in which the PictureFrame will be created. Bottom left corner of picture will be at plane's origin, width will be in the plane's x axis direction, height will be in the plane's y axis direction.
texturePath,
path to an image file
asMesh,
If true, the function will make a MeshObject rather than a surface
width,
Width of the resulting PictureFrame. If 0.0, the width of the picture frame is the width of the image if height is also 0.0 or calculated from the height and aspect ratio of the image if height is not 0.0.
height,
Height of the resulting PictureFrame. If 0.0, the height of the picture frame is the height of the image if width is also 0.0 or calculated from the width and aspect ratio of the image if width is not 0.0.
selfIllumination,
If true, the image mapped to the picture frame plane always displays at full intensity and is not affected by light or shadow.
embedBitmap
If true, the function adds the image to the bitmap table of the document to which the PictureFrame will be added
)
A unique identifier for the object

AddPoint

#Since v5.0
Adds a point object to the document.
public Guid AddPoint(
x,
X component of point coordinate.
y,
Y component of point coordinate.
z
Z component of point coordinate.
)
A unique identifier for the object..

AddPoint

#Since v6.0
Adds a point object and its geometry-linked information to the document
public Guid AddPoint(
point,
A point geometry class.
attributes,
attributes to apply to point. null is acceptable
history,
history associated with this point. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
A unique identifier for the object.
ArgumentNullExceptionIf point is null.

AddPoint

#Since v5.0
Adds a point object to the document
public Guid AddPoint(
point,
location of point
attributes,
attributes to apply to point. null is acceptable
history,
history associated with this point. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
A unique identifier for the 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. null is acceptable
)
A unique identifier for the object.

AddPoint

#ExampleSince v5.0
Adds a point object to the document.
public Guid AddPoint(
point
location of 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.
attributes
attributes to apply to point.
)
A unique identifier for the object.

AddPoint

#ExampleSince 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 points
attributes,
Attributes to apply to point cloud. null is acceptable
history,
history associated with this point cloud. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
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 points.
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 points.
)
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. null is acceptable
history,
history associated with this point cloud. null is acceptable
reference
true if the object is from a reference file. Reference objects do not persist in archives
)
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 RhinoList<Guid> AddPoints(
points,
Points to add.
attributes
Attributes to apply to point objects.
)
List of object ids.

AddPoints

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

AddPoints

#Since v5.0
Adds multiple points to the document.
public RhinoList<Guid> AddPoints(
points,
Points to add.
attributes
Attributes to apply to point objects.
)
List of object ids.

AddPoints

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

AddPolyline

#Since v5.0
public Guid AddPolyline(
points,
attributes,
history,
reference
)

AddPolyline

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

AddPolyline

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

AddRadialDimension

#Since v5.0
Adds a radial dimension object to the document.
public Guid AddRadialDimension(
dimension,
Dimension object to add.
attributes,
Attributes to apply to dimension.
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Guid of the newly added object or Guid.Empty on failure.

AddRadialDimension

#Since v5.0
public Guid AddRadialDimension(
dimension,
attributes
)

AddRadialDimension

#ExampleSince v5.0
public Guid AddRadialDimension(
dimension
)

AddRectangle

#Since v6.0
Adds a rectangle to the object table.
public Guid AddRectangle(
rectangle,
The rectangle.
attributes,
Attributes that will be linked with the surface object.
history,
History data records.
reference
If a reference, object will not be saved in the document.
)
The ID.

AddRectangle

#Since v6.0
Adds a rectangle to the object table.
public Guid AddRectangle(
rectangle,
The rectangle.
attributes
Attributes that will be linked with the surface object.
)
The ID.

AddRectangle

#Since v6.0
Adds a rectangle to the object table.
public Guid AddRectangle(
rectangle
The rectangle.
)
The ID.

AddRhinoObject

#Since v5.0
public void AddRhinoObject(
brepObject,
brep
)

AddRhinoObject

#Since v5.0
public void AddRhinoObject(
curveObject,
curve
)

AddRhinoObject

#Since v6.1
public void AddRhinoObject(
brepObject,
history
)

AddRhinoObject

#Since v5.0
public void AddRhinoObject(
brepObject
)

AddRhinoObject

#Since v6.1
public void AddRhinoObject(
curveObject,
history
)

AddRhinoObject

#Since v6.1
public void AddRhinoObject(
meshObject,
history
)

AddRhinoObject

#Since v5.0
public void AddRhinoObject(
meshObject
)

AddRhinoObject

#Since v6.1
public void AddRhinoObject(
pointObject,
history
)

AddRhinoObject

#Since v5.6
public void AddRhinoObject(
pointObject
)

AddRhinoObject

#Since v5.0
public void AddRhinoObject(
meshObject,
Mesh
mesh
)

AddRhinoObject

#Since v5.6
public void AddRhinoObject(
pointObject,
point
)

AddSphere

#Since v5.0
public Guid AddSphere(
sphere,
attributes,
history,
reference
)

AddSphere

#Since v5.0
public Guid AddSphere(
sphere,
attributes
)

AddSphere

#ExampleSince v5.0
public Guid AddSphere(
sphere
)

AddSubD

#Since v7.0
Adds a SubD object to Rhino.
public Guid AddSubD(
subD,
A duplicate of this SubD is added to Rhino.
attributes,
Attributes that will be linked with the object.
history,
reference
)
A unique identifier for the object.

AddSubD

#Since v7.0
Adds a SubD object to Rhino.
public Guid AddSubD(
subD,
A duplicate of this SubD is added to Rhino.
attributes
Attributes that will be linked with the object.
)
A unique identifier for the object.

AddSubD

#Since v7.0
Adds a SubD object to Rhino.
public Guid AddSubD(
subD
A duplicate of this SubD is added to Rhino.
)
A unique identifier for the object.

AddSurface

#Since v5.0
public Guid AddSurface(
surface,
attributes,
history,
reference
)

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 that will be linked with the surface object.
)
A unique identifier for the object.

AddSurface

#ExampleSince 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
public Guid AddText(
text,
plane,
height,
fontName,
bold,
italic,
attributes,
history,
reference
)

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
Attributes that will be linked with the object.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
public Guid AddText(
text,
plane,
height,
fontName,
bold,
italic,
justification,
attributes,
history,
reference
)

AddText

#Since v5.0
public Guid AddText(
text,
plane,
height,
fontName,
bold,
italic,
justification,
attributes
)

AddText

#Since v5.0
public Guid AddText(
text,
plane,
height,
fontName,
bold,
italic,
justification
)

AddText

#ExampleSince 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
Object Attributes.
)
The Guid of the newly added object or Guid.Empty on failure.

AddText

#ExampleSince 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.

AddText

#Since v5.0
Adds a text object to the document.
public Guid AddText(
text,
Text object to add.
attributes,
history,
Object history to save.
reference
If reference, then object will not be saved into the 3dm file.
)
The Id of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds a text object to the document.
public Guid AddText(
text,
Text object to add.
attributes
)
The Id of the newly added object or Guid.Empty on failure.

AddText

#Since v5.0
Adds a v6_TextObject to the document.
public Guid AddText(
text
Text object to add.
)
The Id of the newly added object or Guid.Empty on failure.

AddTextDot

#Since v5.0
Adds a text dot object to Rhino.
public Guid AddTextDot(
text,
A text string.
location,
A point position.
attributes
Attributes to apply to curve.
)
The Guid of the newly added object or Guid.Empty on failure.

AddTextDot

#Since v5.0
Adds a text dot object to Rhino.
public Guid AddTextDot(
text,
A text string.
location
A point position.
)
A unique identifier for the object.

AddTextDot

#Since v5.0
public Guid AddTextDot(
dot,
attributes,
history,
reference
)

AddTextDot

#Since v5.0
Adds a text dot object to Rhino.
public Guid AddTextDot(
dot,
A text dot that will be copied.
attributes
Attributes to apply to text dot.
)
The Guid of the newly added object or Guid.Empty on failure.

AddTextDot

#Since v5.0
Adds a text dot object to Rhino.
public Guid AddTextDot(
dot
A text dot that will be copied.
)
A unique identifier for the object.

AllObjectsSince

#Since v5.0
Gets all the objects that have been added to the document since a given runtime serial number.
[CLSCompliant(false)] public RhinoObject[] AllObjectsSince(
runtimeSerialNumber
Runtime serial number of the last object not to include in the list.
)
An array of objects or null if no objects were added since the given runtime serial number.

AnySelectedObjects

#Since v9.0
Fast existence test for the current selection, with a reference breakdown, that does NOT materialize the selected objects. This is equivalent to testing whether FindByFilter(ObjectEnumeratorSettings) with NormalObjects, ActiveObjects, ReferenceObjects, IncludeLights and SelectedObjectsFilter would return any objects (and whether any of them are reference objects / reference blocks), but it uses the fast selection iterator and stops at the first match instead of building a RhinoObject[] of the entire selection. Intended for selection-change UI guards (e.g. the Layers panel).
public bool AnySelectedObjects(
out bool
referenceObjectSelected,
Set to true if any selected object is a reference object.
out bool
referenceBlockSelected
Set to true if any selected reference object is a block (instance reference).
)
true if any object is selected.

Clear

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

Delete

#Since v5.0
Deletes object from document. The deletion can be undone by calling UndeleteObject().
public bool Delete(
objectId,
Id of the object to delete.
quiet
If false, a message box will appear when an object cannot be deleted.
)
true on success, false on failure.

Delete

#Since v6.0
Deletes objref.Object(). The deletion can be undone by calling UndeleteObject().
public bool Delete(
objref,
objref.Object() will be deleted.
quiet,
If false, a message box will appear when an object cannot be deleted.
ignoreModes
If true, locked and hidden objects are deleted. If false objects that are locked, hidden, or on locked or hidden layers are not deleted.
)
true on success, false on failure.

Delete

#Since v5.0
Deletes objref.Object(). The deletion can be undone by calling UndeleteObject().
public bool Delete(
objref,
objref.Object() will be deleted.
quiet
If false, a message box will appear when an object cannot be deleted.
)
true on success, false on failure.

Delete

#Since v6.0
Deletes an object, taking into account modes and not showing error message boxes.
public override bool Delete(
item
The object to delete.
)
True on success.

Delete

#Since v6.0
Deletes object from document. The deletion can be undone by calling UndeleteObject().
public bool Delete(
obj,
The object to delete.
quiet,
If false, a message box will appear when an object cannot be deleted.
ignoreModes
If true, locked and hidden objects are deleted. If false objects that are locked, hidden, or on locked or hidden layers are not deleted.
)
true on success, false on failure.

Delete

#Since v5.0
Deletes object from document. The deletion can be undone by calling UndeleteObject().
public bool Delete(
obj,
The object to delete.
quiet
If false, a message box will appear when an object cannot be deleted.
)
true on success, false on failure.

Delete

#Since v5.0
Deletes a collection of objects from the document.
public int Delete(
objectIds,
Ids of all objects to delete.
quiet
If false, a message box will appear when an object cannot be deleted.
)
The number of successfully deleted objects.

DeleteGrip

#Since v6.5
Deletes a grip object.
public bool DeleteGrip(
grip
The grip object to delete.
)
True on success.

DeleteGrip

#Since v6.5
Deletes a grip object.
public bool DeleteGrip(
gripId
The id of the grip object to delete.
)
True on success.

DeleteGrip

#Since v6.5
Deletes a grip object.
public bool DeleteGrip(
gripRef
A reference to the grip object to delete.
)
True on success.

DeleteGrips

#Since v6.5
Deletes one or more grip objects.
public int DeleteGrips(
grips
The grip objects to delete.
)
The number of successfully deleted grip objects.

DeleteGrips

#Since v6.5
Deletes one or more grip objects.
public int DeleteGrips(
gripIds
The ids of the grip objects to delete.
)
The number of successfully deleted grip objects.

DeleteGrips

#Since v6.5
Deletes one or more grip objects.
public int DeleteGrips(
gripRefs
References to the grip objects to delete.
)
The number of successfully deleted grip objects.

DeleteGrips

#Since v6.5
Deletes one or more grip objects.
public int DeleteGrips(
owner,
The owner of the grip objects.
gripIndices
The indices of the grip objects to delete.
)
The number of successfully deleted grip objects.

Duplicate

#Since v5.0
Same as TransformObject(objref, ON_Xform.Identity, false)
public Guid Duplicate(
objectId
An ID to an object in the document that needs to be duplicated.
)
The new object ID.

Duplicate

#Since v5.0
Duplicates the object that is referenced by objref.

Same as Transform(objref, Transform.Identity, false)

public Guid Duplicate(
objref
A Rhino object reference to follow for object duplication.
)
The new object ID.

Duplicate

#Since v5.0
Duplicates the object that is referenced by obj.

Same as TransformObject(obj, Transform.Identityy, false)

public Guid Duplicate(
obj
A Rhino object to duplicate.
)
The new object ID.

Find

#Since v5.0
Please use FindId().
[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public RhinoObject Find(
objectId
Do not use this method.
)
Do not use this method.

Find

#Since v5.0
Use the object runtime serial number to find a rhino object in the document. This is the value stored on RhinoObject.RuntimeObjectSerialNumber. The RhinoObject constructor sets the runtime serial number and every instance of a RhinoObject class will have a unique serial number for the duration of the Rhino application. If an object is replaced with a new object, then the new object will have a different runtime serial number. Deleted objects stored in the undo list maintain their runtime serial numbers and this function will return pointers to these objects. Call RhinoObject.IsDeleted if you need to determine if the returned object is active or deleted. The runtime serial number is not saved in files.
[CLSCompliant(false)] public RhinoObject Find(
runtimeSerialNumber
Runtime serial number to search for.
)
Reference to the rhino object with the objectId or null if no such object could be found.

FindByCrossingWindowRegion

#Since v5.7
Finds objects bounded by a polyline region
[CLSCompliant(false)] public RhinoObject[] FindByCrossingWindowRegion(
viewport,
viewport to use for selection
region,
list of points that define the
inside,
should objects returned be the ones inside of this region (or outside)
ObjectType
filter
filter down list by object type
)
An array of RhinoObjects that are inside of this region

FindByCrossingWindowRegion

#Since v5.8
Finds objects bounded by a region
[CLSCompliant(false)] public RhinoObject[] FindByCrossingWindowRegion(
viewport,
viewport to use for selection
screen1,
first screen corner
screen2,
second screen corner
inside,
should objects returned be the ones inside of this region (or outside)
ObjectType
filter
filter down list by object type
)
An array of RhinoObjects that are inside of this region

FindByDrawColor

#Since v5.0
Finds all objects whose draw color matches a given color.
public RhinoObject[] FindByDrawColor(
drawColor,
The alpha value of this color is ignored.
includeLights
true if lights should be included.
)
An array of Rhino document objects. This array can be empty.

FindByFilter

#Since v5.0
Same as GetObjectList but converts the result to an array.
public RhinoObject[] FindByFilter(
filter
The ObjectEnumeratorSettings filter to customize inclusion requirements.
)
A Rhino object array. This array can be empty but not null.

FindByGroup

#Since v5.0
Finds all RhinoObjects that are in a given group.
public RhinoObject[] FindByGroup(
groupIndex
Index of group to search for.
)
An array of objects that belong to the specified group or null if no objects could be found.

FindByLayer

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

FindByLayer

#ExampleSince v5.0
Finds all RhinoObjects that are in a given layer.
public RhinoObject[] FindByLayer(
layerName
Name of layer to search.
)
Array of objects that belong to the specified group or null if no objects could be found.

FindByObjectType

#Since v5.0
[CLSCompliant(false)] public RhinoObject[] FindByObjectType(
ObjectType
typeFilter
)

FindByUserString

#Since v5.0
Finds all objects whose UserString matches the search patterns.
public RhinoObject[] FindByUserString(
key,
Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters).
value,
Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters).
caseSensitive,
If true, string comparison will be case sensitive.
searchGeometry,
If true, UserStrings attached to the geometry of an object will be searched.
searchAttributes,
If true, UserStrings attached to the attributes of an object will be searched.
filter
ObjectEnumeratorSettings filter used to restrict the number of objects searched.
)
An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.

FindByUserString

#Since v5.0
Finds all objects whose UserString matches the search patterns.
[CLSCompliant(false)] public RhinoObject[] FindByUserString(
key,
Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters).
value,
Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters).
caseSensitive,
If true, string comparison will be case sensitive.
searchGeometry,
If true, UserStrings attached to the geometry of an object will be searched.
searchAttributes,
If true, UserStrings attached to the attributes of an object will be searched.
ObjectType
filter
Object type filter.
)
An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.

FindByUserString

#Since v5.0
Finds all objects whose UserString matches the search patterns.
public RhinoObject[] FindByUserString(
key,
Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters).
value,
Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters).
caseSensitive
If true, string comparison will be case sensitive.
)
An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.

FindByWindowRegion

#Since v5.7
Finds objects bounded by a polyline region
[CLSCompliant(false)] public RhinoObject[] FindByWindowRegion(
viewport,
viewport to use for selection
region,
list of points that define the
inside,
should objects returned be the ones inside of this region (or outside)
ObjectType
filter
filter down list by object type
)
An array of RhinoObjects that are inside of this region

FindByWindowRegion

#Since v5.8
Finds objects bounded by a polyline region
[CLSCompliant(false)] public RhinoObject[] FindByWindowRegion(
viewport,
viewport to use for selection
screen1,
first screen corner
screen2,
second screen corner
inside,
should objects returned be the ones inside of this region (or outside)
ObjectType
filter
filter down list by object type
)
An array of RhinoObjects that are inside of this region

FindClippingPlanesForViewport

#Since v8.35
Finds all of the clipping plane objects that actively clip a viewport.
public ClippingPlaneObject[] FindClippingPlanesForViewport(
viewport,
The viewport in which clipping planes are searched.
includeHidden
When true, clipping planes that are hidden, or that are on hidden layers, are included in the results. Such planes still clip geometry in the viewport, so pass true when you need the complete set of planes affecting what is displayed.
)
An array of clipping plane objects. The array can be empty but not null.

FindClippingPlanesForViewport

#Since v5.0
Finds all of the visible clipping plane objects that actively clip a viewport.
public ClippingPlaneObject[] FindClippingPlanesForViewport(
viewport
The viewport in which clipping planes are searched.
)
Remarks: Hidden clipping planes, and clipping planes on hidden layers, are not included in the results even though they continue to clip geometry in the viewport. Call FindClippingPlanesForViewport(RhinoViewport, bool) with includeHidden set to true to get every plane that clips the viewport.
An array of clipping plane objects. The array can be empty but not null.

FindGeometry

#Since v6.0
Same as FindId, but returns the Geometry property directly, if it exists.
public GeometryBase FindGeometry(
id
ID of object to search for.
)
Reference to the geometry in the rhino object with the objectId or null if no such object could be found.

FindId

#Since v6.0

Uses the object guid to find a rhino object. Deleted objects cannot be found by id. The guid is the value that is stored on RhinoObject.Id

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 it's 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 override RhinoObject FindId(
id
ID of object to search for.
)
Reference to the rhino object with the objectId or null if no such object could be found.

GetEnumerator

#Since v5.0
public override IEnumerator<RhinoObject> GetEnumerator()

GetObjectIdList

#Since v8.25
Returns an enumerable based on a ObjectEnumeratorSettings filter.
public IEnumerable<Guid> GetObjectIdList()
The enumerable.

GetObjectList

#
Returns an enumerable based on a ObjectEnumeratorSettings filter.
public IEnumerable<RhinoObject> GetObjectList()
The enumerable.

GetObjectList

#Since v5.0
[CLSCompliant(false)] public IEnumerable<RhinoObject> GetObjectList(
ObjectType
typeFilter
)

GetObjectList

#ExampleSince v5.0
public IEnumerable<RhinoObject> GetObjectList(
typeFilter
)

GetObjectsByType<T>

#Since v6.0
Returns Rhino object by type.
public IEnumerable<T> GetObjectsByType<T>()
The enumerable.

GetObjectsByType<T>

#Since v6.0
Returns Rhino object by type.
public IEnumerable<T> GetObjectsByType<T>()
The enumerable.

GetSelectedObjectCount

#Since v8.10
Compute the current number of selected objects
[CLSCompliant(false)] public uint GetSelectedObjectCount(
checkSubObjects
Check to see if subobjects are selected
)

GetSelectedObjects

#Since v5.0
public IEnumerable<RhinoObject> GetSelectedObjects(
includeLights,
includeGrips
)

GetSelectedObjectTypes

#Since v6.0
What geometry types are currently selected
[CLSCompliant(false)] public ObjectType GetSelectedObjectTypes()

GripUpdate

#Since v5.0
Altered grip positions on a RhinoObject are used to calculate an updated object that is added to the document.
public RhinoObject GripUpdate(
obj,
object with modified grips to update.
deleteOriginal
if true, obj is deleted from the document.
)
new RhinoObject on success; otherwise null.

Hide

#Since v8.32
public bool Hide(
objectId,
ignoreLayerMode,
hideGroup
)

Hide

#Since v5.0
If Object().IsNormal() is true, then the object will be hidden.
public bool Hide(
objectId,
Id of object to hide.
ignoreLayerMode
if true, the object will be hidden even if it is on a layer that is locked or off.
)
true if the object was successfully hidden.

Hide

#Since v8.0
Hides object that is referenced by objref and optionally assigns it to a hide group. If objref.Object().IsNormal() is true, then the object will be hidden.
public bool Hide(
objref,
reference to object to hide.
ignoreLayerMode,
if true, the object will be hidden even if it is on a layer that is locked or off.
hideGroup
name of the hide group to attach to the hidden object. If null or empty, no hide group is assigned.
)
true if the object was successfully hidden.

Hide

#Since v5.0
If objref.Object().IsNormal() is true, then the object will be hidden.
public bool Hide(
objref,
reference to object to hide.
ignoreLayerMode
if true, the object will be hidden even if it is on a layer that is locked or off.
)
true if the object was successfully hidden.

Hide

#Since v8.32
public bool Hide(
obj,
ignoreLayerMode,
hideGroup
)

Hide

#Since v5.0
If obj.IsNormal() is true, then the object will be hidden.
public bool Hide(
obj,
object to hide.
ignoreLayerMode
if true, the object will be hidden even if it is on a layer that is locked or off.
)
true if the object was successfully hidden.

InvalidateBoundingBox

#Since v8.8
Destroys the cached scene bounding box so that it will be regenerated again from scratch next time the view is regenerated
public void InvalidateBoundingBox()

Lock

#Since v5.0
If objref.Object().IsNormal() is true, then the object will be locked.
public bool Lock(
objectId,
Id of normal object to lock.
ignoreLayerMode
if true, the object will be locked even if it is on a layer that is locked or off.
)
true if the object was successfully locked.

Lock

#Since v5.0
If objref.Object().IsNormal() is true, then the object will be locked.
public bool Lock(
objref,
reference to normal object to lock.
ignoreLayerMode
if true, the object will be locked even if it is on a layer that is locked or off.
)
true if the object was successfully locked.

Lock

#Since v5.0
If obj.IsNormal() is true, then the object will be locked.
public bool Lock(
obj,
normal object to lock.
ignoreLayerMode
if true, the object will be locked even if it is on a layer that is locked or off.
)
true if the object was successfully locked.

ModifyAttributes

#Since v5.0
Modifies an object's attributes. Cannot be used to change object id.
public bool ModifyAttributes(
objectId,
Id of object to modify.
newAttributes,
new attributes.
quiet
if true, then warning message boxes are disabled.
)
true if successful.

ModifyAttributes

#Since v5.0
Modifies an object's attributes. Cannot be used to change object id.
public bool ModifyAttributes(
objref,
reference to object to modify.
newAttributes,
new attributes.
quiet
if true, then warning message boxes are disabled.
)
true if successful.

ModifyAttributes

#Since v5.0
Modifies an object's attributes. Cannot be used to change object id.
public bool ModifyAttributes(
obj,
object to modify.
newAttributes,
new attributes.
quiet
if true, then warning message boxes are disabled.
)
true if successful.

ModifyRenderMaterial

#Since v5.7
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
public bool ModifyRenderMaterial(
objectId,
Id of object to modify.
material
Material to assign to this object.
)
Returns true on success otherwise returns false.

ModifyRenderMaterial

#Since v5.7
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
public bool ModifyRenderMaterial(
objRef,
Object to modify.
material
Material to assign to this object.
)
Returns true on success otherwise returns false.

ModifyRenderMaterial

#Since v5.7
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
public bool ModifyRenderMaterial(
obj,
Object to modify.
material
Material to assign to this object.
)
Returns true on success otherwise returns false.

ModifyTextureMapping

#Since v5.7
public bool ModifyTextureMapping(
objId,
channel,
mapping
)

ModifyTextureMapping

#Since v5.7
public bool ModifyTextureMapping(
objRef,
channel,
mapping
)

ModifyTextureMapping

#Since v5.7
public bool ModifyTextureMapping(
obj,
channel,
mapping
)

MostRecentObject

#Since v5.0
Gets the most recently added object that is still in the Document.
public RhinoObject MostRecentObject()
The most recent (non-deleted) object in the document, or null if no such object exists.

ObjectCount

#
Returns the number objects that pass a filter.
public int ObjectCount()
The number of objects that pass the filter.

PickObjects

#Since v6.0
Pick one or more objects based on a given pick context
public ObjRef[] PickObjects(
pickContext
settings used to define what is picked
)
zero or more objects

Purge

#Since v5.0
Removes object from document and deletes the pointer. Typically you will want to call Delete instead in order to keep the object on the undo list.
public bool Purge(
rhinoObject
A Rhino object that will be deleted.
)
true if the object was purged; otherwise false.

Purge

#Since v5.0
Removes object from document and deletes the pointer. Typically you will want to call Delete instead in order to keep the object on the undo list.
[CLSCompliant(false)] public bool Purge(
runtimeSerialNumber
A runtime serial number of the object that will be deleted.
)
true if the object was purged; otherwise false.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objectId,
Id of object to be replaced.
arc
new arc to be added. The arc is copied.
)
true if successful.

Replace

#Since v6.1
public bool Replace(
objectId,
brep,
splitKinkySurfaces
)

Replace

#Since v5.0
Replaces one object with new brep object.
public bool Replace(
objectId,
Id of object to be replaced.
brep
new surface to be added A duplicate of the brep is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objectId,
Id of object to be replaced.
circle
new circle to be added. The circle is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objectId,
Id of object to be replaced.
curve
New curve to be added. A duplicate of the curve is added to the Rhino model.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new extrusion object.
public bool Replace(
objectId,
Id of object to be replaced.
extrusion
New extrusion to be added. A duplicate of the extrusion is added to the Rhino model.
)
true if successful.

Replace

#Since v7.9
Replaces the geometry in one object.
public bool Replace(
objectId,
Id of object to be replaced.
geometry,
ignoreModes
)
true if successful.

Replace

#Since v6.1
Replaces one object with new hatch object.
public bool Replace(
objectId,
Id of object to be replaced.
hatch
new hatch to be added. The hatch is copied.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new text object.
public bool Replace(
objectId,
Id of object to be replaced.
leader
new leader to be added. The leader is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new line curve object.
public bool Replace(
objectId,
Id of object to be replaced.
line
new line to be added. The line is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new mesh object.
public bool Replace(
objectId,
Id of object to be replaced.
Mesh
mesh
new mesh to be added A duplicate of the mesh is added to the Rhino model.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new point object.
public bool Replace(
objectId,
Id of object to be replaced.
point
new point to be added. The point is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new point object.
public bool Replace(
objectId,
Id of object to be replaced.
point
new point to be added. The point is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new point cloud object.
public bool Replace(
objectId,
Id of object to be replaced.
pointcloud
new point cloud to be added A duplicate of the point cloud is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objectId,
Id of object to be replaced.
polyline
new polyline to be added. The polyline is copied.
)
true if successful.

Replace

#Since v7.0
Replaces one object with new subd object.
public bool Replace(
objectId,
Id of object to be replaced.
subD
new mesh to be added A duplicate of the mesh is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new surface object.
public bool Replace(
objectId,
Id of object to be replaced.
surface
new surface to be added A duplicate of the surface is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new text dot object.
public bool Replace(
objectId,
Id of object to be replaced.
dot
new text dot to be added. The text dot is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new text object.
public bool Replace(
objectId,
Id of object to be replaced.
text
new text to be added. The text is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
arc
new arc to be added. The arc is copied.
)
true if successful.

Replace

#Since v6.1
public bool Replace(
objref,
brep,
splitKinkySurfaces
)

Replace

#Since v5.0
Replaces one object with new brep object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
brep
new brep to be added A duplicate of the brep is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
circle
new circle to be added. The circle is copied.
)
true if successful.

Replace

#ExampleSince v5.0
Replaces one object with new curve object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
curve
New curve to be added. A duplicate of the curve is added to the Rhino model.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new extrusion object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
extrusion
New extrusion to be added. A duplicate of the extrusion is added to the Rhino model.
)
true if successful.

Replace

#Since v7.9
Replaces the geometry in one object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
geometry,
ignoreModes
)
true if successful.

Replace

#Since v6.1
Replaces one object with new hatch object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
hatch
new hatch to be added. The hatch is copied.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new text object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
leader
new leader to be added. The leader is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new line curve object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
line
new line to be added. The line is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new mesh object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
Mesh
mesh
new mesh to be added A duplicate of the mesh is added to the Rhino model.
)
true if successful.

Replace

#Since v6.0
Replaces one object with new point object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
point
new point to be added. The point is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new point object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
point
new point to be added. The point is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new point cloud object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
pointcloud
new point cloud to be added A duplicate of the point cloud is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new curve object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
polyline
new polyline to be added. The polyline is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with another. Conceptually, this function is the same as calling Setting new_object attributes = old_object attributes DeleteObject(old_object); AddObject(old_object);
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
newObject
new replacement object - must not be in document.
)
true if successful.

Replace

#Since v7.0
Replaces one object with a new SubD object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
subD
new SubD to be added A duplicate of the SubD is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new surface object.
public bool Replace(
objref,
reference to old object to be replaced. The objref.Object() will be deleted.
surface
new surface to be added A duplicate of the surface is added to the Rhino model.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new text dot object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
dot
new text dot to be added. The text dot is copied.
)
true if successful.

Replace

#Since v5.0
Replaces one object with new text object.
public bool Replace(
objref,
Reference to old object to be replaced. The object objref.Object() will be deleted.
text
new text to be added. The text is copied.
)
true if successful.

ReplaceInstanceObject

#Since v6.8
Replaces the underlying instance definition of an instance object.
public bool ReplaceInstanceObject(
objectId,
Id of the instance object to be replaced.
instanceDefinitionIndex
The index of the new instance definition to use.
)
true if successful.

ReplaceInstanceObject

#Since v6.8
Replaces the underlying instance definition of an instance object.
public bool ReplaceInstanceObject(
objref,
Reference to the instance object to be replaced. The objref.Object() will be deleted.
instanceDefinitionIndex
The index of the new instance definition to use.
)
true if successful.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objectId,
Id of object to select.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect,
Objects that are persistently selected stay selected when a command terminates.
ignoreGripsState,
If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.
ignoreLayerLocking,
If true, then objects on locked layers can be selected.
ignoreLayerVisibility
If true, then objects on hidden layers can be selectable.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objectId,
Id of object to select.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect
Objects that are persistently selected stay selected when a command terminates.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objectId,
Id of object to select.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objectId,
Id of object to select.
select
If true, the object will be selected, if false, it will be deselected.
)
true on success, false on failure.

Select

#ExampleSince v5.0
Select a single object.
public bool Select(
objectId
Id of object to select.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objref,
Object represented by this ObjRef is selected.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect,
Objects that are persistently selected stay selected when a command terminates.
ignoreGripsState,
If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.
ignoreLayerLocking,
If true, then objects on locked layers can be selected.
ignoreLayerVisibility
If true, then objects on hidden layers can be selectable.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objref,
Object represented by this ObjRef is selected.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect
Objects that are persistently selected stay selected when a command terminates.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objref,
Object represented by this ObjRef is selected.
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
)
true on success, false on failure.

Select

#Since v5.0
Select or deselects a single object.
public bool Select(
objref,
Object represented by this ObjRef is selected.
select
If true, the object will be selected, if false, it will be deselected.
)
true on success, false on failure.

Select

#Since v5.0
Select a single object.
public bool Select(
objref
Object represented by this ObjRef is selected.
)
true on success, false on failure.

Select

#Since v9.0
Select or deselect a colletion of objects.
public int Select(
objectIds,
select,
If true, the object will be selected, if false, it will be deselected.
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect,
Objects that are persistently selected stay selected when a command terminates.
ignoreGripsState,
If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.
ignoreLayerLocking,
If true, then objects on locked layers can be selected.
ignoreLayerVisibility
If true, then objects on hidden layers can be selectable.
)
Number of objects successfully selected or deselected.

Select

#Since v5.0
Selects or deselects a collection of objects.
public int Select(
objectIds,
Ids of objects to select or deselect.
select
If true, objects will be selected. If false, objects will be deselected.
)
Number of objects successfully selected or deselected.

Select

#ExampleSince v5.0
Selects a collection of objects.
public int Select(
objectIds
Ids of objects to select.
)
Number of objects successfully selected.

Select

#Since v5.0
Selects or deselects a collection of objects.
public int Select(
objRefs,
References to objects to select or deselect.
select
If true, objects will be selected. If false, objects will be deselected.
)
Number of objects successfully selected or deselected.

Select

#Since v5.0
Selects a collection of objects.
public int Select(
objRefs
References to objects to select.
)
Number of objects successfully selected.

SelectedObjectsExist

#Since v8.10
Quick way to test if any objects are currently selected
[CLSCompliant(false)] public bool SelectedObjectsExist(
ObjectType
objectType,
the type of objects to test for
checkSubObjects
Check to see if subobjects are selected
)

SelectGrips

#Since v9.0
Selects or deselects a collection of grips in one pass, so a native CRhinoOnChangeObjectSelectState watcher sees one change rather than one per grip.
public int SelectGrips(
grips,
Grips to select or deselect, from RhinoObject.GetGrips(). They may belong to several objects. Grips whose owner has since had its grips turned off, and anything in the collection that is not a grip, are skipped. null selects nothing, which is what RhinoObject.GetGrips() hands back for an object with no grips.
select,
If true, the grips will be selected, otherwise deselected.
syncHighlight,
If true, then a grip is highlighted if it is selected and unhighlighted if it is not.
persistentSelect
Grips that are persistently selected stay selected when a command terminates.
)
Remarks: RhinoDoc.SelectObjects and RhinoDoc.DeselectObjects do not report grips whichever way they are selected; the old event watchers have filtered grips out since Rhino 5 because grip pointers do not outlive the selection.
Number of grips successfully selected or deselected.

SelectGrips

#Since v9.0
Selects or deselects a collection of grips in one pass, so a native CRhinoOnChangeObjectSelectState watcher sees one change rather than one per grip.
public int SelectGrips(
grips,
Grips to select or deselect, from RhinoObject.GetGrips(). They may belong to several objects. Grips whose owner has since had its grips turned off, and anything in the collection that is not a grip, are skipped. null selects nothing, which is what RhinoObject.GetGrips() hands back for an object with no grips.
select
If true, the grips will be selected, otherwise deselected.
)
Remarks: RhinoDoc.SelectObjects and RhinoDoc.DeselectObjects do not report grips whichever way they are selected; the old event watchers have filtered grips out since Rhino 5 because grip pointers do not outlive the selection.
Number of grips successfully selected or deselected.

SetSelectedObjects

#Since v9.0
Set object selection.
public int SetSelectedObjects(
objectIds,
syncHighlight,
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.
persistentSelect,
Objects that are persistently selected stay selected when a command terminates.
ignoreGripsState,
If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.
ignoreLayerLocking,
If true, then objects on locked layers can be selected.
ignoreLayerVisibility
If true, then objects on hidden layers can be selectable.
)
Remarks: This method clears current selection before set the new one.
Number of objects successfully selected.

Show

#Since v5.0
If Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Show(
objectId,
Id of the normal object to show.
ignoreLayerMode
if true, the object will be shown even if it is on a layer that is locked or off.
)
true if the object was successfully shown.

Show

#Since v5.0
If objref.Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Show(
objref,
reference to normal object to show.
ignoreLayerMode
if true, the object will be shown even if it is on a layer that is locked or off.
)
true if the object was successfully shown.

Show

#Since v5.0
If obj.IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Show(
obj,
the normal object to show.
ignoreLayerMode
if true, the object will be shown even if it is on a layer that is locked or off.
)
true if the object was successfully shown.

Transform

#Since v5.0
Constructs a new object that is the transformation of the existing object and deletes the existing object if deleteOriginal is true.
public Guid Transform(
objectId,
Id of rhino object to transform. This object will be deleted if deleteOriginal is true.
Transform
xform,
transformation to apply.
deleteOriginal
if true, the original object is deleted if false, the original object is not deleted.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

Transform

#ExampleSince v5.0
Constructs a new object that is the transformation of the existing object and deletes the existing object if deleteOriginal is true.
public Guid Transform(
objref,
reference to object to transform. The objref.Object() will be deleted if deleteOriginal is true.
Transform
xform,
transformation to apply.
deleteOriginal
if true, the original object is deleted if false, the original object is not deleted.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

Transform

#Since v5.0
Constructs a new object that is the transformation of the existing object and deletes the existing object if deleteOriginal is true.
public Guid Transform(
obj,
Rhino object to transform. This object will be deleted if deleteOriginal is true.
Transform
xform,
transformation to apply.
deleteOriginal
if true, the original object is deleted if false, the original object is not deleted.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

TransformWithHistory

#Since v5.0
Constructs a new object that is the transformation of the existing object and records history of the transformation if history recording is turned on. If history recording is not enabled, this function will act the same as Transform(objectId, xform, false)
public Guid TransformWithHistory(
objectId,
Id of rhino object to transform.
xform
transformation to apply.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

TransformWithHistory

#Since v5.0
Constructs a new object that is the transformation of the existing object and records history of the transformation if history recording is turned on. If history recording is not enabled, this function will act the same as Transform(objref, xform, false)
public Guid TransformWithHistory(
objref,
reference to object to transform.
xform
transformation to apply.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

TransformWithHistory

#Since v5.0
Constructs a new object that is the transformation of the existing object and records history of the transformation if history recording is turned on. If history recording is not enabled, this function will act the same as Transform(obj, xform, false)
public Guid TransformWithHistory(
obj,
Rhino object to transform.
xform
transformation to apply.
)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Id of the new object that is the transformation of the existing_object. The new object has identical attributes.

TryFindPoint

#Since v6.0
Finds the location of a point, if a point exists in the document.
public bool TryFindPoint(
id,
ID of point object to search for.
out Point3d
point
The point will be passed here.
)
true on success; false if point was not found, id represented another geometry type, or on error.

Undelete

#Since v5.0
public bool Undelete(
rhinoObject
)

Undelete

#Since v5.0
[CLSCompliant(false)] public bool Undelete(
runtimeSerialNumber
)

Unlock

#Since v5.0
If Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Unlock(
objectId,
Id of locked object to unlock.
ignoreLayerMode
if true, the object will be unlocked even if it is on a layer that is locked or off.
)
true if the object was successfully unlocked.

Unlock

#Since v5.0
If objref.Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Unlock(
objref,
reference to locked object to unlock.
ignoreLayerMode
if true, the object will be unlocked even if it is on a layer that is locked or off.
)
true if the object was successfully unlocked.

Unlock

#Since v5.0
If obj.IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
public bool Unlock(
obj,
locked object to unlock.
ignoreLayerMode
if true, the object will be unlocked even if it is on a layer that is locked or off.
)
true if the object was successfully unlocked.

UnselectAll

#ExampleSince v5.0
Unselect objects.
public int UnselectAll()
Number of object that were unselected.

UnselectAll

#Since v5.0
Unselect objects.
public int UnselectAll(
ignorePersistentSelections
if true, then objects that are persistently selected will not be unselected.
)
Number of object that were unselected.