BrepFace Class

Gets the Brep that owns this face.

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

Index of face in Brep.Faces array.

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

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

Gets or sets the persistent id of this Brep face. By default, the id is Guid.Zero. Note, Rhino does not set this id. Thus, the property is available for use as a way of tracking Brep faces.

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

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.

Gets a values indicating whether a surface is solid.

Returns true if the surface is a non-rational, uniform, natural or periodic, cubic NURBS surface. Otherwise, false is returned.

Gets a value indicating whether the face is synonymous with the underlying surface. If a Face has no trimming curves then it is considered a Surface.

Tests an object to see if it is valid.

Loops in this face.

This face's rendering material channel index.

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

true if face orientation is opposite of natural surface orientation.

Every face has a single outer loop.

0 if the pack it is unset, or >0 if the set pack id.

If per-face color is "Empty", then this face does not have a custom color

If this face is part of a brep created by SubD.ProxyBrep(), then the subd component id of the corresponding SubD face is returned. Otherwise 0 is returned.

Surface index of the 3d surface geometry used by this face or -1

List of custom information that is attached to this class.

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

Gets the amount of user strings.

Gets the indices of all the BrepEdges that delineate this Face.

Gets the indices of all the BrepFaces that surround (are adjacent to) this face.

Expert user tool that replaces the 3d surface geometry use by the face.

Clear this face's rendering material channel index.

Sets BrepFace.PackId to 0.

Input the parameters of the point on the surface that is closest to testPoint.

Gets the side that is closest, in terms of 3D-distance, to a U and V parameter.

If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.

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

Extrude a face in a Brep.

Computes the curvature at the given UV coordinate.

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.

Returns the maximum algebraic degree of any span (or a good estimate if curve spans are not algebraic).

Actively reclaims unmanaged resources that this instance uses.

Overridden in order to destroy local display cache information

Gets the domain in a direction.

Returns the surface draft angle and point at a parameter.

Constructs a deep (full) copy of this object.

Duplicate a face from the brep to create new single face brep.

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.

Gets a copy to the untrimmed surface that this face is based on.

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.

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

Evaluates a surface mathematically.

Analytically extends the surface to include the interval.

Extends an untrimmed surface along one edge.

Creates a constant-radius fillet surface between a surface and the curve.

Creates a surface between two surfaces, with a fixed rail curve on the first surface.

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

Fits a new surface through an existing surface.

(Inherited from Surface.)

Computes the orient plane on a surface given a U and V parameter.

This is the simple evaluation call with no error handling.

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

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

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

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

Serves as the default hash function.

Obtains a reference to a specified type of mesh for this brep face.

Searches for a derivative, tangent, or curvature discontinuity.

Searches for a derivative, tangent, or curvature discontinuity.

Translates a parameter from the current surface to the parameter space of the surface returned by ToNurbsSurface.

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

Gets array of span "knots".

Translates a parameter from a value on the surface returned by ToNurbsSurface to the current surface.

Gets an estimate of the size of the rectangle that would be created if the 3d surface where flattened into a rectangle.

Gets the Type of the current instance.

Gets user string from this geometry.

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

Is there a NURBS surface representation of this surface.

Constructs an interpolated curve on a surface, using 3D points.

Returns a curve that interpolates points on a surface. The interpolant lies on the surface.

Returns a curve that interpolates points on a surface. The interpolant lies on the surface.

Tests if a surface parameter value is at a seam.

Tests if a surface parameter value is at a singularity.

Gets a value indicating if the surface is closed in a direction.

Determines if the surface is a portion of a cone within RhinoMath.ZeroTolerance.

Determines if the surface is a portion of a cone within a given tolerance.

Tests continuity at a surface parameter value.

Determines if the surface is a portion of a cylinder within RhinoMath.ZeroTolerance.

Determines if the surface is a portion of a cylinder within a given tolerance.

Determines if a 2d bounding box is isoparametric in the parameter space of this surface.

Determines if a 2d curve is isoparametric in the parameter space of this surface.

Determines if a 2D curve is isoparametric in the parameter space of this surface.

Gets isoparametric curve.

Gets a value indicating if the surface is periodic in a direction (default is false).

Tests a surface to see if it is planar to zero tolerance.

Tests a surface to see if it is planar to a given tolerance.

Tests if a parameter space point is in the active region of a face.

Tests if a parameter space point is in the active region of a face.

true if surface side is collapsed to a point.

Determines if the surface is a portion of a sphere within RhinoMath.ZeroTolerance.

Determines if the surface is a portion of a sphere within a given tolerance.

Determines if the surface is a portion of a torus within RhinoMath.ZeroTolerance.

Determines if the surface is a portion of a torus within a given tolerance.

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

Find parameters of the point on a surface that is locally closest to the testPoint. The search for a local close point starts at seed parameters.

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

Creates a shallow copy of the current Object.

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

Destroy cache handle

Computes the surface normal at a point.

This is the simple evaluation call - it does not support error handling.

Constructs a new surface which is offset from the current surface.

Is called when a non-constant operation occurs.

Evaluates a point at a given parameter.

Pulls a 3d curve back to the surface's parameter space.

Pulls a 3d curve back to the surface's parameter space.

Pulls one or more points to a brep face.

Computes a 3d curve that is the composite of a 2d curve and the surface map.

Computes a 3d curve that is the composite of a 2d curve and the surface map.

Rebuilds an existing surface to a given degree and point count.

Rebuild the edges used by a face so they lie on the surface.

Rebuilds an existing surface with a new surface to a given point count in either the u or v directions independently.

This routine accepts a 3-d trim curve (trimCrv3d). The trim curve is assumed to run from one surface edge to the opposite edge; this is referred to as a "simple" trim curve, roughly parallel to one of the srf directions (either u or v). We refer to that parameter as the "trim parameter". The routine splits the surface via the trim curve, and then refits either side ("upper" = "above the trim", and "lower" = "below the trim") as a set of untrimmed Nurbs surfaces. The idea is to retain, as much as possible, the Nurbs structure of srf, especially in the trim parameter.

Splits the surface into two and refits the split edge

The RefitTrim command replaces a trimmed surface edge with an untrimmed edge.

Remove all inner loops, or holes, from a Brep face.

Reverses parameterization Domain changes from [a,b] to [-b,-a]

Same as Reverse, but if inPlace is set to true this Surface is modified instead of a new copy being created.

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

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

Sets the surface domain of this face.

Sets a reference to a specified type of mesh for this brep face.

Used by SubD functions that create breps to transmit the subd face SubDFace.PackId value to the brep face or faces generated from the subd face. Unless you are an expert and doing something very carefully and very fancy, to not call this function.

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

Constructs a geodesic between 2 points, used by ShortPath command in Rhino.

Shrinks the underlying untrimmed surface of this Brep face close to trimming boundaries. Shrinking a surface is like extending smoothly, only backwards. knot of full multiplicity are added where you want the surface to be cut off. Then the remaining control points are thrown away.

Shrinks the underlying untrimmed surface of this Brep face right to the trimming boundaries. Note, shrinking the trimmed surface can sometimes cause problems later since having the edges so close to the trimming boundaries can cause commands that use the surface edges as input to fail.

Smooths a surface by averaging the positions of control points in a specified region.

Smooths a surface by averaging the positions of control points in a specified region.

Gets number of smooth nonempty spans in the parameter direction.

Split this face using 3D trimming curves.

Splits (divides) the surface into two parts at the specified parameter

Converts the surface into a Brep.

Create a JSON string representation of this object

Gets a NURBS surface representation of this surface. Default tolerance of 0.0 is used.

Gets a NURBS surface representation of this surface.

Returns a string that represents the current object.

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.

Translates the object along the specified vector.

Translates the object along the specified vector.

Transposes surface parameterization (swap U and V)

Transposes surface parameterization (swap U and V)

Constructs a sub-surface that covers the specified UV trimming domain.

Similar to IsoCurve function, except this function pays attention to trims on faces and may return multiple curves.

Gets intervals where the iso curve exists on a BrepFace (trimmed surface)

Tests a surface to see if it is a portion of a cone within RhinoMath.ZeroTolerance and return the cone.

Tests a surface to see if it is a portion of a cone and returns the cone.

Tests a surface to see if it is a portion of a cylinder within RhinoMath.ZeroTolerance and return the cylinder.

Tests a surface to see if it is a portion of a cylinder and return the infinite cylinder.

Tests a surface with the assumption that it might be a right circular cylinder and returns this geometry.

Tests a surface for planarity and return the plane.

Tests a surface for planarity and return the plane.

Test a surface to see if it is a portion of a sphere and return the sphere.

Test a surface to see if it is a portion of a sphere and return the sphere.

Tests a surface to see if it is a portion of a torus within RhinoMath.ZeroTolerance and returns the torus.

Tests a surface to see if it is a portion of a torus and returns the torus.

Gets the untrimmed surface that is the base of this face.

Copies a surface so that all locations at the corners of the copied surface are specified distances from the original surface.

Copies a surface so that all locations at the corners, and from specified interior locations, of the copied surface are specified distances from the original surface.