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
public Guid Add(GeometryBase geometry, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds geometry that is not further specified.
This is meant, for example, to handle addition of sets of different geometrical entities.
Parameters:
| geometry (GeometryBase) | The base geometry. This cannot be null. |
| attributes (ObjectAttributes) | The object attributes. This can be null. |
| history (HistoryRecord) | The history information that will be saved. |
| reference (bool) | 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.
Parameters:
| geometry (GeometryBase) | The base geometry. This cannot be null. |
| attributes (ObjectAttributes) | 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.
Parameters:
| geometry (GeometryBase) | The base geometry. This cannot be null. |
Returns: The new object ID on success.
Exceptions:
| ArgumentNullException | If geometry is null. |
public Guid AddAngularDimension(AngularDimension dimension, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds an angular dimension object to the document.
Parameters:
| dimension (AngularDimension) | Dimension object to add. |
| attributes (ObjectAttributes) | Attributes to apply to dimension. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
Parameters:
| dimension (AngularDimension) | Dimension object to add. |
| attributes (ObjectAttributes) |
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a angular dimension object to the document.
Parameters:
| dimension (AngularDimension) | Dimension object to add. |
Returns: The Id of the newly added object or Guid.Empty on failure.
Parameters:
| arc (Arc) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a curve object to the document representing an arc.
Parameters:
| arc (Arc) | An arc value. |
| attributes (ObjectAttributes) | Attributes to apply to arc. |
Returns: A unique identifier for the object.
Adds a curve object to the document representing an arc.
Parameters:
| arc (Arc) | An arc value. |
Returns: A unique identifier for the object.
Adds a box to the object table, as an extrusion.
Parameters:
| box (Box) | The box. |
| attributes (ObjectAttributes) | Attributes that will be linked with the surface object. |
| history (HistoryRecord) | History data records. |
| reference (bool) | If a reference, object will not be saved in the document. |
Returns: The ID.
Adds a box to the object table.
Parameters:
| box (Box) | The box. |
| attributes (ObjectAttributes) | Attributes that will be linked with the surface object. |
Returns: The ID.
Adds a box to the object table.
Parameters:
| box (Box) | The box. |
Returns: The ID.
public Guid AddBrep(Brep brep, ObjectAttributes attributes, HistoryRecord history, bool reference, bool splitKinkySurfaces)
Parameters:
| brep (Brep) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) | |
| splitKinkySurfaces (bool) |
Parameters:
| brep (Brep) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a brep object to Rhino.
Parameters:
| brep (Brep) | A duplicate of this brep is added to Rhino. |
| attributes (ObjectAttributes) | attributes to apply to brep. |
Returns: A unique identifier for the object.
Adds a brep object to Rhino.
Parameters:
| brep (Brep) | A duplicate of this brep is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddCentermark(Centermark centermark, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds an ordinate dimension object to the document.
Parameters:
| centermark (Centermark) | Dimension object to add. |
| attributes (ObjectAttributes) | Attributes to apply to dimension. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
public Guid AddCircle(Circle circle, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| circle (Circle) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a curve object to the document representing a circle.
Parameters:
| circle (Circle) | A circle value. |
| attributes (ObjectAttributes) | Attributes to apply to circle. |
Returns: A unique identifier for the object.
Adds a curve object to the document representing a circle.
Parameters:
| circle (Circle) | A circle value. |
Returns: A unique identifier for the object.
public Guid AddClippingPlane(Plane plane, double uMagnitude, double vMagnitude, Guid clippedViewportId, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| plane (Plane) | |
| uMagnitude (double) | |
| vMagnitude (double) | |
| clippedViewportId (Guid) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddClippingPlane(Plane plane, double uMagnitude, double vMagnitude, Guid clippedViewportId)
Adds a clipping plane object to Rhino.
public Guid AddClippingPlane(Plane plane, double uMagnitude, double vMagnitude, IEnumerable<Guid> clippedViewportIds, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| plane (Plane) | |
| uMagnitude (double) | |
| vMagnitude (double) | |
| clippedViewportIds (IEnumerable<Guid>) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddClippingPlane(Plane plane, double uMagnitude, double vMagnitude, IEnumerable<Guid> clippedViewportIds, ObjectAttributes attributes)
Adds a clipping plane object to Rhino.
Parameters:
| plane (Plane) | The plane value. |
| uMagnitude (double) | The size in the U direction. |
| vMagnitude (double) | The size in the V direction. |
| clippedViewportIds (IEnumerable<Guid>) | A list, an array or any enumerable set of viewport IDs that the new clipping plane will clip. |
| attributes (ObjectAttributes) | Document attributes for the plane. |
Returns: A unique identifier for the object.
public Guid AddClippingPlane(Plane plane, double uMagnitude, double vMagnitude, IEnumerable<Guid> clippedViewportIds)
Adds a clipping plane object to Rhino.
Parameters:
| plane (Plane) | The plane value. |
| uMagnitude (double) | The size in the U direction. |
| vMagnitude (double) | The size in the V direction. |
| clippedViewportIds (IEnumerable<Guid>) | A list, an array or any enumerable set of viewport IDs that the new clipping plane will clip. |
Returns: A unique identifier for the object.
public Guid AddClippingPlaneSurface(ClippingPlaneSurface clippingPlane, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| clippingPlane (ClippingPlaneSurface) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddCurve(Curve curve, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| curve (Curve) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a curve object to Rhino.
Parameters:
| curve (Curve) | A curve. A duplicate of this curve is added to Rhino. |
| attributes (ObjectAttributes) | Attributes to apply to curve. |
Returns: A unique identifier for the object.
Adds a curve object to Rhino.
Parameters:
| curve (Curve) | A curve. A duplicate of this curve is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddEllipse(Ellipse ellipse, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| ellipse (Ellipse) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a curve object to the document representing an ellipse.
Parameters:
| ellipse (Ellipse) | An ellipse value. |
| attributes (ObjectAttributes) | Attributes to apply to ellipse. |
Returns: A unique identifier for the object.
Adds a curve object to the document representing an ellipse.
Parameters:
| ellipse (Ellipse) | An ellipse value. |
Returns: A unique identifier for the object.
public Guid[] AddExplodedInstancePieces(InstanceObject instance, bool explodeNestedInstances = true, bool deleteInstance = false)
Parameters:
| instance (InstanceObject) | |
| explodeNestedInstances (bool = true) | |
| deleteInstance (bool = false) |
public Guid AddExtrusion(Extrusion extrusion, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| extrusion (Extrusion) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds an extrusion object to Rhino.
Parameters:
| extrusion (Extrusion) | A duplicate of this extrusion is added to Rhino. |
| attributes (ObjectAttributes) | Attributes that will be linked with the extrusion object. |
Returns: A unique identifier for the object.
Adds an extrusion object to Rhino.
Parameters:
| extrusion (Extrusion) | A duplicate of this extrusion is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddHatch(Hatch hatch, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| hatch (Hatch) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Parameters:
| hatch (Hatch) | |
| attributes (ObjectAttributes) |
public Guid AddInstanceObject(int instanceDefinitionIndex, Transform instanceXform, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds an instance object to the document.
Parameters:
| instanceDefinitionIndex (int) | The index of the instance definition. |
| instanceXform (Transform) | The instance transformation. |
| attributes (ObjectAttributes) | The attributes to apply to the instance object. |
| history (HistoryRecord) | The history record associated with this instance object. |
| reference (bool) | 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.
public Guid AddInstanceObject(int instanceDefinitionIndex, Transform instanceXform, ObjectAttributes attributes)
Adds an instance object to the document.
Parameters:
| instanceDefinitionIndex (int) | The index of the instance definition. |
| instanceXform (Transform) | The instance transformation. |
| attributes (ObjectAttributes) | 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.
Parameters:
| points (IEnumerable<Point3d>) |
public Guid AddLeader(Leader leader, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a Leader object to the document.
Parameters:
| leader (Leader) | The leader object. |
| attributes (ObjectAttributes) | Attributes to apply to rich text. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
Parameters:
| leader (Leader) | The leader object. |
| attributes (ObjectAttributes) | Attributes to apply to rich text. |
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a Leader object to the document.
Parameters:
| leader (Leader) | The leader object. |
Returns: The Id of the newly added object or Guid.Empty on failure.
Parameters:
| plane (Plane) | |
| points (IEnumerable<Point2d>) | |
| attributes (ObjectAttributes) |
Parameters:
| plane (Plane) | |
| points (IEnumerable<Point2d>) |
Parameters:
| text (string) | |
| points (IEnumerable<Point3d>) |
public Guid AddLeader(string text, Plane plane, IEnumerable<Point2d> points, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| text (string) | |
| plane (Plane) | |
| points (IEnumerable<Point2d>) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddLeader(string text, Plane plane, IEnumerable<Point2d> points, ObjectAttributes attributes)
Parameters:
| text (string) | |
| plane (Plane) | |
| points (IEnumerable<Point2d>) | |
| attributes (ObjectAttributes) |
Parameters:
| text (string) | |
| plane (Plane) | |
| points (IEnumerable<Point2d>) |
Adds a line object to Rhino.
Parameters:
| line (Line) | The line value. |
| attributes (ObjectAttributes) | Attributes to apply to line. |
Returns: A unique identifier for the object.
Adds a line object to Rhino.
Parameters:
| line (Line) |
Returns: A unique identifier for the object.
public Guid AddLine(Point3d from, Point3d to, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| from (Point3d) | |
| to (Point3d) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a line object to Rhino.
Parameters:
| from (Point3d) | The line origin. |
| to (Point3d) | The line end. |
| attributes (ObjectAttributes) | Attributes to apply to line. |
Returns: A unique identifier for the object.
Adds a line object to Rhino.
public Guid AddLinearDimension(LinearDimension dimension, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a linear dimension object to the document.
Parameters:
| dimension (LinearDimension) | Dimension object to add. |
| attributes (ObjectAttributes) | Attributes to apply to dimension. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
Parameters:
| dimension (LinearDimension) | Dimension object to add. |
| attributes (ObjectAttributes) |
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds a linear dimension object to the document.
Parameters:
| dimension (LinearDimension) | Dimension object to add. |
Returns: The Id of the newly added object or Guid.Empty on failure.
public Guid AddMesh(Mesh mesh, ObjectAttributes attributes, HistoryRecord history, bool reference, bool requireValidMesh)
Parameters:
| mesh (Mesh) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) | |
| requireValidMesh (bool) |
Parameters:
| mesh (Mesh) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a mesh object to Rhino.
Parameters:
| mesh (Mesh) | A duplicate of this mesh is added to Rhino. |
| attributes (ObjectAttributes) | Attributes that will be linked with the mesh object. |
Returns: A unique identifier for the object.
Adds a mesh object to Rhino.
Parameters:
| mesh (Mesh) | A duplicate of this mesh is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddMorphControl(MorphControl morphControl, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| morphControl (MorphControl) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Parameters:
| morphControl (MorphControl) | |
| attributes (ObjectAttributes) |
Parameters:
| morphControl (MorphControl) |
public Guid AddOrderedPointCloud(int xCt, int yCt, int zCt, Point3d min, Point3d max, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point cloud object to the document.
Parameters:
| xCt (int) | Number of points in X dir. |
| yCt (int) | Number of points in Y dir. |
| zCt (int) | Number of points in Z dir. |
| min (Point3d) | point at x0,y0,z0 of bounding box of the pointcloud |
| max (Point3d) | point at x1,y1,z1 of bounding box of the pointcloud |
| attributes (ObjectAttributes) | Attributes to apply to point cloud. null is acceptable |
| history (HistoryRecord) | history associated with this point cloud. null is acceptable |
| reference (bool) | true if the object is from a reference file. Reference objects do not persist in archives |
Returns: A unique identifier for the object.
public Guid AddOrderedPointCloud(int xCt, int yCt, int zCt, Point3d[] box, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point cloud object to the document.
Parameters:
| xCt (int) | Number of points in X dir. |
| yCt (int) | Number of points in Y dir. |
| zCt (int) | Number of points in Z dir. |
| box (Point3d[]) | 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 (ObjectAttributes) | Attributes to apply to point cloud. null is acceptable |
| history (HistoryRecord) | history associated with this point cloud. null is acceptable |
| reference (bool) | true if the object is from a reference file. Reference objects do not persist in archives |
Returns: A unique identifier for the object.
public Guid AddOrdinateDimension(OrdinateDimension dimordinate, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds an ordinate dimension object to the document.
Parameters:
| dimordinate (OrdinateDimension) | Dimension object to add. |
| attributes (ObjectAttributes) | Attributes to apply to dimension. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
public Guid AddPictureFrame(Plane plane, string texturePath, bool asMesh, double width, double height, bool selfIllumination, bool embedBitmap)
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.
Parameters:
| plane (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 (string) | path to an image file |
| asMesh (bool) | If true, the function will make a MeshObject rather than a surface |
| width (double) | 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 (double) | 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 (bool) | If true, the image mapped to the picture frame plane always displays at full intensity and is not affected by light or shadow. |
| embedBitmap (bool) | 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.
public Guid AddPoint(Point point, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point object and its geometry-linked information to the document
Parameters:
| point (Point) | A point geometry class. |
| attributes (ObjectAttributes) | attributes to apply to point. null is acceptable |
| history (HistoryRecord) | history associated with this point. null is acceptable |
| reference (bool) | 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. |
public Guid AddPoint(Point3d point, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point object to the document
Parameters:
| point (Point3d) | location of point |
| attributes (ObjectAttributes) | attributes to apply to point. null is acceptable |
| history (HistoryRecord) | history associated with this point. null is acceptable |
| reference (bool) | 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.
Parameters:
| point (Point3d) | location of point. |
| attributes (ObjectAttributes) | attributes to apply to point. null is acceptable |
Returns: A unique identifier for the object.
Adds a point object to the document.
Parameters:
| point (Point3d) | location of point. |
Returns: A unique identifier for the object.
Adds a point object to the document.
Parameters:
| point (Point3f) | location of point. |
| attributes (ObjectAttributes) | attributes to apply to point. |
Returns: A unique identifier for the object.
Adds a point object to the document.
Parameters:
| point (Point3f) | location of point. |
Returns: A unique identifier for the object.
public Guid AddPointCloud(IEnumerable<Point3d> points, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point cloud object to the document.
Parameters:
| points (IEnumerable<Point3d>) | A list, an array or any enumerable set of points |
| attributes (ObjectAttributes) | Attributes to apply to point cloud. null is acceptable |
| history (HistoryRecord) | history associated with this point cloud. null is acceptable |
| reference (bool) | 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.
Parameters:
| points (IEnumerable<Point3d>) | A list, an array or any enumerable set of points. |
| attributes (ObjectAttributes) | attributes to apply to point cloud. |
Returns: A unique identifier for the object.
Adds a point cloud object to the document.
Parameters:
| points (IEnumerable<Point3d>) | A list, an array or any enumerable set of points. |
Returns: A unique identifier for the object.
public Guid AddPointCloud(PointCloud cloud, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a point cloud object to the document.
Parameters:
| cloud (PointCloud) | PointCloud to add. |
| attributes (ObjectAttributes) | Attributes to apply to point cloud. null is acceptable |
| history (HistoryRecord) | history associated with this point cloud. null is acceptable |
| reference (bool) | 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.
Parameters:
| cloud (PointCloud) | PointCloud to add. |
| attributes (ObjectAttributes) | Attributes to apply to point cloud. |
Returns: A unique identifier for the object.
Adds a point cloud object to the document.
Parameters:
| cloud (PointCloud) | PointCloud to add. |
Returns: A unique identifier for the object.
Adds multiple points to the document.
Parameters:
| points (IEnumerable<Point3d>) | Points to add. |
| attributes (ObjectAttributes) | Attributes to apply to point objects. |
Returns: List of object ids.
Adds multiple points to the document.
Parameters:
| points (IEnumerable<Point3d>) | Points to add. |
Returns: List of object ids.
Adds multiple points to the document.
Parameters:
| points (IEnumerable<Point3f>) | Points to add. |
| attributes (ObjectAttributes) | Attributes to apply to point objects. |
Returns: List of object ids.
Adds multiple points to the document.
Parameters:
| points (IEnumerable<Point3f>) | Points to add. |
Returns: List of object ids.
public Guid AddPolyline(IEnumerable<Point3d> points, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| points (IEnumerable<Point3d>) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a polyline object to Rhino.
Parameters:
| points (IEnumerable<Point3d>) | A Polyline; a list, an array, or any enumerable set of Point3d. |
| attributes (ObjectAttributes) | attributes to apply to line. |
Returns: A unique identifier for the object.
Adds a polyline object to Rhino.
Parameters:
| points (IEnumerable<Point3d>) | A Polyline; a list, an array, or any enumerable set of Point3d. |
Returns: A unique identifier for the object.
public Guid AddRadialDimension(RadialDimension dimension, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a radial dimension object to the document.
Parameters:
| dimension (RadialDimension) | Dimension object to add. |
| attributes (ObjectAttributes) | Attributes to apply to dimension. |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
Parameters:
| dimension (RadialDimension) | |
| attributes (ObjectAttributes) |
Parameters:
| dimension (RadialDimension) |
public Guid AddRectangle(Rectangle3d rectangle, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a rectangle to the object table.
Parameters:
| rectangle (Rectangle3d) | The rectangle. |
| attributes (ObjectAttributes) | Attributes that will be linked with the surface object. |
| history (HistoryRecord) | History data records. |
| reference (bool) | If a reference, object will not be saved in the document. |
Returns: The ID.
Adds a rectangle to the object table.
Parameters:
| rectangle (Rectangle3d) | The rectangle. |
| attributes (ObjectAttributes) | Attributes that will be linked with the surface object. |
Returns: The ID.
Adds a rectangle to the object table.
Parameters:
| rectangle (Rectangle3d) | The rectangle. |
Returns: The ID.
Parameters:
| brepObject (BrepObject) | |
| brep (Brep) |
Parameters:
| curveObject (CurveObject) | |
| curve (Curve) |
Parameters:
| brepObject (CustomBrepObject) | |
| history (HistoryRecord) |
Parameters:
| brepObject (CustomBrepObject) |
Parameters:
| curveObject (CustomCurveObject) | |
| history (HistoryRecord) |
Parameters:
| meshObject (CustomMeshObject) | |
| history (HistoryRecord) |
Parameters:
| meshObject (CustomMeshObject) |
Parameters:
| pointObject (CustomPointObject) | |
| history (HistoryRecord) |
Parameters:
| pointObject (CustomPointObject) |
Parameters:
| meshObject (MeshObject) | |
| mesh (Mesh) |
Parameters:
| pointObject (PointObject) | |
| point (Point) |
public Guid AddSphere(Sphere sphere, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| sphere (Sphere) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Parameters:
| sphere (Sphere) | |
| attributes (ObjectAttributes) |
Adds a SubD object to Rhino.
Parameters:
| subD (SubD) | A duplicate of this SubD is added to Rhino. |
| attributes (ObjectAttributes) | Attributes that will be linked with the object. |
| history (HistoryRecord) | |
| reference (bool) |
Returns: A unique identifier for the object.
Adds a SubD object to Rhino.
Parameters:
| subD (SubD) | A duplicate of this SubD is added to Rhino. |
| attributes (ObjectAttributes) | Attributes that will be linked with the object. |
Returns: A unique identifier for the object.
Adds a SubD object to Rhino.
Parameters:
| subD (SubD) | A duplicate of this SubD is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddSurface(Surface surface, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| surface (Surface) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a surface object to Rhino.
Parameters:
| surface (Surface) | A duplicate of this surface is added to Rhino. |
| attributes (ObjectAttributes) | Attributes that will be linked with the surface object. |
Returns: A unique identifier for the object.
Adds a surface object to Rhino.
Parameters:
| surface (Surface) | A duplicate of this surface is added to Rhino. |
Returns: A unique identifier for the object.
public Guid AddText(string text, Plane plane, double height, string fontName, bool bold, bool italic, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| text (string) | |
| plane (Plane) | |
| height (double) | |
| fontName (string) | |
| bold (bool) | |
| italic (bool) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddText(string text, Plane plane, double height, string fontName, bool bold, bool italic, ObjectAttributes attributes)
Adds an annotation text object to the document.
Parameters:
| text (string) | Text string. |
| plane (Plane) | Plane of text. |
| height (double) | Height of text. |
| fontName (string) | Name of FontFace. |
| bold (bool) | Bold flag. |
| italic (bool) | Italic flag. |
| attributes (ObjectAttributes) | Attributes that will be linked with the object. |
Returns: The Guid of the newly added object or Guid.Empty on failure.
public Guid AddText(string text, Plane plane, double height, string fontName, bool bold, bool italic, TextJustification justification, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| text (string) | |
| plane (Plane) | |
| height (double) | |
| fontName (string) | |
| bold (bool) | |
| italic (bool) | |
| justification (TextJustification) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
public Guid AddText(string text, Plane plane, double height, string fontName, bool bold, bool italic, TextJustification justification, ObjectAttributes attributes)
Parameters:
| text (string) | |
| plane (Plane) | |
| height (double) | |
| fontName (string) | |
| bold (bool) | |
| italic (bool) | |
| justification (TextJustification) | |
| attributes (ObjectAttributes) |
public Guid AddText(string text, Plane plane, double height, string fontName, bool bold, bool italic)
Adds an annotation text object to the document.
Adds an annotation text object to the document.
Parameters:
| text3d (Text3d) | The text object to add. |
| attributes (ObjectAttributes) | Object Attributes. |
Returns: The Guid of the newly added object or Guid.Empty on failure.
Adds an annotation text object to the document.
Parameters:
| text3d (Text3d) | The text object to add. |
Returns: The Guid of the newly added object or Guid.Empty on failure.
public Guid AddText(TextEntity text, ObjectAttributes attributes, HistoryRecord history, bool reference)
Adds a text object to the document.
Parameters:
| text (TextEntity) | Text object to add. |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | Object history to save. |
| reference (bool) | 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.
Parameters:
| text (TextEntity) | Text object to add. |
| attributes (ObjectAttributes) |
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a v6_TextObject to the document.
Parameters:
| text (TextEntity) | Text object to add. |
Returns: The Id of the newly added object or Guid.Empty on failure.
Adds a text dot object to Rhino.
Parameters:
| text (string) | A text string. |
| location (Point3d) | A point position. |
| attributes (ObjectAttributes) | 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.
public Guid AddTextDot(TextDot dot, ObjectAttributes attributes, HistoryRecord history, bool reference)
Parameters:
| dot (TextDot) | |
| attributes (ObjectAttributes) | |
| history (HistoryRecord) | |
| reference (bool) |
Adds a text dot object to Rhino.
Parameters:
| dot (TextDot) | A text dot that will be copied. |
| attributes (ObjectAttributes) | 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.
Parameters:
| dot (TextDot) | A text dot that will be copied. |
Returns: A unique identifier for the object.
Gets all the objects that have been added to the document since a given runtime serial number.
Parameters:
| runtimeSerialNumber (uint) | Runtime serial number of the last object not to include in the list. |
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).
Clear
public void Clear()
Marks all items as deleted.
Deletes object from document. The deletion can be undone by calling UndeleteObject().
Deletes objref.Object(). The deletion can be undone by calling UndeleteObject().
Parameters:
| objref (ObjRef) | objref.Object() will be deleted. |
| quiet (bool) | If false, a message box will appear when an object cannot be deleted. |
| ignoreModes (bool) | 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 objref.Object(). The deletion can be undone by calling UndeleteObject().
Deletes an object, taking into account modes and not showing error message boxes.
Parameters:
| item (RhinoObject) | The object to delete. |
Returns: True on success.
Overrides: CommonComponentTable<T>.Delete
Deletes object from document. The deletion can be undone by calling UndeleteObject().
Parameters:
| obj (RhinoObject) | The object to delete. |
| quiet (bool) | If false, a message box will appear when an object cannot be deleted. |
| ignoreModes (bool) | 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().
Parameters:
| obj (RhinoObject) | The object to delete. |
| quiet (bool) | 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.
Parameters:
| objectIds (IEnumerable<Guid>) | Ids of all objects to delete. |
| quiet (bool) | If false, a message box will appear when an object cannot be deleted. |
Returns: The number of successfully deleted objects.
Deletes a grip object.
Parameters:
| grip (GripObject) | The grip object to delete. |
Returns: True on success.
Deletes a grip object.
Parameters:
| gripId (Guid) | The id of the grip object to delete. |
Returns: True on success.
Deletes a grip object.
Parameters:
| gripRef (ObjRef) | A reference to the grip object to delete. |
Returns: True on success.
Deletes one or more grip objects.
Parameters:
| grips (IEnumerable<GripObject>) | The grip objects to delete. |
Returns: The number of successfully deleted grip objects.
Deletes one or more grip objects.
Parameters:
| gripIds (IEnumerable<Guid>) | The ids of the grip objects to delete. |
Returns: The number of successfully deleted grip objects.
Deletes one or more grip objects.
Parameters:
| gripRefs (IEnumerable<ObjRef>) | References to the grip objects to delete. |
Returns: The number of successfully deleted grip objects.
Deletes one or more grip objects.
Parameters:
| owner (RhinoObject) | The owner of the grip objects. |
| gripIndices (IEnumerable<int>) | The indices of the grip objects to delete. |
Returns: The number of successfully deleted grip objects.
Same as TransformObject(objref, ON_Xform.Identity, false)
Parameters:
| objectId (Guid) | An ID to an object in the document that needs to be duplicated. |
Returns: The new object ID.
Duplicates the object that is referenced by objref.
Same as Transform(objref, Transform.Identity, false)
Parameters:
| objref (ObjRef) | A Rhino object reference to follow for object duplication. |
Returns: The new object ID.
Duplicates the object that is referenced by obj.
Same as TransformObject(obj, Transform.Identityy, false)
Parameters:
| obj (RhinoObject) | A Rhino object to duplicate. |
Returns: The new object ID.
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public RhinoObject Find(Guid objectId)
Please use FindId().
Parameters:
| objectId (Guid) | Do not use this method. |
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.
Parameters:
| runtimeSerialNumber (uint) | Runtime serial number to search for. |
Returns: Reference to the rhino object with the objectId or null if no such object could be found.
[CLSCompliant(false)]
public RhinoObject[] FindByCrossingWindowRegion(RhinoViewport viewport, IEnumerable<Point3d> region, bool inside, ObjectType filter)
Finds objects bounded by a polyline region
Parameters:
| viewport (RhinoViewport) | viewport to use for selection |
| region (IEnumerable<Point3d>) | list of points that define the |
| inside (bool) | should objects returned be the ones inside of this region (or outside) |
| filter (ObjectType) | filter down list by object type |
Returns: An array of RhinoObjects that are inside of this region
[CLSCompliant(false)]
public RhinoObject[] FindByCrossingWindowRegion(RhinoViewport viewport, Point2d screen1, Point2d screen2, bool inside, ObjectType filter)
Finds objects bounded by a region
Parameters:
| viewport (RhinoViewport) | viewport to use for selection |
| screen1 (Point2d) | first screen corner |
| screen2 (Point2d) | second screen corner |
| inside (bool) | should objects returned be the ones inside of this region (or outside) |
| filter (ObjectType) | 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.
Same as GetObjectList but converts the result to an array.
Parameters:
| filter (ObjectEnumeratorSettings) | 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.
Parameters:
| groupIndex (int) | Index of group to search for. |
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.
Parameters:
| layer (Layer) | Layer to search. |
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.
Parameters:
| layerName (string) | Name of layer to search. |
Returns: Array of objects that belong to the specified group or null if no objects could be found.
Parameters:
| typeFilter (ObjectType) |
public RhinoObject[] FindByUserString(string key, string value, bool caseSensitive, bool searchGeometry, bool searchAttributes, ObjectEnumeratorSettings filter)
Finds all objects whose UserString matches the search patterns.
Parameters:
| key (string) | Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters). |
| value (string) | Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters). |
| caseSensitive (bool) | If true, string comparison will be case sensitive. |
| searchGeometry (bool) | If true, UserStrings attached to the geometry of an object will be searched. |
| searchAttributes (bool) | If true, UserStrings attached to the attributes of an object will be searched. |
| filter (ObjectEnumeratorSettings) | 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.
[CLSCompliant(false)]
public RhinoObject[] FindByUserString(string key, string value, bool caseSensitive, bool searchGeometry, bool searchAttributes, ObjectType filter)
Finds all objects whose UserString matches the search patterns.
Parameters:
| key (string) | Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters). |
| value (string) | Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters). |
| caseSensitive (bool) | If true, string comparison will be case sensitive. |
| searchGeometry (bool) | If true, UserStrings attached to the geometry of an object will be searched. |
| searchAttributes (bool) | If true, UserStrings attached to the attributes of an object will be searched. |
| filter (ObjectType) | 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.
Parameters:
| key (string) | Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters). |
| value (string) | Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters). |
| caseSensitive (bool) | 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.
[CLSCompliant(false)]
public RhinoObject[] FindByWindowRegion(RhinoViewport viewport, IEnumerable<Point3d> region, bool inside, ObjectType filter)
Finds objects bounded by a polyline region
Parameters:
| viewport (RhinoViewport) | viewport to use for selection |
| region (IEnumerable<Point3d>) | list of points that define the |
| inside (bool) | should objects returned be the ones inside of this region (or outside) |
| filter (ObjectType) | filter down list by object type |
Returns: An array of RhinoObjects that are inside of this region
[CLSCompliant(false)]
public RhinoObject[] FindByWindowRegion(RhinoViewport viewport, Point2d screen1, Point2d screen2, bool inside, ObjectType filter)
Finds objects bounded by a polyline region
Parameters:
| viewport (RhinoViewport) | viewport to use for selection |
| screen1 (Point2d) | first screen corner |
| screen2 (Point2d) | second screen corner |
| inside (bool) | should objects returned be the ones inside of this region (or outside) |
| filter (ObjectType) | filter down list by object type |
Returns: An array of RhinoObjects that are inside of this region
public ClippingPlaneObject[] FindClippingPlanesForViewport(RhinoViewport viewport, bool includeHidden)
Finds all of the clipping plane objects that actively clip a viewport.
Parameters:
| viewport (RhinoViewport) | The viewport in which clipping planes are searched. |
| includeHidden (bool) | 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.Parameters:
| viewport (RhinoViewport) | The viewport in which clipping planes are searched. |
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.
Parameters:
| id (Guid) | ID of object to search for. |
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.Parameters:
| id (Guid) | ID of object to search for. |
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.
Parameters:
| settings (ObjectEnumeratorSettings) | The ObjectEnumeratorSettings settings. |
Returns: The enumerable.
GetObjectList
#Returns an enumerable based on a ObjectEnumeratorSettings filter.
Parameters:
| settings (ObjectEnumeratorSettings) | The ObjectEnumeratorSettings settings. |
Returns: The enumerable.
Parameters:
| typeFilter (ObjectType) |
Parameters:
| typeFilter (Type) |
Returns Rhino object by type.
Returns: The enumerable.
Returns Rhino object by type.
Parameters:
| settings (ObjectEnumeratorSettings) |
Returns: The enumerable.
Compute the current number of selected objects
Parameters:
| checkSubObjects (bool) | Check to see if subobjects are selected |
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.
Parameters:
| obj (RhinoObject) | object with modified grips to update. |
| deleteOriginal (bool) | 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.
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.
Parameters:
| objref (ObjRef) | reference to object to hide. |
| ignoreLayerMode (bool) | if true, the object will be hidden even if it is on a layer that is locked or off. |
| hideGroup (string) | name of the hide group to attach to the hidden object. If null or empty, no hide group is assigned. |
Returns: true if the object was successfully hidden.
If objref.Object().IsNormal() is true, then the object will be hidden.
Parameters:
| obj (RhinoObject) | |
| ignoreLayerMode (bool) | |
| hideGroup (string) |
If obj.IsNormal() is true, then the object will be hidden.
Parameters:
| obj (RhinoObject) | object to hide. |
| ignoreLayerMode (bool) | 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.
public void InvalidateBoundingBox()
Destroys the cached scene bounding box so that it will be regenerated again from scratch next time the view is regenerated
If objref.Object().IsNormal() is true, then the object will be locked.
If objref.Object().IsNormal() is true, then the object will be locked.
If obj.IsNormal() is true, then the object will be locked.
Parameters:
| obj (RhinoObject) | normal object to lock. |
| ignoreLayerMode (bool) | 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.
Parameters:
| objectId (Guid) | Id of object to modify. |
| newAttributes (ObjectAttributes) | new attributes. |
| quiet (bool) | if true, then warning message boxes are disabled. |
Returns: true if successful.
Modifies an object's attributes. Cannot be used to change object id.
Parameters:
| objref (ObjRef) | reference to object to modify. |
| newAttributes (ObjectAttributes) | new attributes. |
| quiet (bool) | if true, then warning message boxes are disabled. |
Returns: true if successful.
Modifies an object's attributes. Cannot be used to change object id.
Parameters:
| obj (RhinoObject) | object to modify. |
| newAttributes (ObjectAttributes) | new attributes. |
| quiet (bool) | 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.
Parameters:
| objectId (Guid) | Id of object to modify. |
| material (RenderMaterial) | Material to assign to this object. |
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.
Parameters:
| objRef (ObjRef) | Object to modify. |
| material (RenderMaterial) | Material to assign to this object. |
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.
Parameters:
| obj (RhinoObject) | Object to modify. |
| material (RenderMaterial) | Material to assign to this object. |
Returns: Returns true on success otherwise returns false.
Parameters:
| objId (Guid) | |
| channel (int) | |
| mapping (TextureMapping) |
Parameters:
| objRef (ObjRef) | |
| channel (int) | |
| mapping (TextureMapping) |
Parameters:
| obj (RhinoObject) | |
| channel (int) | |
| mapping (TextureMapping) |
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.
Parameters:
| filter (ObjectEnumeratorSettings) | The ObjectEnumeratorSettings filter. |
Returns: The number of objects that pass the filter.
Pick one or more objects based on a given pick context
Parameters:
| pickContext (PickContext) | settings used to define what is picked |
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.
Parameters:
| rhinoObject (RhinoObject) | A Rhino object that will be deleted. |
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.
Parameters:
| runtimeSerialNumber (uint) | A runtime serial number of the object that will be deleted. |
Returns: true if the object was purged; otherwise false.
Replaces one object with new curve object.
Replaces one object with new brep object.
Replaces one object with new curve object.
Replaces one object with new curve object.
Replaces one object with new extrusion object.
Replaces the geometry in one object.
Parameters:
| objectId (Guid) | Id of object to be replaced. |
| geometry (GeometryBase) | |
| ignoreModes (bool) |
Returns: true if successful.
Replaces one object with new hatch object.
Replaces one object with new text object.
Replaces one object with new line curve object.
Replaces one object with new mesh object.
Replaces one object with new point object.
Replaces one object with new point object.
Replaces one object with new point cloud object.
Parameters:
| objectId (Guid) | Id of object to be replaced. |
| pointcloud (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.
Replaces one object with new subd object.
Replaces one object with new surface object.
Replaces one object with new text dot object.
Replaces one object with new text object.
Parameters:
| objectId (Guid) | Id of object to be replaced. |
| text (TextEntity) | new text to be added. The text is copied. |
Returns: true if successful.
Replaces one object with new curve object.
Replaces one object with new brep object.
Replaces one object with new curve object.
Replaces one object with new curve object.
Replaces one object with new extrusion object.
Replaces the geometry in one object.
Parameters:
| objref (ObjRef) | reference to old object to be replaced. The objref.Object() will be deleted. |
| geometry (GeometryBase) | |
| ignoreModes (bool) |
Returns: true if successful.
Replaces one object with new hatch object.
Replaces one object with new text object.
Replaces one object with new line curve object.
Replaces one object with new mesh object.
Replaces one object with new point object.
Replaces one object with new point object.
Replaces one object with new point cloud object.
Parameters:
| objref (ObjRef) | reference to old object to be replaced. The objref.Object() will be deleted. |
| pointcloud (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.
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);
Parameters:
| objref (ObjRef) | reference to old object to be replaced. The objref.Object() will be deleted. |
| newObject (RhinoObject) | new replacement object - must not be in document. |
Returns: true if successful.
Replaces one object with a new SubD object.
Replaces one object with new surface object.
Replaces one object with new text dot object.
Replaces one object with new text object.
Parameters:
| objref (ObjRef) | Reference to old object to be replaced. The object objref.Object() will be deleted. |
| text (TextEntity) | new text to be added. The text is copied. |
Returns: true if successful.
Replaces the underlying instance definition of an instance object.
Replaces the underlying instance definition of an instance object.
public bool Select(Guid objectId, bool select, bool syncHighlight, bool persistentSelect, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)
Select or deselects a single object.
Parameters:
| objectId (Guid) | Id of object to select. |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
| ignoreGripsState (bool) | 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 (bool) | If true, then objects on locked layers can be selected. |
| ignoreLayerVisibility (bool) | If true, then objects on hidden layers can be selectable. |
Returns: true on success, false on failure.
Select or deselects a single object.
Parameters:
| objectId (Guid) | Id of object to select. |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
Returns: true on success, false on failure.
Select or deselects a single object.
Select or deselects a single object.
Select a single object.
Parameters:
| objectId (Guid) | Id of object to select. |
Returns: true on success, false on failure.
public bool Select(ObjRef objref, bool select, bool syncHighlight, bool persistentSelect, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)
Select or deselects a single object.
Parameters:
| objref (ObjRef) | Object represented by this ObjRef is selected. |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
| ignoreGripsState (bool) | 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 (bool) | If true, then objects on locked layers can be selected. |
| ignoreLayerVisibility (bool) | If true, then objects on hidden layers can be selectable. |
Returns: true on success, false on failure.
Select or deselects a single object.
Parameters:
| objref (ObjRef) | Object represented by this ObjRef is selected. |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
Returns: true on success, false on failure.
Select or deselects a single object.
Parameters:
| objref (ObjRef) | Object represented by this ObjRef is selected. |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
Returns: true on success, false on failure.
Select or deselects a single object.
Select a single object.
Parameters:
| objref (ObjRef) | Object represented by this ObjRef is selected. |
Returns: true on success, false on failure.
public int Select(IEnumerable<Guid> objectIds, bool select, bool syncHighlight, bool persistentSelect, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)
Select or deselect a colletion of objects.
Parameters:
| objectIds (IEnumerable<Guid>) | |
| select (bool) | If true, the object will be selected, if false, it will be deselected. |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
| ignoreGripsState (bool) | 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 (bool) | If true, then objects on locked layers can be selected. |
| ignoreLayerVisibility (bool) | 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.
Parameters:
| objectIds (IEnumerable<Guid>) | Ids of objects to select or deselect. |
| select (bool) | 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.
Parameters:
| objectIds (IEnumerable<Guid>) | Ids of objects to select. |
Returns: Number of objects successfully selected.
Selects or deselects a collection of objects.
Parameters:
| objRefs (IEnumerable<ObjRef>) | References to objects to select or deselect. |
| select (bool) | 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.
Parameters:
| objRefs (IEnumerable<ObjRef>) | References to objects to select. |
Returns: Number of objects successfully selected.
Quick way to test if any objects are currently selected
Parameters:
| objectType (ObjectType) | the type of objects to test for |
| checkSubObjects (bool) | Check to see if subobjects are selected |
public int SelectGrips(IEnumerable<GripObject> grips, bool select, bool syncHighlight, bool persistentSelect)
Selects or deselects a collection of grips in one pass, so a native CRhinoOnChangeObjectSelectState watcher sees one change rather than one per grip.
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.
Parameters:
| grips (IEnumerable<GripObject>) | 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 (bool) | If true, the grips will be selected, otherwise deselected. |
| syncHighlight (bool) | If true, then a grip is highlighted if it is selected and unhighlighted if it is not. |
| persistentSelect (bool) | Grips that are persistently selected stay selected when a command terminates. |
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.
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.
Parameters:
| grips (IEnumerable<GripObject>) | 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 (bool) | If true, the grips will be selected, otherwise deselected. |
Returns: Number of grips successfully selected or deselected.
public int SetSelectedObjects(IEnumerable<Guid> objectIds, bool syncHighlight, bool persistentSelect, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)
Set object selection.
Remarks: This method clears current selection before set the new one.
Parameters:
| objectIds (IEnumerable<Guid>) | |
| syncHighlight (bool) | If true, then the object is highlighted if it is selected and unhighlighted if is not selected. |
| persistentSelect (bool) | Objects that are persistently selected stay selected when a command terminates. |
| ignoreGripsState (bool) | 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 (bool) | If true, then objects on locked layers can be selected. |
| ignoreLayerVisibility (bool) | If true, then objects on hidden layers can be selectable. |
Returns: Number of objects successfully selected.
If Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
If objref.Object().IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
If obj.IsHidden() is true, then the object will be returned to normal (visible and selectable) mode.
Parameters:
| obj (RhinoObject) | the normal object to show. |
| ignoreLayerMode (bool) | 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.
Parameters:
| item (RhinoObject) |
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.
Parameters:
| objectId (Guid) | Id of rhino object to transform. This object will be deleted if deleteOriginal is true. |
| xform (Transform) | transformation to apply. |
| deleteOriginal (bool) | if true, the original object is deleted if false, the original object is not deleted. |
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.
Parameters:
| objref (ObjRef) | reference to object to transform. The objref.Object() will be deleted if deleteOriginal is true. |
| xform (Transform) | transformation to apply. |
| deleteOriginal (bool) | if true, the original object is deleted if false, the original object is not deleted. |
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.
Parameters:
| obj (RhinoObject) | Rhino object to transform. This object will be deleted if deleteOriginal is true. |
| xform (Transform) | transformation to apply. |
| deleteOriginal (bool) | if true, the original object is deleted if false, the original object is not deleted. |
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.
Parameters:
| objref (ObjRef) | reference to object to transform. |
| xform (Transform) | transformation to apply. |
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.
Parameters:
| obj (RhinoObject) | Rhino object to transform. |
| xform (Transform) | transformation to apply. |
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.
Parameters:
| rhinoObject (RhinoObject) |
Parameters:
| runtimeSerialNumber (uint) |
If Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
If objref.Object().IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
If obj.IsLocked() is true, then the object will be returned to normal (visible and selectable) mode.
Parameters:
| obj (RhinoObject) | locked object to unlock. |
| ignoreLayerMode (bool) | 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.