PointCloud

Public Class

Represents a collection of coordinates with optional normal vectors and colors.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.Geometry.GeometryBase
Rhino.Geometry.PointCloud

Namespace: Rhino.Geometry

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public class PointCloud : GeometryBase, IEnumerable<PointCloudItem>,
  IEnumerable

The PointCloud type exposes the following members.

Constructors

Name

Description

---

Public Method

PointCloud.

Initializes a new instance of the PointCloud class that is empty.

---

Public Method

PointCloud(IEnumerable.Point3d.)

Initializes a new instance of the PointCloud class, copying the content from a set of points.

---

Public Method

PointCloud(PointCloud)

Initializes a new instance of the PointCloud class, copying (Merge) the content of another point cloud.

---

Protected Method

PointCloud(SerializationInfo, StreamingContext)

Binds with the Rhino default serializer to support object persistence.

---

Properties

Name

Description

---

Public Property

ContainsColors

Gets a value indicating whether or not the points in this point cloud have colors assigned to them.

---

Public Property

ContainsHiddenFlags

Gets a value indicating whether or not the points in this point cloud have hidden flags assigned to them.

---

Public Property

ContainsNormals

Gets a value indicating whether or not the points in this point cloud have normals assigned to them.

---

Public Property

ContainsPointValues

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.

---

Public Property

Count

Gets the number of points in this point cloud.

---

Public Property

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

(Inherited from CommonObject.)

---

Public Property

HasBrepForm

Returns true if the Brep.TryConvertBrep function will be successful for this object

(Inherited from GeometryBase.)

---

Public Property

HasUserData

Gets true if this class has any custom information attached to it through UserData.

(Inherited from CommonObject.)

---

Public Property

HiddenPointCount

Gets the number of points that have their Hidden flag set.

---

Public Property

IsDeformable

true if object can be accurately modified with “squishy” transformations like projections, shears, and non-uniform scaling.

(Inherited from GeometryBase.)

---

Public Property

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.

(Inherited from GeometryBase.)

---

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

---

Public Property

Item

Gets the item at the given index.

---

Public Property

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

(Inherited from GeometryBase.)

---

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

---

Public Property

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.

(Inherited from CommonObject.)

---

Public Property

UserStringCount

Gets the amount of user strings.

(Inherited from GeometryBase.)

---

Methods

Name

Description

---

Public Method

Add(Point3d)

Append a new point to the end of the list.

---

Public Method

Add(Point3d, Vector3d)

Append a new point to the end of the list.

---

Public Method

Add(Point3d, Color)

Append a new point to the end of the list.

---

Public Method

Add(Point3d, Vector3d, Color)

Append a new point to the end of the list.

---

Public Method

Add(Point3d, Vector3d, Color, Double)

Append a new point to the end of the list.

---

Public Method

AddRange(IEnumerable.Point3d.)

Appends a collection of points to this point cloud.

---

Public Method

AddRange(IEnumerable.Point3d., IEnumerable.Vector3d.)

Appends a collection of points and normal vectors to this point cloud.

---

Public Method

AddRange(IEnumerable.Point3d., IEnumerable.Color.)

Appends a collection of points and normal vectors to this point cloud.

---

Public Method

AddRange(IEnumerable.Point3d., IEnumerable.Vector3d., IEnumerable.Color.)

Appends a collection of points, normal vectors, and colors to this point cloud.

---

Public Method

AddRange(IEnumerable.Point3d., IEnumerable.Vector3d., IEnumerable.Color., IEnumerable.Double.)

Appends a collection of points, normal vectors, colors, and extra values to this point cloud.

---

Public Method

AppendNew

Appends a new PointCloudItem to the end of this point cloud.

---

Public Method

AsReadOnlyListOfPoints

Returns an enumerator and list indexer over point cloud locations.

---

Public Method

ClearColors

Destroys the color information in this point cloud.

---

Public Method

ClearHiddenFlags

Destroys the hidden flag information in this point cloud.

---

Public Method

ClearNormals

Destroys the normal vector information in this point cloud.

---

Public Method

ClearPointValues

Destroys the extra value information in this point cloud. Extra values can be used to store a user-defined values, such as intensity.

---

Public Method

ClosestPoint

Returns index of the closest point in the point cloud to a given test point.

---

Public Method

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.

(Inherited from GeometryBase.)

---

Protected Method

ConstructConstObject

Assigns a parent object and a sub-object index to this.

(Inherited from CommonObject.)

---

Public Method

CreateContourCurves(Point3d, Point3d, Double, Double)

Creates a planar curves by intersecting a plane with a point cloud.

---

Public Method

CreateContourCurves(Point3d, Point3d, Double, Double, Double, Double, Boolean, Boolean, Boolean, Double)

Creates a planar curves by intersecting a plane with a point cloud.

---

Public Method

CreateSectionCurve(Plane, Double)

Creates planar curves by intersecting a plane with a point cloud.

---

Public Method

CreateSectionCurve(Plane, Double, Double, Double, Boolean, Boolean, Boolean, Double)

Creates a planar curve by intersecting a plane with a point cloud.

---

Public Method

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.

(Inherited from GeometryBase.)

---

Public Method

DeleteAllUserStrings

(Inherited from GeometryBase.)

---

Public Method

DeleteUserString

(Inherited from GeometryBase.)

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

---

Protected Method

Dispose(Boolean)

Overridden in order to destroy local display cache information

(Inherited from GeometryBase.)

---

Public Method

Duplicate

Constructs a deep (full) copy of this object.

(Inherited from GeometryBase.)

---

Public Method

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.

(Inherited from GeometryBase.)

---

Public Method

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.

(Inherited from CommonObject.)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from CommonObject.)

---

Public Method
Code Example

GetBoundingBox(Boolean)

Bounding box solver. Gets the world axis aligned bounding box for the geometry.

(Inherited from GeometryBase.)

---

Public Method
Code Example

GetBoundingBox(Plane)

Aligned Bounding box solver. Gets the plane aligned bounding box.

(Inherited from GeometryBase.)

---

Public Method

GetBoundingBox(Transform)

Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

(Inherited from GeometryBase.)

---

Public Method

GetBoundingBox(Plane, Box.)

Aligned Bounding box solver. Gets the plane aligned bounding box.

(Inherited from GeometryBase.)

---

Public Method

GetColors

Copy all the point colors in this point cloud to an array.

---

Public Method

GetEnumerator

Gets an enumerator that allows to modify each point cloud point.

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetNormals

Copy all the normal vectors in this point cloud to an array.

---

Public Method

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

(Inherited from CommonObject.)

---

Public Method

GetPoints

Copy all the point coordinates in this point cloud to an array.

---

Public Method

GetPointValues

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.

---

Public Method

GetRandomSubsample(UInt32)

Returns a random subsample of a point cloud.

---

Public Method

GetRandomSubsample(UInt32, CancellationToken, IProgress.Double.)

Returns a random subsample of a point cloud.

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method
GetUnsafeLock

Allows the developer to obtain unsafe pointers to the underlying unmanaged data structures of the PointCloud.

---

Public Method

GetUserString

Gets user string from this geometry.

(Inherited from GeometryBase.)

---

Public Method

GetUserStrings

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

(Inherited from GeometryBase.)

---

Public Method

Insert(Int32, Point3d)

Inserts a new point into the point list.

---

Public Method

Insert(Int32, Point3d, Vector3d)

Inserts a new point into the point list.

---

Public Method

Insert(Int32, Point3d, Color)

Inserts a new point into the point list.

---

Public Method

Insert(Int32, Point3d, Vector3d, Color)

Inserts a new point into the point list.

---

Public Method

Insert(Int32, Point3d, Vector3d, Color, Double)

Inserts a new point into the point list.

---

Public Method

InsertNew

Inserts a new PointCloudItem at a specific position of the point cloud.

---

Public Method

InsertRange

Append a collection of points to this point cloud.

---

Public Method

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

(Inherited from CommonObject.)

---

Public Method

MakeDeformable

If possible, converts the object into a form that can be accurately modified with “squishy” transformations like projections, shears, an non-uniform scaling.

(Inherited from GeometryBase.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

MemoryEstimate

Computes an estimate of the number of bytes that this object is using in memory.

(Inherited from GeometryBase.)

---

Public Method

Merge

Merges, or appends, a specified point cloud into this one.

---

Protected Method

NonConstOperation

Destroy cache handle

(Inherited from GeometryBase.)

---

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation occurs.

(Inherited from GeometryBase.)

---

Public Method

PointAt

Returns the location of the point at a specific index.

---

Public Method

ReleaseUnsafeLock

Updates the PointCloud data with the information that was stored via the PointCloudUnsafeLock.

---

Public Method

RemoveAt

Remove the point at the given index.

---

Public Method

RemoveRange

Removes points at given indices.

---

Public Method

Rotate

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

(Inherited from GeometryBase.)

---

Public Method

Scale

Scales the object by the specified factor. The scale is centered at the origin.

(Inherited from GeometryBase.)

---

Public Method

SetUserString

Attach a user string (key,value combination) to this geometry.

(Inherited from GeometryBase.)

---

Public Method

ShrinkWrap

Returns a ShrinkWrap mesh from this point cloud object.

---

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

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.

(Inherited from GeometryBase.)

---

Public Method

Translate(Vector3d)

Translates the object along the specified vector.

(Inherited from GeometryBase.)

---

Public Method

Translate(Double, Double, Double)

Translates the object along the specified vector.

(Inherited from GeometryBase.)

---