Represents a collection of coordinates with optional normal vectors and colors.
Constructors
public PointCloud()
Initializes a new instance of the PointCloud class that is empty.
Initializes a new instance of the PointCloud class, copying the content from a set of points.
Parameters:
| points (IEnumerable<Point3d>) | A list or an array of Point3d, or any object that implements IEnumerable<Point3d>. |
public PointCloud(PointCloud other)
Initializes a new instance of the PointCloud class, copying (Merge) the content of another point cloud.
Parameters:
| other (PointCloud) |
PointCloud
#Binds with the Rhino default serializer to support object persistence.
Parameters:
| info (SerializationInfo) | Some storage. |
| context (StreamingContext) | The source and destination of the stream. |
Properties
Gets a value indicating whether or not the points in this point cloud have colors assigned to them.
Gets a value indicating whether or not the points in this point cloud have normals assigned to them.
Gets a value indicating whether or not the points in this point cloud have extra values assigned to them. Extra values can be used to store a user-defined values, such as intensity.
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
HasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
HasUserData
Gets true if this class has any custom information attached to it through UserData.
IsDeformable
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
IsDocumentControlled
If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
Overrides: CommonObject.IsDocumentControlled
IsShallowDuplicate
Is this instance a 'shallow copy'. Shallow copies are no different than regular instances with the exception that they will convert to complete independent 'deep' copies if a non const operation is perform on the instance (something that mutates the internal data)
ObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
UserData
List of custom information that is attached to this class.
UserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
Indexers
Methods
Append a new point to the end of the list.
Append a new point to the end of the list.
Append a new point to the end of the list.
Append a new point to the end of the list.
Append a new point to the end of the list.
Parameters:
| point (Point3d) | Point to append. |
Appends a collection of points and normal vectors to this point cloud.
Parameters:
| points (IEnumerable<Point3d>) | Points to append. |
| colors (IEnumerable<Color>) | Colors to append. |
public void AddRange(IEnumerable<Point3d> points, IEnumerable<Vector3d> normals, IEnumerable<Color> colors, IEnumerable<double> values)
Appends a collection of points, normal vectors, colors, and extra values to this point cloud.
Parameters:
| points (IEnumerable<Point3d>) | Points to append. |
| normals (IEnumerable<Vector3d>) | Normal Vectors to append. |
| colors (IEnumerable<Color>) | Colors to append. |
| values (IEnumerable<double>) | Exta point values to append. Extra values can be used to store a user-defined values, such as intensity. |
public void AddRange(IEnumerable<Point3d> points, IEnumerable<Vector3d> normals, IEnumerable<Color> colors)
Appends a collection of points, normal vectors, and colors to this point cloud.
Parameters:
| points (IEnumerable<Point3d>) | Points to append. |
| normals (IEnumerable<Vector3d>) | Normal Vectors to append. |
| colors (IEnumerable<Color>) | Colors to append. |
Appends a collection of points and normal vectors to this point cloud.
Parameters:
| points (IEnumerable<Point3d>) | Points to append. |
| normals (IEnumerable<Vector3d>) | Normal Vectors to append. |
Exceptions:
| ArgumentException | thrown if points and normals have differing numbers of elements |
Appends a collection of points to this point cloud.
Parameters:
| points (IEnumerable<Point3d>) | Points to append. |
Appends a new PointCloudItem to the end of this point cloud.
Returns: The newly appended item.
Returns an enumerator and list indexer over point cloud locations.
Returns: The read-only list. This is a reference to the present point cloud.
public void ClearNormals()
Destroys the normal vector information in this point cloud.
public void ClearPointValues()
Destroys the extra value information in this point cloud. Extra values can be used to store a user-defined values, such as intensity.
Returns index of the closest point in the point cloud to a given test point.
Parameters:
| testPoint (Point3d) | . |
Returns: Index of point in the point cloud on success. -1 on failure.
ComponentIndex
If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.
Returns: This object's component index. If this object is not a sub-piece of a larger geometric entity, then the returned index has m_type = ComponentIndex.InvalidType and m_index = -1.
ConstructConstObject
Assigns a parent object and a sub-object index to this.
public Curve[] CreateContourCurves(Point3d contourStart, Point3d contourEnd, double interval, double absoluteTolerance)
Creates a planar curves by intersecting a plane with a point cloud.
Parameters:
| contourStart (Point3d) | Start point for vector that is normal to contour plane. |
| contourEnd (Point3d) | End point for vector that is normal to contour plane. |
| interval (double) | he interval or distance between contours. |
| absoluteTolerance (double) | The document's model absolute tolerance |
Returns: The intersection curves if successful, an empty array if unsuccessful.
public Curve[] CreateContourCurves(Point3d startPoint, Point3d endPoint, double interval, double absoluteTolerance, double maxDistance, double minDistance, bool openCurves, bool createSpline, bool createPolyline, double fitTolerance)
Creates a planar curves by intersecting a plane with a point cloud.
Parameters:
| startPoint (Point3d) | Start point for vector that is normal to contour plane. |
| endPoint (Point3d) | End point for vector that is normal to contour plane. |
| interval (double) | he interval or distance between contours. |
| absoluteTolerance (double) | The document's model absolute tolerance |
| maxDistance (double) | Maximum distance to plane. The thickness of the "slab" around the plane from which sample points are taken. Those sample points are projected to the section plane and a polyline is found that connects them. This distance depends on the size of the point cloud and the spacing of the points. |
| minDistance (double) | Minimum distance between points. A threshold for the minimum spacing between adjacent sample points. If there are points closer than that, some are not used. |
| openCurves (bool) | True for open, false for closed. |
| createSpline (bool) | Creates a smooth curve. You can create both a curve and a polyline. |
| createPolyline (bool) | Creates a polyline. You can create both a curve and a polyline. |
| fitTolerance (double) | The tolerance used to fit the curve through the polyline. |
Returns: The intersection curves if successful, an empty array if unsuccessful.
Creates a point cloud from a mesh.
Parameters:
| mesh (Mesh) | Mesh to copy vertices, vertex normals, and colors. |
Returns: A point cloud if successful, otherwise null.
public Curve[] CreateSectionCurve(Plane plane, double absoluteTolerance, double maxDistance, double minDistance, bool openCurves, bool createSpline, bool createPolyline, double fitTolerance)
Creates a planar curve by intersecting a plane with a point cloud.
Parameters:
| plane (Plane) | The plane to intersect with |
| absoluteTolerance (double) | The document's model absolute tolerance |
| maxDistance (double) | Maximum distance to plane. The thickness of the "slab" around the plane from which sample points are taken. Those sample points are projected to the section plane and a polyline is found that connects them. This distance depends on the size of the point cloud and the spacing of the points. |
| minDistance (double) | Minimum distance between points. A threshold for the minimum spacing between adjacent sample points. If there are points closer than that, some are not used. |
| openCurves (bool) | True for open, false for closed. |
| createSpline (bool) | Creates a smooth curve. You can create both a curve and a polyline. |
| createPolyline (bool) | Creates a polyline. You can create both a curve and a polyline. |
| fitTolerance (double) | The tolerance used to fit the curve through the polyline. |
Returns: The intersection curves if successful, an empty array if unsuccessful.
Creates planar curves by intersecting a plane with a point cloud.
DataCRC
Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical.
Parameters:
| currentRemainder (uint) | The current remainder value. |
Returns: CRC of the information the defines the object.
DeleteAllUserStrings
public void DeleteAllUserStrings()
Parameters:
| key (string) |
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
Overridden in order to destroy local display cache information
Parameters:
| disposing (bool) |
Overrides: CommonObject.Dispose
Returns: An object of the same type as this, with the same properties and behavior.
DuplicateShallow
Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy.
Returns: An object of the same type as this object.
This behavior is overridden by implementing classes.
EnsurePrivateCopy
public void EnsurePrivateCopy()
If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
public bool ExpertGetValues(int index, out Point3d location, out Vector3d normal, out Color color, out double extra, out bool hidden)
Expert tool to get all values of a point cloud item. This method minimizes the number of pInvoke function calls.
Parameters:
| index (int) | The index of the point cloud item. |
| location (out Point3d) | Output location of the point cloud item. |
| normal (out Vector3d) | Output normal vector of the point cloud item. |
| color (out Color) | Output color of the point cloud item. |
| extra (out double) | Extra value of the point cloud item. |
| hidden (out bool) | Output hidden flag of the point cloud item. |
Returns: True on success.
GetBoundingBox
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
Parameters:
| accurate (bool) | If true, a physically accurate bounding box will be computed. If not, a bounding box estimate will be computed. For some geometry types there is no difference between the estimate and the accurate bounding box. Estimated bounding boxes can be computed much (much) faster than accurate (or "tight") bounding boxes. Estimated bounding boxes are always similar to or larger than accurate bounding boxes. |
Returns: The bounding box of the geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
GetBoundingBox
Aligned Bounding box solver. Gets the plane aligned bounding box.
GetBoundingBox
Aligned Bounding box solver. Gets the plane aligned bounding box.
Parameters:
| plane (Plane) | Orientation plane for BoundingBox. |
Returns: A BoundingBox in plane coordinates.
GetBoundingBox
Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
Parameters:
| xform (Transform) | Transformation to apply to object prior to the BoundingBox computation. The geometry itself is not modified. |
Returns: The accurate bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
Copy all the point colors in this point cloud to an array.
Returns: An array containing all the colors in this point cloud.
Gets an enumerator that allows to modify each point cloud point.
Copy all the normal vectors in this point cloud to an array.
Returns: An array containing all the normals in this point cloud.
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
Copy all the point coordinates in this point cloud to an array.
Returns: An array containing all the points in this point cloud.
Copy all the extra point values in this point cloud to an array. Extra values can be used to store a user-defined value, such as intensity.
Returns: An array containing all the extra point values in this point cloud.
[ConstOperation]
[CLSCompliant(false)]
public PointCloud GetRandomSubsample(uint numberOfPoints, CancellationToken cancelToken, IProgress<double> progress)
Returns a random subsample of a point cloud.
Parameters:
| numberOfPoints (uint) | The number of points the new point cloud should contain. |
| cancelToken (CancellationToken) | The cancellation token. |
| progress (IProgress<double>) | The provider for progress updates. |
Returns: A subsample of this point cloud if success, null otherwise.
Returns a random subsample of a point cloud.
Parameters:
| numberOfPoints (uint) | The number of points the new point cloud should contain. |
Returns: A subsample of this point cloud if success, null otherwise.
Allows the developer to obtain unsafe pointers to the underlying unmanaged data structures of the PointCloud.
Remarks: The lock implements the IDisposable interface, and one call of its IDisposable.Dispose() or ReleaseUnsafeLock(PointCloudUnsafeLock) will update the data structure as required. This can be achieved with a using statement (Using in Vb.Net).
Parameters:
| writable (bool) | true if user will need to write onto the structure. false otherwise. |
Returns: A lock that needs to be released.
Parameters:
| key (string) | id used to retrieve the string. |
Returns: string associated with the key if successful. null if no key was found.
GetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
Inserts a new point into the point list.
Inserts a new point into the point list.
Inserts a new point into the point list.
Inserts a new point into the point list.
Inserts a new point into the point list.
Inserts a new PointCloudItem at a specific position of the point cloud.
Parameters:
| index (int) | Index of new item. |
Returns: The newly inserted item.
Append a collection of points to this point cloud.
Parameters:
| index (int) | Index at which to insert the new collection. |
| points (IEnumerable<Point3d>) | Points to append. |
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
MakeDeformable
If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
Returns: false if object cannot be converted to a deformable object. true if object was already deformable or was converted into a deformable object.
MemoryEstimate
Computes an estimate of the number of bytes that this object is using in memory.
Returns: An estimated memory footprint.
Merges, or appends, a specified point cloud into this one.
Parameters:
| other (PointCloud) | PointCloud to merge with this one. |
NonConstOperation
protected override void NonConstOperation()
Destroy cache handle
Overrides: CommonObject.NonConstOperation
OnSwitchToNonConst
protected override void OnSwitchToNonConst()
Is called when a non-constant operation occurs.
Overrides: CommonObject.OnSwitchToNonConst
Returns the location of the point at a specific index.
Parameters:
| index (int) | The index. |
Updates the PointCloud data with the information that was stored via the PointCloudUnsafeLock.
Parameters:
| pointCloudData (PointCloudUnsafeLock) | The data that will be unlocked. |
Remove the point at the given index.
Parameters:
| index (int) | Index of point to remove. |
Removes points at given indices.
Parameters:
| indices (IEnumerable<int>) | An array of indices of the points to remove. |
Returns: The number of points removed from the point cloud.
Rotate
Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
Scale
Scales the object by the specified factor. The scale is centered at the origin.
Parameters:
| scaleFactor (double) | The uniform scaling factor. |
Returns: true if geometry successfully scaled.
SetUserString
Attach a user string (key,value combination) to this geometry.
Returns a ShrinkWrap mesh from this point cloud object.
Parameters:
| parameters (ShrinkWrapParameters) |
Split a point cloud into two parts using a plane, or returns false if the pointcloud is not partitioned by plane.
Parameters:
| plane (Plane) | The splitting plane |
| above (out PointCloud) | The part of the point cloud that is above the plane |
| below (out PointCloud) | The part of the point cloud that is below the plane |
Returns: true on success, false if the plane does not partition the cloud, or on error.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
Transform
Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it.
Parameters:
| xform (Transform) | Transformation to apply to geometry. |
Returns: true if geometry successfully transformed.
Translate
Translates the object along the specified vector.
Translate
Translates the object along the specified vector.
Parameters:
| translationVector (Vector3d) | A moving vector. |
Returns: true if geometry successfully translated.