Represents a base class that is common to most RhinoCommon surface types.

A surface represents an entity that can be all visited by providing two independent parameters, usually called (u, v), or sometimes (s, t).

Constructors

Surface

#
Protected constructor for internal use.
protected Surface()

Surface

#
Protected constructor for internal use.
protected Surface(
info,
Serialization data.
context
Serialization stream.
)

Properties

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

HasBrepForm

Returns true if the Brep.TryConvertBrep function will be successful for this object
public bool HasBrepForm { get; }
inherited fromGeometryBase

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

IsDeformable

true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
public bool IsDeformable { get; }
inherited fromGeometryBase

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.
public sealed override bool IsDocumentControlled { get; }
inherited fromGeometryBase

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)
public bool IsShallowDuplicate { get; }
inherited fromGeometryBase

IsSolid

#Since v5.0
Gets a values indicating whether a surface is solid.
public virtual bool IsSolid { get; }

IsSubDFriendly

#Since v7.0
Returns true if the surface is a non-rational, uniform, natural or periodic, cubic NURBS surface. Otherwise, false is returned.
public bool IsSubDFriendly { get; }

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
[CLSCompliant(false)] public ObjectType ObjectType { get; }
inherited fromGeometryBase

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

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.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UserStringCount

Gets the amount of user strings.
public int UserStringCount { get; }
inherited fromGeometryBase

Methods

ClosestPoint

#ExampleSince v5.0
Input the parameters of the point on the surface that is closest to testPoint.
[ConstOperation] public bool ClosestPoint(
testPoint,
A point to test against.
out double
u,
U parameter of the surface that is closest to testPoint.
out double
v
V parameter of the surface that is closest to testPoint.
)
true on success, false on failure.

ClosestSide

#Since v5.0
Gets the side that is closest, in terms of 3D-distance, to a U and V parameter.
[ConstOperation] public IsoStatus ClosestSide(
u,
A u parameter.
v
A v parameter.
)
A side.

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.
[ConstOperation] public ComponentIndex ComponentIndex()
inherited fromGeometryBase
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.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

CreateExtrusion

#Since v5.0
Constructs a surface by extruding a curve along a vector.
public static Surface CreateExtrusion(
profile,
Profile curve to extrude.
direction
Direction and length of extrusion.
)
A surface on success or null on failure.

CreateExtrusionToPoint

#Since v5.0
Constructs a surface by extruding a curve to a point.
public static Surface CreateExtrusionToPoint(
profile,
Profile curve to extrude.
apexPoint
Apex point of extrusion.
)
A Surface on success or null on failure.

CreatePeriodicSurface

#Since v6.0
Constructs a periodic surface from a base surface and a direction.
public static Surface CreatePeriodicSurface(
surface,
The surface to make periodic.
direction,
The direction to make periodic, either 0 = U, or 1 = V.
bSmooth
Controls kink removal. If true, smooths any kinks in the surface and moves control points to make a smooth surface. If false, control point locations are not changed or changed minimally (only one point may move) and only the knot vector is altered.
)
A periodic surface if successful, null on failure.

CreatePeriodicSurface

#Since v5.0
Constructs a periodic surface from a base surface and a direction.
public static Surface CreatePeriodicSurface(
surface,
The surface to make periodic.
direction
The direction to make periodic, either 0 = U, or 1 = V.
)
A Surface on success or null on failure.

CreateRollingBallFillet

#Since v5.0
Constructs a rolling ball fillet between two surfaces.
public static Surface[] CreateRollingBallFillet(
surfaceA,
A first surface.
flipA,
A value that indicates whether A should be used in flipped mode.
surfaceB,
A second surface.
flipB,
A value that indicates whether B should be used in flipped mode.
radius,
A radius value.
tolerance
A tolerance value.
)
A new array of rolling ball fillet surfaces; this array can be empty on failure.
ArgumentNullExceptionIf surfaceA or surfaceB are null.

CreateRollingBallFillet

#Since v5.0
Constructs a rolling ball fillet between two surfaces.
public static Surface[] CreateRollingBallFillet(
surfaceA,
A first surface.
uvA,
A point in the parameter space of FaceA near where the fillet is expected to hit the surface.
surfaceB,
A second surface.
uvB,
A point in the parameter space of FaceB near where the fillet is expected to hit the surface.
radius,
A radius value.
tolerance
A tolerance value used for approximating and intersecting offset surfaces.
)
A new array of rolling ball fillet surfaces; this array can be empty on failure.
ArgumentNullExceptionIf surfaceA or surfaceB are null.

CreateRollingBallFillet

#Since v5.0
Constructs a rolling ball fillet between two surfaces.
public static Surface[] CreateRollingBallFillet(
surfaceA,
A first surface.
surfaceB,
A second surface.
radius,
A radius value.
tolerance
A tolerance value.
)
A new array of rolling ball fillet surfaces; this array can be empty on failure.
ArgumentNullExceptionIf surfaceA or surfaceB are null.

CreateSoftEditSurface

#Since v6.0
Creates a soft edited surface from an existing surface using a smooth field of influence.
public static Surface CreateSoftEditSurface(
surface,
The surface to soft edit.
uv,
A point in the parameter space to move from. This location on the surface is moved, and the move is smoothly tapered off with increasing distance along the surface from this parameter.
delta,
The direction and magnitude, or maximum distance, of the move.
uLength,
The distance along the surface's u-direction from the editing point over which the strength of the editing falls off smoothly.
vLength,
The distance along the surface's v-direction from the editing point over which the strength of the editing falls off smoothly.
tolerance,
The active document's model absolute tolerance.
fixEnds
Keeps edge locations fixed.
)
The soft edited surface if successful. null on failure.

CreateTweenSurfacesWithSampling

#Since v8.14
Create tween surfaces that gradually transition between two bounding surfaces using point sampling.
public static Surface[] CreateTweenSurfacesWithSampling(
surface0,
The first, or starting, surface.
surface1,
The second, or ending, curve.
numSurfaces,
Number of tween surfaces to create.
numSamples,
Number of sample points along input surfaces.
tolerance
The tolerance. When in doubt, use the document's model absolute tolerance.
)
>An array of tween surfaces if successful, an empty array on error.

CurvatureAt

#ExampleSince v5.0
Computes the curvature at the given UV coordinate.
[ConstOperation] public SurfaceCurvature CurvatureAt(
u,
U parameter for evaluation.
v
V parameter for evaluation.
)
Surface Curvature data for the point at UV or null on failure.

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.
[CLSCompliant(false)] public uint DataCRC(
currentRemainder
The current remainder value.
)
inherited fromGeometryBase
CRC of the information the defines the object.

Degree

#Since v5.0
Returns the maximum algebraic degree of any span (or a good estimate if curve spans are not algebraic).
[ConstOperation] public int Degree(
direction
0 gets first parameter's domain, 1 gets second parameter's domain.
)
The maximum degree.

DeleteAllUserStrings

public void DeleteAllUserStrings()
inherited fromGeometryBase

DeleteUserString

public bool DeleteUserString(
key
)
inherited fromGeometryBase

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

Overridden in order to destroy local display cache information
protected override void Dispose(
disposing
)
inherited fromGeometryBase

Domain

#Since v5.0
Gets the domain in a direction.
[ConstOperation] public Interval Domain(
direction
0 gets first parameter, 1 gets second parameter.
)
An interval value.

Duplicate

Constructs a deep (full) copy of this object.
public virtual GeometryBase Duplicate()
inherited fromGeometryBase
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.
public GeometryBase DuplicateShallow()
inherited fromGeometryBase
An object of the same type as this object.

This behavior is overridden by implementing classes.

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 void EnsurePrivateCopy()
inherited fromCommonObject

Evaluate

#Since v5.0
Evaluates a surface mathematically.
[ConstOperation] public bool Evaluate(
u,
A U parameter.
v,
A V parameter.
numberDerivatives,
The number of derivatives.
out Point3d
point,
A point. This out parameter will be assigned during this call.
out Vector3d[]
derivatives
A vector array. This out parameter will be assigned during this call. This can be null.
)
Remarks: The partial derivatives will be in the order {Su, Sv} for numberDerivatives = 1, {Su, Sv, Suu, Suv, Svv} for 2, {Su, Sv, Suu, Suv, Svv, Suuu, Suuv, Suvv, Svvv} for 3, and similar for higher counts.
true if the operation succeeded; false otherwise.

Extend

#Since v7.4
Analytically extends the surface to include the interval.
public bool Extend(
direction,
If 0, Surface.Domain(0) will include the interval. (the first surface parameter). If 1, Surface.Domain(1) will include the interval. (the second surface parameter).
interval
If the interval is not included in surface domain, the surface will be extended so that its domain includes the interval. Note, this method will fail if the surface is closed in the specified direction.
)
True if successful, false otherwise.

Extend

#Since v5.0
Extends an untrimmed surface along one edge.
[ConstOperation] public Surface Extend(
edge,
Edge to extend. Must be North, South, East, or West.
extensionLength,
distance to extend.
smooth
true for smooth (C-infinity) extension. false for a C1- ruled extension.
)
New extended surface on success.

Fit

#Since v5.0
Fits a new surface through an existing surface.
[ConstOperation] public Surface Fit(
uDegree,
the output surface U degree. Must be bigger than 1.
vDegree,
the output surface V degree. Must be bigger than 1.
fitTolerance
The fitting tolerance.
)
A surface, or null on error.

FitCurveToSurface

#Since v8.0
public Curve[] FitCurveToSurface(
trimCurve3d,
curve that will trim from one edge to the opposite
trimProjectionDir,
Vector for projection, or zero vector for no projection
tolerance,
3d tolerance for projection, splitting, fitting...
Knots,
For TrimParamKnots=3, the custom knots to add
divideIntoSections,
If true, the surface is divided at each knot
ref Curve
trimCurveOnSurface,
the actual trim curve as it is projected on or pulled to the surface
ref Curve
splitCurve
the actual fit curve the split the surface
)

FrameAt

#ExampleSince v5.0
Computes the orient plane on a surface given a U and V parameter.

This is the simple evaluation call with no error handling.

[ConstOperation] public bool FrameAt(
u,
A first parameter.
v,
A second parameter.
out Plane
frame
A frame plane that will be computed during this call.
)
true if this operation succeeded; otherwise false.

GetBoundingBox

Bounding box solver. Gets the world axis aligned bounding box for the geometry.
[ConstOperation] public BoundingBox GetBoundingBox(
accurate
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.
)
inherited fromGeometryBase
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.
[ConstOperation] public BoundingBox GetBoundingBox(
plane,
Orientation plane for BoundingBox.
out Box
worldBox
Aligned box in World coordinates.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

Aligned Bounding box solver. Gets the plane aligned bounding box.
[ConstOperation] public BoundingBox GetBoundingBox(
plane
Orientation plane for BoundingBox.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
[ConstOperation] public virtual BoundingBox GetBoundingBox(
xform
Transformation to apply to object prior to the BoundingBox computation. The geometry itself is not modified.
)
inherited fromGeometryBase
The accurate bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.

GetNextDiscontinuity

#Since v7.4
Searches for a derivative, tangent, or curvature discontinuity.
[ConstOperation] public bool GetNextDiscontinuity(
direction,
If 0, then "u" parameter is checked. If 1, then the "v" parameter is checked.
continuityType,
The desired continuity.
t0,
Search begins at t0. If there is a discontinuity at t0, it will be ignored. This makes it possible to repeatedly call GetNextDiscontinuity and step through the discontinuities.
t1,
(t0 != t1) If there is a discontinuity at t1 is will be ignored unless c is a locus discontinuity type and t1 is at the start or end of the curve.
cosAngleTolerance,
default = cos(1 degree) Used only when continuityType is G1_continuous or G2_continuous. If the cosine of the angle between two tangent vectors is <= cos_angle_tolerance, then a G1 discontinuity is reported.
curvatureTolerance,
(default = ON_SQRT_EPSILON) Used only when continuityType is G2_continuous. If K0 and K1 are curvatures evaluated from above and below and |K0 - K1| > curvature_tolerance, then a curvature discontinuity is reported.
out double
t
if a discontinuity is found, then t reports the parameter at the discontinuity.
)
Parametric continuity tests c = (C0_continuous, ..., G2_continuous): TRUE if a parametric discontinuity was found strictly between t0 and t1. Note well that all curves are parametrically continuous at the ends of their domains. Locus continuity tests c = (C0_locus_continuous, ...,G2_locus_continuous): TRUE if a locus discontinuity was found strictly between t0 and t1 or at t1 is the at the end of a curve. Note well that all open curves (IsClosed()=false) are locus discontinuous at the ends of their domains. All closed curves (IsClosed()=true) are at least C0_locus_continuous at the ends of their domains.

GetNextDiscontinuity

#Since v5.0
Searches for a derivative, tangent, or curvature discontinuity.
[ConstOperation] public bool GetNextDiscontinuity(
direction,
If 0, then "u" parameter is checked. If 1, then the "v" parameter is checked.
continuityType,
The desired continuity.
t0,
Search begins at t0. If there is a discontinuity at t0, it will be ignored. This makes it possible to repeatedly call GetNextDiscontinuity and step through the discontinuities.
t1,
(t0 != t1) If there is a discontinuity at t1 is will be ignored unless c is a locus discontinuity type and t1 is at the start or end of the curve.
out double
t
if a discontinuity is found, then t reports the parameter at the discontinuity.
)
Parametric continuity tests c = (C0_continuous, ..., G2_continuous): TRUE if a parametric discontinuity was found strictly between t0 and t1. Note well that all curves are parametrically continuous at the ends of their domains. Locus continuity tests c = (C0_locus_continuous, ...,G2_locus_continuous): TRUE if a locus discontinuity was found strictly between t0 and t1 or at t1 is the at the end of a curve. Note well that all open curves (IsClosed()=false) are locus discontinuous at the ends of their domains. All closed curves (IsClosed()=true) are at least C0_locus_continuous at the ends of their domains.

GetNurbsFormParameterFromSurfaceParameter

#Since v6.0
Translates a parameter from the current surface to the parameter space of the surface returned by ToNurbsSurface().
[ConstOperation] public bool GetNurbsFormParameterFromSurfaceParameter(
surfaceS,
The parameter in the S, or sometimes U, direction, of this surface.
surfaceT,
The parameter in the T, or sometimes V, direction of this surface.
out double
nurbsS,
S on the NURBS form.
out double
nurbsT
T on the NURBS form.
)
True if the operation succeeded; otherwise, false.

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

GetSpanVector

#Since v5.0
Gets array of span "knots".
[ConstOperation] public double[] GetSpanVector(
direction
0 gets first parameter's domain, 1 gets second parameter's domain.
)
An array with span vectors; or null on error.

GetSurfaceParameterFromNurbsFormParameter

#Since v6.0
Translates a parameter from a value on the surface returned by ToNurbsSurface() to the current surface.
[ConstOperation] public bool GetSurfaceParameterFromNurbsFormParameter(
nurbsS,
The parameter in the S, or sometimes U, direction of the NURBS form surface.
nurbsT,
The parameter in the T, or sometimes V, direction of the NURBS form surface.
out double
surfaceS,
S on this surface.
out double
surfaceT
T o n this surface.
)
True if the operation succeeded; otherwise, false.

GetSurfaceSize

#Since v5.0
Gets an estimate of the size of the rectangle that would be created if the 3d surface where flattened into a rectangle.
[ConstOperation] public bool GetSurfaceSize(
out double
width,
corresponds to the first surface parameter.
out double
height
corresponds to the second surface parameter.
)
true if successful.
Re-parameterize a surface to minimize distortion in the map from parameter space to 3d. Surface surf = ...; double width, height; if ( surf.GetSurfaceSize( out width, out height ) ) { surf.SetDomain( 0, new ON_Interval( 0.0, width ) ); surf.SetDomain( 1, new ON_Interval( 0.0, height ) ); }

GetUserString

Gets user string from this geometry.
public string GetUserString(
key
id used to retrieve the string.
)
inherited fromGeometryBase
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.
public NameValueCollection GetUserStrings()
inherited fromGeometryBase
A new collection.

HasNurbsForm

#Since v5.0
Is there a NURBS surface representation of this surface.
[ConstOperation] public int HasNurbsForm()
0 unable to create NURBS representation with desired accuracy. 1 success - NURBS parameterization matches the surface's 2 success - NURBS point locus matches the surface's and the domain of the NURBS surface is correct. However, This surface's parameterization and the NURBS surface parameterization may not match. This situation happens when getting NURBS representations of surfaces that have a transcendental parameterization like spheres, cylinders, and cones.

InterpolatedCurveOnSurface

#Since v5.0
Constructs an interpolated curve on a surface, using 3D points.
[ConstOperation] public NurbsCurve InterpolatedCurveOnSurface(
points,
A list, an array or any enumerable set of points.
tolerance
A tolerance value.
)
A new NURBS curve, or null on error.

InterpolatedCurveOnSurfaceUV

#Since v6.18
Returns a curve that interpolates points on a surface. The interpolant lies on the surface.
[ConstOperation] public NurbsCurve InterpolatedCurveOnSurfaceUV(
points,
List of at least two UV parameter locations on the surface.
tolerance,
Tolerance used for the fit of the push-up curve. Generally, the resulting interpolating curve will be within tolerance of the surface.
closed,
If false, the interpolating curve is not closed. If true, the interpolating curve is closed, and the last point and first point should generally not be equal.
closedSurfaceHandling
If 0, all points must be in the rectangular domain of the surface. If the surface is closed in some direction, then this routine will interpret each point and place it at an appropriate location in the covering space. This is the simplest option and should give good results. If 1, then more options for more control of handling curves going across seams are available. If the surface is closed in some direction, then the points are taken as points in the covering space. Example, if srf.IsClosed(0)=true and srf.IsClosed(1)=false and srf.Domain(0)=srf.Domain(1)=Interval(0,1) then if closedSurfaceHandling=1 a point(u, v) in points can have any value for the u coordinate, but must have 0<=v<=1. In particular, if points = { (0.0,0.5), (2.0,0.5) } then the interpolating curve will wrap around the surface two times in the closed direction before ending at start of the curve. If closed=true the last point should equal the first point plus an integer multiple of the period on a closed direction.
)
A new NURBS curve if successful, or null on error.

InterpolatedCurveOnSurfaceUV

#Since v5.0
Returns a curve that interpolates points on a surface. The interpolant lies on the surface.
[ConstOperation] public NurbsCurve InterpolatedCurveOnSurfaceUV(
points,
List of at least two UV parameter locations on the surface.
tolerance
Tolerance used for the fit of the push-up curve. Generally, the resulting interpolating curve will be within tolerance of the surface.
)
A new NURBS curve if successful, or null on error.

IsAtSeam

#Since v5.0
Tests if a surface parameter value is at a seam.
[ConstOperation] public int IsAtSeam(
u,
Surface u parameter to test.
v
Surface v parameter to test.
)
0 if not a seam, 1 if u == Domain(0)[i] and srf(u, v) == srf(Domain(0)[1-i], v) 2 if v == Domain(1)[i] and srf(u, v) == srf(u, Domain(1)[1-i]) 3 if 1 and 2 are true.

IsAtSingularity

#Since v5.0
Tests if a surface parameter value is at a singularity.
[ConstOperation] public bool IsAtSingularity(
u,
Surface u parameter to test.
v,
Surface v parameter to test.
exact
If true, test if (u,v) is exactly at a singularity. If false, test if close enough to cause numerical problems.
)
true if surface is singular at (s,t)

IsClosed

#Since v5.0
Gets a value indicating if the surface is closed in a direction.
[ConstOperation] public bool IsClosed(
direction
0 = U, 1 = V.
)
The indicating boolean value.

IsCone

#Since v5.0
Determines if the surface is a portion of a cone within RhinoMath.ZeroTolerance.
[ConstOperation] public bool IsCone()
true if the surface is a portion of a cone.

IsCone

#Since v5.0
Determines if the surface is a portion of a cone within a given tolerance.
[ConstOperation] public bool IsCone(
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a cone.

IsContinuous

#Since v5.0
Tests continuity at a surface parameter value.
[ConstOperation] public bool IsContinuous(
continuityType,
The continuity type to sample.
u,
Surface u parameter to test.
v
Surface v parameter to test.
)
true if the surface has at least the specified continuity at the (u,v) parameter.

IsCylinder

#Since v5.0
Determines if the surface is a portion of a cylinder within RhinoMath.ZeroTolerance.
[ConstOperation] public bool IsCylinder()
true if the surface is a portion of a cylinder.

IsCylinder

#Since v5.0
Determines if the surface is a portion of a cylinder within a given tolerance.
[ConstOperation] public bool IsCylinder(
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a cylinder.

IsExtrusion

#Since v9.0
Determines if the surface is a portion of an extrusion within RhinoMath.ZeroTolerance.
[ConstOperation] public bool IsExtrusion()
true if the surface is an extrusion.

IsExtrusion

#Since v9.0
Determines if the surface is a portion of an extrusion within a given tolerance.
[ConstOperation] public bool IsExtrusion(
tolerance
tolerance to use when checking.
)
true if the surface is an extrusion.

IsIsoparametric

#Since v5.0
Determines if a 2d bounding box is isoparametric in the parameter space of this surface.
[ConstOperation] public IsoStatus IsIsoparametric(
bbox
Bounding box to test.
)
IsoStatus flag describing the iso-parametric relationship between the surface and the bounding box.

IsIsoparametric

#Since v5.0
Determines if a 2D curve is isoparametric in the parameter space of this surface.
[ConstOperation] public IsoStatus IsIsoparametric(
curve,
Curve to test.
curveDomain
Sub domain of the curve.
)
IsoStatus flag describing the iso-parametric relationship between the surface and the curve.

IsIsoparametric

#Since v5.0
Determines if a 2d curve is isoparametric in the parameter space of this surface.
[ConstOperation] public IsoStatus IsIsoparametric(
curve
Curve to test.
)
IsoStatus flag describing the iso-parametric relationship between the surface and the curve.

IsoCurve

#ExampleSince v5.0
Gets isoparametric curve.
[ConstOperation] public Curve IsoCurve(
direction,
0 first parameter varies and second parameter is constant e.g., point on IsoCurve(0,c) at t is srf(t,c) This is a horizontal line from left to right 1 first parameter is constant and second parameter varies e.g., point on IsoCurve(1,c) at t is srf(c,t This is a vertical line from bottom to top.
constantParameter
The parameter that was constant on the original surface.
)
Remarks: In this function "direction" indicates which direction the resulting curve runs. 0: horizontal, 1: vertical In the other Surface functions that take a "direction" argument, "direction" indicates if "constantParameter" is a "u" or "v" parameter.
An isoparametric curve or null on error.

IsoCurve

#Since v9.0
Gets isoparametric curve. IsoStatus.None is not supported, and IsoStatus.X and IsoStatus.Y need valid t-values in the U- or V-domain respectively.
[ConstOperation] public Curve IsoCurve(
iso,
IsoStatus.North returns the curve where U varies and V is V_max (paramter t is ignored) IsoStatus.East returns the curve where V varies and U is U_max (paramter t is ignored) IsoStatus.South returns the curve where U varies and V is V_min (paramter t is ignored) IsoStatus.West returns the curve where V varies and U is U_min (paramter t is ignored) IsoStatus.X returns the curve where V varies and U is t (if t is inside the U-domain) IsoStatus.Y returns the curve where U varies and V is t (if t is inside the V-domain)
t
the parameter used if iso is X or Y.
)
An isoparametric curve or null on error.

IsoCurve

#Since v9.0
Gets isoparametric curve that corresponds to one of the four surface edges. Other IsoStatus values are not supported.
[ConstOperation] public Curve IsoCurve(
iso
IsoStatus.North returns the curve where U varies and V is V_max IsoStatus.East returns the curve where V varies and U is U_max IsoStatus.South returns the curve where U varies and V is V_min IsoStatus.West returns the curve where V varies and U is U_min
)
An isoparametric curve or null on error.

IsPeriodic

#Since v5.0
Gets a value indicating if the surface is periodic in a direction (default is false).
[ConstOperation] public bool IsPeriodic(
direction
0 = U, 1 = V.
)
The indicating boolean value.

IsPlanar

#ExampleSince v5.0
Tests a surface to see if it is planar to zero tolerance.
[ConstOperation] public bool IsPlanar()
true if the surface is planar (flat) to within RhinoMath.ZeroTolerance units (1e-12).

IsPlanar

#Since v5.0
Tests a surface to see if it is planar to a given tolerance.
[ConstOperation] public bool IsPlanar(
tolerance
tolerance to use when checking.
)
true if there is a plane such that the maximum distance from the surface to the plane is <= tolerance.

IsSingular

#Since v5.0
true if surface side is collapsed to a point.
[ConstOperation] public bool IsSingular(
side
side of parameter space to test 0 = south, 1 = east, 2 = north, 3 = west.
)
True if this specific side of the surface is singular; otherwise, false.

IsSphere

#Since v5.0
Determines if the surface is a portion of a sphere within RhinoMath.ZeroTolerance.
[ConstOperation] public bool IsSphere()
true if the surface is a portion of a sphere.

IsSphere

#Since v5.0
Determines if the surface is a portion of a sphere within a given tolerance.
[ConstOperation] public bool IsSphere(
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a sphere.

IsTorus

#Since v5.0
Determines if the surface is a portion of a torus within RhinoMath.ZeroTolerance.
[ConstOperation] public bool IsTorus()
true if the surface is a portion of a torus.

IsTorus

#Since v5.0
Determines if the surface is a portion of a torus within a given tolerance.
[ConstOperation] public bool IsTorus(
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a torus.

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
true if this object is valid; false otherwise.

LocalClosestPoint

#Since v6.3
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.
[ConstOperation] public bool LocalClosestPoint(
testPoint,
A point to test against.
seedU,
The seed parameter in the U direction.
seedV,
The seed parameter in the V direction.
out double
u,
U parameter of the surface that is closest to testPoint.
out double
v
V parameter of the surface that is closest to testPoint.
)
true if the search is successful, false if the search fails.

MakeDeformable

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
public bool MakeDeformable()
inherited fromGeometryBase
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.
[CLSCompliant(false)] [ConstOperation] public uint MemoryEstimate()
inherited fromGeometryBase
An estimated memory footprint.

NonConstOperation

Destroy cache handle
protected override void NonConstOperation()
inherited fromGeometryBase

NormalAt

#ExampleSince v5.0
Computes the surface normal at a point.

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

[ConstOperation] public Vector3d NormalAt(
u,
A U parameter.
v
A V parameter.
)
The normal.

Offset

#Since v5.0
Constructs a new surface which is offset from the current surface.
[ConstOperation] public Surface Offset(
distance,
Distance (along surface normal) to offset.
tolerance
Offset accuracy.
)
The offset surface or null on failure.

OnSwitchToNonConst

Is called when a non-constant operation occurs.
protected override void OnSwitchToNonConst()
inherited fromGeometryBase

PointAt

#Since v5.0
Evaluates a point at a given parameter.
[ConstOperation] public Point3d PointAt(
u,
evaluation parameters.
v
evaluation parameters.
)
Point3d.Unset on failure.

Pullback

#Since v5.0
Pulls a 3d curve back to the surface's parameter space.
[ConstOperation] public Curve Pullback(
curve3d,
A curve.
tolerance,
the maximum acceptable 3d distance between from surface(curve_2d(t)) to the locus of points on the surface that are closest to curve_3d.
curve3dSubdomain
A sub-domain of the curve to sample.
)
2d curve.

Pullback

#Since v5.0
Pulls a 3d curve back to the surface's parameter space.
[ConstOperation] public Curve Pullback(
curve3d,
The curve to pull.
tolerance
the maximum acceptable 3d distance between from surface(curve_2d(t)) to the locus of points on the surface that are closest to curve_3d.
)
2d curve.

Pushup

#Since v5.0
Computes a 3d curve that is the composite of a 2d curve and the surface map.
[ConstOperation] public Curve Pushup(
curve2d,
a 2d curve whose image is in the surface's domain.
tolerance,
the maximum acceptable distance from the returned 3d curve to the image of curve_2d on the surface.
curve2dSubdomain
The curve interval (a sub-domain of the original curve) to use.
)
3d curve.

Pushup

#Since v5.0
Computes a 3d curve that is the composite of a 2d curve and the surface map.
[ConstOperation] public Curve Pushup(
curve2d,
a 2d curve whose image is in the surface's domain.
tolerance
the maximum acceptable distance from the returned 3d curve to the image of curve_2d on the surface.
)
3d curve.

Rebuild

#Since v5.0
Rebuilds an existing surface to a given degree and point count.
[ConstOperation] public NurbsSurface Rebuild(
uDegree,
the output surface u degree.
vDegree,
the output surface u degree.
uPointCount,
The number of points in the output surface u direction. Must be bigger than uDegree (maximum value is 1000)
vPointCount
The number of points in the output surface v direction. Must be bigger than vDegree (maximum value is 1000)
)
new rebuilt surface on success. null on failure.

RebuildOneDirection

#Since v6.7
Rebuilds an existing surface with a new surface to a given point count in either the u or v directions independently.
[ConstOperation] public NurbsSurface RebuildOneDirection(
direction,
The direction (0 = U, 1 = V).
pointCount,
The number of points in the output surface in the "direction" direction.
loftType,
The loft type
refitTolerance
The refit tolerance. When in doubt, use the document's model absolute tolerance.
)
new rebuilt surface on success. null on failure.

RefitSimplySplitSurface

#Since v8.0
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.
[ConstOperation] public bool RefitSimplySplitSurface(
trimCurve3d,
curve that will trim from one edge to the opposite
trimProjectionDir,
Vector for projection, or zero vector for no projection
tolerance,
3d tolerance for projection, splitting, fitting...
knotAdditionMode,
0: no, don't add any 1: Yes, add nKnots knots, spaced regularly over the entire surface 2: Yes, add nKnots knots, spaced regularly PER EXISTING SPAN 3: Yes, add nKnots knots, as provided in the array Knots
numInsertKnots,
FOr TrimParamKnots != 3, the number of knots to add
Knots,
For TrimParamKnots=3, the custom knots to add
sectionMode,
0: no sections, just output one "upper" and one "lower" surface 1: Yes, divide into sections at each of the input surface's existing knots 2: Yes, divide into sections at each of the "nKnot" added knot values 3: Yes, divide into sections at ALL knot values (i.e. both 1 and 2)
numNonTrimSpans,
number of spans in the non-trim parameter
meetCurve,
Drag the refit surfaces out to meet the original trim curve
oneSided,
Inputting an "active" point means you only want one side of the "split" to be refit - In other words, you want a "trim refit". Results will be returned in "srfLower"
PtActive,
Active point
outputSurface,
if true, output fit surfaces: srfLower and, if !bActivePt, srfUpper
outputCurve,
if true, output fit curve: crvEdge
ref int
numSections,
lowerSurface,
Surfaces (# = nSections) below trim curve in srf's (u,v) domain
upperSurface,
Surfaces (# = nSections) above trim curve in srf's (u,v) domain
edgeCurve,
Curves (# = nSections) fit to trim curve with srf's u/v parameter
ref double
FitMeasurement,
Calculated based on trimParamSections
ref Curve
trimCurveOnSurface,
the actual trim curve as it is projected on or pulled to the surface
ref Curve
splitCurve
the actual fit curve the split the surface
)
true for zuccess, false for failure

RefitSplit

#Since v8.0
Splits the surface into two and refits the split edge
[ConstOperation] public int RefitSplit(
curve,
The curve used to split the surface. It must be a simple division, from one edge of the parametric space to the opposite edge.
trimProjectionDir,
Vector for projection, or zero vector for no projection
tolerance,
3d tolerance for projection, splitting, fitting...
Knots,
bMeetCurve,
divideIntoSections,
If true, the surface is divided at each knot
srfLower,
Surfaces below trim curve in srf's (u,v) domain
srfUpper,
Surfaces below trim curve in srf's (u,v) domain
edgeCurve,
Curves (# = nSections) fit to trim curve with srf's u/v parameter
ref Curve
trimCurveOnSurface,
the actual trim curve as it is projected on or pulled to the surface
ref Curve
splitCurve
the actual fit curve the split the surface
)

Reverse

#Since v5.8
Same as Reverse, but if inPlace is set to true this Surface is modified instead of a new copy being created.
public Surface Reverse(
direction,
0 for first parameter's domain, 1 for second parameter's domain.
inPlace
)
If inPlace is False, a new reversed surface on success. If inPlace is true, this surface instance is returned on success.

Reverse

#Since v5.0
Reverses parameterization Domain changes from [a,b] to [-b,-a]
[ConstOperation] public Surface Reverse(
direction
0 for first parameter's domain, 1 for second parameter's domain.
)
a new reversed surface on success.

Rotate

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
public bool Rotate(
angleRadians,
Angle of rotation in radians.
rotationAxis,
Direction of the axis of rotation.
rotationCenter
Point on the axis of rotation.
)
inherited fromGeometryBase
true if geometry successfully rotated.

Scale

Scales the object by the specified factor. The scale is centered at the origin.
public bool Scale(
scaleFactor
The uniform scaling factor.
)
inherited fromGeometryBase
true if geometry successfully scaled.

SetDomain

#Since v5.0
Sets the domain in a direction.
public virtual bool SetDomain(
direction,
0 sets first parameter's domain, 1 sets second parameter's domain.
domain
A new domain to be assigned.
)
true if setting succeeded, otherwise false.

SetUserString

Attach a user string (key,value combination) to this geometry.
public bool SetUserString(
key,
id used to retrieve this string.
value
string associated with key.
)
inherited fromGeometryBase
true on success.

ShortPath

#Since v5.0
Constructs a geodesic between 2 points, used by ShortPath command in Rhino.
[ConstOperation] public Curve ShortPath(
start,
start point of curve in parameter space. Points must be distinct in the domain of the surface.
end,
end point of curve in parameter space. Points must be distinct in the domain of the surface.
tolerance
tolerance used in fitting discrete solution.
)
a geodesic curve on the surface on success. null on failure.

Smooth

#Since v6.0
Smooths a surface by averaging the positions of control points in a specified region.
public Surface Smooth(
smoothFactor,
The smoothing factor, which controls how much control points move towards the average of the neighboring control points.
bXSmooth,
When true control points move in X axis direction.
bYSmooth,
When true control points move in Y axis direction.
bZSmooth,
When true control points move in Z axis direction.
bFixBoundaries,
When true the surface edges don't move.
coordinateSystem,
The coordinates to determine the direction of the smoothing.
plane
If SmoothingCoordinateSystem.CPlane specified, then the construction plane.
)
The smoothed surface if successful, null otherwise.

Smooth

#Since v6.0
Smooths a surface by averaging the positions of control points in a specified region.
public Surface Smooth(
smoothFactor,
The smoothing factor, which controls how much control points move towards the average of the neighboring control points.
bXSmooth,
When true control points move in X axis direction.
bYSmooth,
When true control points move in Y axis direction.
bZSmooth,
When true control points move in Z axis direction.
bFixBoundaries,
When true the surface edges don't move.
coordinateSystem
The coordinates to determine the direction of the smoothing.
)
The smoothed surface if successful, null otherwise.

SpanCount

#Since v5.0
Gets number of smooth nonempty spans in the parameter direction.
[ConstOperation] public int SpanCount(
direction
0 gets first parameter's domain, 1 gets second parameter's domain.
)
The span count.

Split

#Since v5.0
Splits (divides) the surface into two parts at the specified parameter
[ConstOperation] public Surface[] Split(
direction,
0 = The surface is split vertically. The "west" side is returned as the first surface in the array and the "east" side is returned as the second surface in the array. 1 = The surface is split horizontally. The "south" side is returned as the first surface in the array and the "north" side is returned as the second surface in the array
parameter
value of constant parameter in interval returned by Domain(direction)
)
Array of two surfaces on success

ToBrep

#Since v5.0
Converts the surface into a Brep.
[ConstOperation] public Brep ToBrep()
A Brep with a similar shape like this surface or null.

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject

ToNurbsSurface

#Since v5.0
Gets a NURBS surface representation of this surface. Default tolerance of 0.0 is used.
[ConstOperation] public NurbsSurface ToNurbsSurface()
NurbsSurface on success, null on failure.

ToNurbsSurface

#Since v5.0
Gets a NURBS surface representation of this surface.
[ConstOperation] public NurbsSurface ToNurbsSurface(
tolerance,
tolerance to use when creating NURBS representation.
out int
accuracy

0 = unable to create NURBS representation with desired accuracy.

1 = success - returned NURBS parameterization matches the surface's to the desired accuracy.

2 = success - returned NURBS point locus matches the surface's to the desired accuracy and the domain of the NURBS surface is correct. However, this surface's parameterization and the NURBS surface parameterization may not match to the desired accuracy. This situation happens when getting NURBS representations of surfaces that have a transcendental parameterization like spheres, cylinders, and cones.

)
NurbsSurface on success, null on failure.

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.
public bool Transform(
Transform
xform
Transformation to apply to geometry.
)
inherited fromGeometryBase
true if geometry successfully transformed.

Translate

Translates the object along the specified vector.
public bool Translate(
x,
The X component.
y,
The Y component.
z
The Z component.
)
inherited fromGeometryBase
true if geometry successfully translated.

Translate

Translates the object along the specified vector.
public bool Translate(
translationVector
A moving vector.
)
inherited fromGeometryBase
true if geometry successfully translated.

Transpose

#Since v5.0
Transposes surface parameterization (swap U and V)
[ConstOperation] public Surface Transpose()
New transposed surface on success, null on failure.

Transpose

#Since v5.8
Transposes surface parameterization (swap U and V)
public Surface Transpose(
inPlace
)
New transposed surface on success, null on failure.

Trim

#Since v5.0
Constructs a sub-surface that covers the specified UV trimming domain.
[ConstOperation] public Surface Trim(
u,
Domain of surface along U direction to include in the subsurface.
v
Domain of surface along V direction to include in the subsurface.
)
SubSurface on success, null on failure.

TryGetCone

#Since v5.0
Tests a surface to see if it is a portion of a cone and returns the cone.
[ConstOperation] public bool TryGetCone(
out Cone
cone,
On success, the cone parameters are filled in.
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a cone.

TryGetCone

#Since v5.0
Tests a surface to see if it is a portion of a cone within RhinoMath.ZeroTolerance and return the cone.
[ConstOperation] public bool TryGetCone(
out Cone
cone
On success, the cone parameters are filled in.
)
true if the surface is a portion of a cone.

TryGetCylinder

#Since v5.0
Tests a surface to see if it is a portion of a cylinder and return the infinite cylinder.
[ConstOperation] public bool TryGetCylinder(
cylinder,
On success, the cylinder parameters are filled in.
tolerance
tolerance to use when checking.
)
Remarks: If successful, an infinite cylinder is returned. When a surface has a cylindrical shape, even if its ends are not circles on the cylinder, it returns the axis and radius. You can detect infinite cylinders using Cylinder.IsFinite.
true if the surface is a portion of a cylinder.

TryGetCylinder

#Since v5.0
Tests a surface to see if it is a portion of a cylinder within RhinoMath.ZeroTolerance and return the cylinder.
[ConstOperation] public bool TryGetCylinder(
cylinder
On success, the cylinder parameters are filled in.
)
Remarks: If successful, an infinite cylinder is returned. When a surface has a cylindrical shape, even if its ends are not circles on the cylinder, it returns the axis and radius. You can detect infinite cylinders using Cylinder.IsFinite.
true if the surface is a portion of a cylinder.

TryGetExtrusion

#Since v9.0
Tests a surface to see if it is an extrusion and returns the extrusion.
[ConstOperation] public bool TryGetExtrusion(
extrusion,
On success, the extrusion parameters are filled in.
tolerance
tolerance to use when checking.
)
true if the surface is a portion of an extrusion.

TryGetExtrusion

#Since v9.0
Tests a surface to see if it is an extrusion within RhinoMath.ZeroTolerance and returns the extrusion.
[ConstOperation] public bool TryGetExtrusion(
extrusion
On success, the extrusion parameters are filled in.
)
true if the surface is an extrusion.

TryGetFiniteCylinder

#Since v6.0
Tests a surface with the assumption that it might be a right circular cylinder and returns this geometry.
[ConstOperation] public bool TryGetFiniteCylinder(
cylinder,
On success, the cylinder parameters are filled in.
tolerance
tolerance to use when checking.
)
Remarks: If successful, a finite cylinder is returned.
true if the surface is a portion of a cylinder.

TryGetPlane

#ExampleSince v5.0
Tests a surface for planarity and return the plane.
[ConstOperation] public bool TryGetPlane(
out Plane
plane,
On success, the plane parameters are filled in.
tolerance
tolerance to use when checking.
)
true if there is a plane such that the maximum distance from the surface to the plane is <= tolerance.

TryGetPlane

#Since v5.0
Tests a surface for planarity and return the plane.
[ConstOperation] public bool TryGetPlane(
out Plane
plane
On success, the plane parameters are filled in.
)
true if there is a plane such that the maximum distance from the surface to the plane is <= RhinoMath.ZeroTolerance.

TryGetSphere

#Since v5.0
Test a surface to see if it is a portion of a sphere and return the sphere.
[ConstOperation] public bool TryGetSphere(
out Sphere
sphere,
On success, the sphere parameters are filled in.
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a sphere.

TryGetSphere

#Since v5.0
Test a surface to see if it is a portion of a sphere and return the sphere.
[ConstOperation] public bool TryGetSphere(
out Sphere
sphere
On success, the sphere parameters are filled in.
)
true if the surface is a portion of a sphere.

TryGetTorus

#Since v5.0
Tests a surface to see if it is a portion of a torus and returns the torus.
[ConstOperation] public bool TryGetTorus(
out Torus
torus,
On success, the torus parameters are filled in.
tolerance
tolerance to use when checking.
)
true if the surface is a portion of a torus.

TryGetTorus

#Since v5.0
Tests a surface to see if it is a portion of a torus within RhinoMath.ZeroTolerance and returns the torus.
[ConstOperation] public bool TryGetTorus(
out Torus
torus
On success, the torus parameters are filled in.
)
true if the surface is a portion of a torus.

VariableOffset

#Since v6.13
Copies a surface so that all locations at the corners of the copied surface are specified distances from the original surface.
public Surface VariableOffset(
uMinvMin,
Offset distance at Domain(0).Min, Domain(1).Min.
uMinvMax,
Offset distance at Domain(0).Min, Domain(1).Max.
uMaxvMin,
Offset distance at Domain(0).Max, Domain(1).Min.
uMaxvMax,
Offset distance at Domain(0).Max, Domain(1).Max.
tolerance
The offset tolerance.
)
The offset surface if successful, null otherwise.

VariableOffset

#Since v6.13
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.
public Surface VariableOffset(
uMinvMin,
Offset distance at Domain(0).Min, Domain(1).Min.
uMinvMax,
Offset distance at Domain(0).Min, Domain(1).Max.
uMaxvMin,
Offset distance at Domain(0).Max, Domain(1).Min.
uMaxvMax,
Offset distance at Domain(0).Max, Domain(1).Max.
interiorParameters,
An array of interior UV parameters to offset from.
interiorDistances,
>An array of offset distances at the interior UV parameters.
tolerance
The offset tolerance.
)
The offset surface if successful, null otherwise.