BrepRegion

Public Class

Represents a brep topological region that has sides.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.Geometry.BrepRegion

Namespace: Rhino.Geometry

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class BrepRegion : CommonObject

The BrepRegion type exposes the following members.

Properties

Name

Description

---

Public Property

BoundingBox

Gets the region bounding box.

---

Public Property

Brep

Gets a reference to the Brep this region belongs to.

---

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

HasUserData

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

(Inherited from CommonObject.)

---

Public Property

Index

Gets the index of region in the RegionTopology array.

---

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 CommonObject.)

---

Public Property

IsFinite

Gets a value indicating whether this region is finite.

---

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

---

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.)

---

Methods

Name

Description

---

Public Method

BoundaryBrep

Gets the boundary of a region as a brep object. If the region is finite, the boundary will be a closed manifold brep. The boundary may have more than one connected component.

---

Protected Method

ConstructConstObject

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

(Inherited from CommonObject.)

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

---

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

(Inherited from CommonObject.)

---

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

GetFaceSides

Gets an array of BrepRegionFaceSide entities delimiting this region.

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetObjectData

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

(Inherited from CommonObject.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

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.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Protected Method

NonConstOperation

(Overrides

CommonObject.NonConstOperation.

.)

---

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

(Inherited from CommonObject.)

---

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.)

---