Properties
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.
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.
Overrides: CommonComponentTable<T>.ComponentType
Methods
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.
Returns: The new object ID on success.
Exceptions:
| ArgumentNullException | If geometry is null. |
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.
Returns: The new object ID on success.
Exceptions:
| ArgumentNullException | If geometry is null. |
Adds geometry that is not further specified.
This is meant, for example, to handle addition of sets of different geometrical entities.
Returns: The new object ID on success.
Exceptions:
| ArgumentNullException | If geometry is null. |
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a angular dimension object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a angular dimension object to the document.
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a curve object to the document representing an arc.
Returns: A unique identifier for the object.
Adds a curve object to the document representing an arc.
Returns: A unique identifier for the object.
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.
Returns: The ID.
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.
Returns: A unique identifier for the object.
Adds a brep object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a curve object to the document representing a circle.
Returns: A unique identifier for the object.
Adds a curve object to the document representing a circle.
Returns: A unique identifier for the object.
public Guid AddClippingPlane()
plane,
uMagnitude,
vMagnitude,
clippedViewportId,
attributes,
history,
reference
Adds a clipping plane object to Rhino.
Returns: A unique identifier for the object.
public Guid AddClippingPlane()
plane,
uMagnitude,
vMagnitude,
clippedViewportIds,
attributes,
history,
reference
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.
Returns: A unique identifier for the object.
Adds a clipping plane object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object.
Adds a curve object to Rhino.
Returns: A unique identifier for the object.
Adds a curve object to the document representing an ellipse.
Returns: A unique identifier for the object.
Adds a curve object to the document representing an ellipse.
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object.
Adds an extrusion object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object if successful. Guid.Empty it not successful.
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.
Returns: A unique identifier for the object if successful. Guid.Empty it not successful.
Adds an instance object to the document.
Returns: A unique identifier for the object if successful. Guid.Empty it not successful.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds Leader object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a Leader object to the document.
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a line object to Rhino.
Returns: A unique identifier for the object.
Adds a line object to Rhino.
Returns: A unique identifier for the object.
Adds a line object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a linear dimension object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a linear dimension object to the document.
Returns: The Id of the newly added object or Guid.Empty on failure.
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.
Returns: A unique identifier for the object.
Adds a mesh object to Rhino.
Returns: A unique identifier for the object.
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
Returns: A unique identifier for the object.
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.
Point3d[]
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
Returns: A unique identifier for the object.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
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
Returns: A unique identifier for the object
Adds a point object to the document.
Returns: A unique identifier for the object..
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
Returns: A unique identifier for the object.
Exceptions:
| ArgumentNullException | If point is null. |
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
Returns: A unique identifier for the object.
Adds a point object to the document.
public Guid AddPoint()
point,
location of point.
attributes
attributes to apply to point. null is acceptable
Returns: A unique identifier for the object.
Adds a point object to the document.
Returns: A unique identifier for the object.
Adds a point object to the document.
Returns: A unique identifier for the object.
Adds a point object to the document.
Returns: A unique identifier for the object.
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
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object.
Adds a point cloud object to the document.
Returns: A unique identifier for the object.
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
Returns: A unique identifier for the object.
Adds a point cloud object to the document.
Returns: A unique identifier for the object.
Adds a point cloud object to the document.
Returns: A unique identifier for the object.
Adds multiple points to the document.
Returns: List of object ids.
Adds multiple points to the document.
Returns: List of object ids.
Adds multiple points to the document.
Returns: List of object ids.
Adds multiple points to the document.
Returns: List of object ids.
Adds a polyline object to Rhino.
Returns: A unique identifier for the object.
Adds a polyline object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
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.
Returns: The ID.
Adds a rectangle to the object table.
public Guid AddRectangle()
rectangle,
The rectangle.
attributes
Attributes that will be linked with the surface object.
Returns: The ID.
Adds a rectangle to the object table.
Returns: The ID.
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
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object.
Adds a SubD object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: A unique identifier for the object.
Adds a surface object to Rhino.
Returns: A unique identifier for the object.
Adds an annotation text object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
public Guid AddText()
text,
plane,
height,
fontName,
bold,
italic,
justification,
attributes,
history,
reference
Adds an annotation text object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds an annotation text object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds an annotation text object to the document.
Returns: The Guid of the newly added object or Guid.Empty on failure.
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.
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a text object to the document.
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a v6_TextObject to the document.
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a text dot object to Rhino.
public Guid AddTextDot()
text,
A text string.
location,
A point position.
attributes
Attributes to apply to curve.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a text dot object to Rhino.
Returns: A unique identifier for the object.
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.
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a text dot object to Rhino.
Returns: A unique identifier for the object.
Gets all the objects that have been added to the document since a given runtime serial number.
Returns: An array of objects or null if no objects were added since the given runtime serial number.
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).
Returns: true if any object is selected.
Clear
Marks all items as deleted.
public void Clear()
Deletes object from document. The deletion can be undone by calling UndeleteObject().
Returns: true on success, false on failure.
Deletes objref.Object(). The deletion can be undone by calling UndeleteObject().
Returns: true on success, false on failure.
Deletes objref.Object(). The deletion can be undone by calling UndeleteObject().
Returns: true on success, false on failure.
Deletes an object, taking into account modes and not showing error message boxes.
Returns: True on success.
Overrides: CommonComponentTable<T>.Delete
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.
Returns: true on success, false on failure.
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.
Returns: true on success, false on failure.
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.
Returns: The number of successfully deleted objects.
Deletes a grip object.
Returns: True on success.
Deletes a grip object.
Returns: True on success.
Deletes a grip object.
Returns: True on success.
Deletes one or more grip objects.
Returns: The number of successfully deleted grip objects.
Deletes one or more grip objects.
Returns: The number of successfully deleted grip objects.
Deletes one or more grip objects.
Returns: The number of successfully deleted grip objects.
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.
Returns: The number of successfully deleted grip objects.
Same as TransformObject(objref, ON_Xform.Identity, false)
Returns: The new object ID.
Duplicates the object that is referenced by objref.
Same as Transform(objref, Transform.Identity, false)
Returns: The new object ID.
Duplicates the object that is referenced by obj.
Same as TransformObject(obj, Transform.Identityy, false)
Returns: The new object ID.
Please use FindId().
Returns: Do not use this method.
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.
Returns: Reference to the rhino object with the objectId or null if no such object could be found.
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
Returns: An array of RhinoObjects that are inside of this region
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
Returns: An array of RhinoObjects that are inside of this region
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.
Returns: An array of Rhino document objects. This array can be empty.
Same as GetObjectList but converts the result to an array.
public RhinoObject[] FindByFilter()
filter
The ObjectEnumeratorSettings filter to customize inclusion requirements.
Returns: A Rhino object array. This array can be empty but not null.
Finds all RhinoObjects that are in a given group.
Returns: An array of objects that belong to the specified group or null if no objects could be found.
Finds all RhinoObjects that are in a given layer.
Returns: Array of objects that belong to the specified group or null if no objects could be found.
Finds all RhinoObjects that are in a given layer.
Returns: Array of objects that belong to the specified group or null if no objects could be found.
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.
Returns: An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.
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.
Returns: An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.
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.
Returns: An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.
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
Returns: An array of RhinoObjects that are inside of this region
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
Returns: An array of RhinoObjects that are inside of this region
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.
Returns: An array of clipping plane objects. The array can be empty but not null.
Finds all of the visible clipping plane objects that actively clip a viewport.
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.Returns: An array of clipping plane objects. The array can be empty but not null.
Same as FindId, but returns the Geometry property directly, if it exists.
Returns: Reference to the geometry in the rhino object with the objectId or null if no such object could be found.
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.Returns: Reference to the rhino object with the objectId or null if no such object could be found.
Overrides: CommonComponentTable<T>.FindId
Overrides: CommonComponentTable<T>.GetEnumerator
Returns an enumerable based on a ObjectEnumeratorSettings filter.
Returns: The enumerable.
GetObjectList
#Returns an enumerable based on a ObjectEnumeratorSettings filter.
Returns: The enumerable.
Returns Rhino object by type.
Returns: The enumerable.
Returns Rhino object by type.
Returns: The enumerable.
Compute the current number of selected objects
What geometry types are currently selected
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.
Returns: new RhinoObject on success; otherwise null.
If Object().IsNormal() is true, then the object will be hidden.
Returns: true if the object was successfully hidden.
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.
Returns: true if the object was successfully hidden.
If objref.Object().IsNormal() is true, then the object will be hidden.
Returns: true if the object was successfully hidden.
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.
Returns: true if the object was successfully hidden.
Destroys the cached scene bounding box so that it will be regenerated again from scratch next time the view is regenerated
public void InvalidateBoundingBox()
If objref.Object().IsNormal() is true, then the object will be locked.
Returns: true if the object was successfully locked.
If objref.Object().IsNormal() is true, then the object will be locked.
Returns: true if the object was successfully locked.
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.
Returns: true if the object was successfully locked.
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.
Returns: true if successful.
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.
Returns: true if successful.
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.
Returns: true if successful.
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
Returns: Returns true on success otherwise returns false.
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
Returns: Returns true on success otherwise returns false.
Modifies an object's render material assignment, this will set the objects material source to ObjectMaterialSource.MaterialFromObject.
Returns: Returns true on success otherwise returns false.
Gets the most recently added object that is still in the Document.
Returns: 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.
Returns: The number of objects that pass the filter.
Pick one or more objects based on a given pick context
Returns: zero or more objects
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.
Returns: true if the object was purged; otherwise false.
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.
Returns: true if the object was purged; otherwise false.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new brep object.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new extrusion object.
Returns: true if successful.
Replaces one object with new hatch object.
Returns: true if successful.
Replaces one object with new text object.
Returns: true if successful.
Replaces one object with new line curve object.
Returns: true if successful.
Replaces one object with new mesh object.
Returns: true if successful.
Replaces one object with new point object.
Returns: true if successful.
Replaces one object with new point object.
Returns: true if successful.
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.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new subd object.
Returns: true if successful.
Replaces one object with new surface object.
Returns: true if successful.
Replaces one object with new text dot object.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new brep object.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
Replaces one object with new extrusion object.
Returns: true if successful.
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
Returns: true if successful.
Replaces one object with new hatch object.
Returns: true if successful.
Replaces one object with new text object.
Returns: true if successful.
Replaces one object with new line curve object.
Returns: true if successful.
Replaces one object with new mesh object.
Returns: true if successful.
Replaces one object with new point object.
Returns: true if successful.
Replaces one object with new point object.
Returns: true if successful.
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.
Returns: true if successful.
Replaces one object with new curve object.
Returns: true if successful.
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.
Returns: true if successful.
Replaces one object with a new SubD object.
Returns: true if successful.
Replaces one object with new surface object.
Returns: true if successful.
Replaces one object with new text dot object.
Returns: true if successful.
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.
Returns: true if successful.
Replaces the underlying instance definition of an instance object.
Returns: true if successful.
Replaces the underlying instance definition of an instance object.
Returns: true if successful.
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.
Returns: true on success, false on failure.
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.
Returns: true on success, false on failure.
Select or deselects a single object.
Returns: true on success, false on failure.
Select or deselects a single object.
Returns: true on success, false on failure.
Select a single object.
Returns: true on success, false on failure.
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.
Returns: true on success, false on failure.
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.
Returns: true on success, false on failure.
Select or deselects a single object.
Returns: true on success, false on failure.
Select or deselects a single object.
Returns: true on success, false on failure.
Select a single object.
Returns: true on success, false on failure.
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.
Returns: Number of objects successfully selected or deselected.
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.
Returns: Number of objects successfully selected or deselected.
Selects a collection of objects.
Returns: Number of objects successfully selected.
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.
Returns: Number of objects successfully selected or deselected.
Selects a collection of objects.
Returns: Number of objects successfully selected.
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
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.
Returns: Number of grips successfully selected or deselected.
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.
Returns: Number of grips successfully selected or deselected.
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.
Returns: Number of objects successfully selected.
If Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
Returns: true if the object was successfully shown.
If objref.Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
Returns: true if the object was successfully shown.
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.
Returns: true if the object was successfully shown.
Constructs a new object that is the transformation of the existing object and deletes the existing object if deleteOriginal is true.
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
Constructs a new object that is the transformation of the existing object and deletes the existing object if deleteOriginal is true.
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
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.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
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)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
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)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
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)
Remarks: If the object is locked or on a locked layer, then it cannot be transformed.
Returns: Id of the new object that is the transformation of the existing_object. The new object has identical attributes.
Finds the location of a point, if a point exists in the document.
Returns: true on success; false if point was not found, id represented another geometry type, or on error.
If Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
Returns: true if the object was successfully unlocked.
If objref.Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
Returns: true if the object was successfully unlocked.
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.
Returns: true if the object was successfully unlocked.
Unselect objects.
Returns: Number of object that were unselected.