ClippingPlaneSurface

ClippingPlaneSurface class

Represents a planar surface that is used as clipping plane in viewports. A clipping plane object maintains a list of viewports that it clips against.

Inheritence: Rhino.Runtime.CommonObjectRhino.Geometry.GeometryBaseRhino.Geometry.SurfaceRhino.Geometry.PlaneSurfaceClippingPlaneSurface
Derived Classes:

Namespace: Rhino.Geometry
ClippingPlaneSurface: references

Constructors (13)

ClippingPlaneSurface()

Constructs an empty clipping plane surface

ClippingPlaneSurface(Plane plane)

Constructs a clipping plane surface from a Plane

ClippingPlaneSurface(PlaneSurface planeSurface)

Constructs a ClippingPlaneSurface from a PlaneSurface

ClippingPlaneSurface(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

GeometryBase(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

PlaneSurface()

Constructs a new plane surface.

PlaneSurface(Plane plane, Interval xExtents, Interval yExtents)

Constructs a plane surface with x and y extents.

PlaneSurface(Plane plane)

Constructs a new plane surface.

PlaneSurface(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Surface()

Protected constructor for internal use.

Surface(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Properties (18)

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.

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.

IsSolid

Gets a values indicating whether a surface is solid.

IsSubDFriendly

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

IsValid

Tests an object to see if it is valid.

ObjectType

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

ParticipationListsEnabled

Should the object and layer participation lists be used when determining clipping

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

Plane

Gets or sets the plane surface's plane.

PlaneDepth

Distance that the clipping has an effect

PlaneDepthEnabled

Determines if the PlaneDepth value should be used

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.

UserStringCount

Gets the amount of user strings.

Methods (137)

AddClipViewportId(Guid viewportId)

Adds a viewport id to the list of viewports that this clipping plane clips.

ClearClipParticipationLists()

Remove list of object ids that this clipping plane surface clips. This causes the clipping plane surface to clip all objects

ClosestPoint(Point3d testPoint, out double u, out double v)

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

ClosestSide(double u, double v)

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

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.

ConstructConstObject(object parentObject, int subobjectIndex)

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

CreateExtrusion(Curve profile, Vector3d direction)

Constructs a surface by extruding a curve along a vector.

CreateExtrusionToPoint(Curve profile, Point3d apexPoint)

Constructs a surface by extruding a curve to a point.

CreatePeriodicSurface(Surface surface, int direction, bool bSmooth)

Constructs a periodic surface from a base surface and a direction.

CreatePeriodicSurface(Surface surface, int direction)

Constructs a periodic surface from a base surface and a direction.

CreateRollingBallFillet(Surface surfaceA, bool flipA, Surface surfaceB, bool flipB, double radius, double tolerance)

Constructs a rolling ball fillet between two surfaces.

CreateRollingBallFillet(Surface surfaceA, Point2d uvA, Surface surfaceB, Point2d uvB, double radius, double tolerance)

Constructs a rolling ball fillet between two surfaces.

CreateRollingBallFillet(Surface surfaceA, Surface surfaceB, double radius, double tolerance)

Constructs a rolling ball fillet between two surfaces.

CreateSoftEditSurface(Surface surface, Point2d uv, Vector3d delta, double uLength, double vLength, double tolerance, bool fixEnds)

Creates a soft edited surface from an existing surface using a smooth field of influence.

CreateThroughBox(Line lineInPlane, Vector3d vectorInPlane, BoundingBox box)

Create a plane that contains the intersection of a bounding box.

CreateThroughBox(Plane plane, BoundingBox box)

Create a plane that contains the intersection of a bounding box.

CreateTweenSurfacesWithSampling(Surface surface0, Surface surface1, int numSurfaces, int numSamples, double tolerance)

Create tween surfaces that gradually transition between two bounding surfaces using point sampling.

CurvatureAt(double u, double v)

Computes the curvature at the given UV coordinate.

DataCRC(uint currentRemainder)

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.

Degree(int direction)

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

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

Dispose(bool disposing)

Overridden in order to destroy local display cache information

Domain(int direction)

Gets the domain in a direction.

Duplicate()

Constructs a deep (full) copy of this object.

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.

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.

Evaluate(double u, double v, int numberDerivatives, out Point3d point, out Vector3d[] derivatives)

Evaluates a surface mathematically.

Extend(int direction, Interval interval)

Analytically extends the surface to include the interval.

Extend(IsoStatus edge, double extensionLength, bool smooth)

Extends an untrimmed surface along one edge.

Fit(int uDegree, int vDegree, double fitTolerance)

Fits a new surface through an existing surface.

FitCurveToSurface(Curve trimCurve3d, Vector3d trimProjectionDir, double tolerance, IEnumerable<double> Knots, bool divideIntoSections, ref Curve trimCurveOnSurface, ref Curve splitCurve)

FrameAt(double u, double v, out Plane frame)

Computes the orient plane on a surface given a U and V parameter.
This is the simple evaluation call with no error handling.

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

GeometryEquals(GeometryBase first, GeometryBase second)

Determines if two geometries equal one another, in pure geometrical shape. This version only compares the geometry itself and does not include any user data comparisons. This is a comparison by value: for two identical items it will be true, no matter where in memory they may be stored.

GeometryReferenceEquals(GeometryBase one, GeometryBase other)

Determines if two objects are respectively shallow copies, new managed instantiations of the same geometry, or similar internal references to the exact same geometry, both in managed and in unmanaged code.

GetBoundingBox(bool accurate)

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

GetBoundingBox(Plane plane, out Box worldBox)

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

GetBoundingBox(Plane plane)

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

GetBoundingBox(Transform xform)

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

GetClipParticipation(out IEnumerable<Guid> objectIds, out IEnumerable<int> layerIndices, out bool isExclusionList)

GetExtents(int direction)

Gets the extents of the plane surface.

GetNextDiscontinuity(int direction, Continuity continuityType, double t0, double t1, double cosAngleTolerance, double curvatureTolerance, out double t)

Searches for a derivative, tangent, or curvature discontinuity.

GetNextDiscontinuity(int direction, Continuity continuityType, double t0, double t1, out double t)

Searches for a derivative, tangent, or curvature discontinuity.

GetNurbsFormParameterFromSurfaceParameter(double surfaceS, double surfaceT, out double nurbsS, out double nurbsT)

Translates a parameter from the current surface to the parameter space of the surface returned by <b>ToNurbsSurface()</b> .

GetObjectData(SerializationInfo info,StreamingContext context)

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

GetSpanVector(int direction)

Gets array of span "knots".

GetSurfaceParameterFromNurbsFormParameter(double nurbsS, double nurbsT, out double surfaceS, out double surfaceT)

Translates a parameter from a value on the surface returned by <b>ToNurbsSurface()</b> to the current surface.

GetSurfaceSize(out double width, out double height)

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

GetUserString(string key)

Gets user string from this geometry.

GetUserStrings()

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

HasNurbsForm()

Is there a NURBS surface representation of this surface.

InterpolatedCurveOnSurface(IEnumerable<Point3d> points, double tolerance)

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

InterpolatedCurveOnSurfaceUV(IEnumerable<Point2d> points, double tolerance, bool closed, int closedSurfaceHandling)

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

InterpolatedCurveOnSurfaceUV(IEnumerable<Point2d> points, double tolerance)

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

IsAtSeam(double u, double v)

Tests if a surface parameter value is at a seam.

IsAtSingularity(double u, double v, bool exact)

Tests if a surface parameter value is at a singularity.

IsClosed(int direction)

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

IsCone()

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

IsCone(double tolerance)

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

IsContinuous(Continuity continuityType, double u, double v)

Tests continuity at a surface parameter value.

IsCylinder()

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

IsCylinder(double tolerance)

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

IsIsoparametric(BoundingBox bbox)

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

IsIsoparametric(Curve curve, Interval curveDomain)

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

IsIsoparametric(Curve curve)

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

IsoCurve(int direction, double constantParameter)

Gets isoparametric curve.

IsPeriodic(int direction)

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

IsPlanar()

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

IsPlanar(double tolerance)

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

IsSingular(int side)

True if surface side is collapsed to a point.

IsSphere()

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

IsSphere(double tolerance)

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

IsTorus()

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

IsTorus(double tolerance)

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

IsValidWithLog(out string log)

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

LocalClosestPoint(Point3d testPoint, double seedU, double seedV, out double u, out double v)

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.

MakeDeformable()

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

MemoryEstimate()

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

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

NonConstOperation()

Destroy cache handle

NormalAt(double u, double v)

Computes the surface normal at a point.
This is the simple evaluation call - it does not support error handling.

Offset(double distance, double tolerance)

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

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

OnSwitchToNonConst()

Is called when a non-constant operation occurs.

PointAt(double u, double v)

Evaluates a point at a given parameter.

Pullback(Curve curve3d, double tolerance, Interval curve3dSubdomain)

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

Pullback(Curve curve3d, double tolerance)

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

Pushup(Curve curve2d, double tolerance, Interval curve2dSubdomain)

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

Pushup(Curve curve2d, double tolerance)

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

Rebuild(int uDegree, int vDegree, int uPointCount, int vPointCount)

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

RebuildOneDirection(int direction, int pointCount, LoftType loftType, double refitTolerance)

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

RefitSimplySplitSurface(Curve trimCurve3d, Vector3d trimProjectionDir, double tolerance, RefitTrimKnotMode knotAdditionMode, int numInsertKnots, IEnumerable<double> Knots, RefitTrimSectionMode sectionMode, int numNonTrimSpans, bool meetCurve, bool oneSided, Point3d PtActive, bool outputSurface, bool outputCurve, ref int numSections, List<Surface> lowerSurface, List<Surface> upperSurface, List<Curve> edgeCurve, ref double FitMeasurement, ref Curve trimCurveOnSurface, ref Curve splitCurve)

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.

RefitSplit(Curve curve, Vector3d trimProjectionDir, double tolerance, IEnumerable<double> Knots, bool bMeetCurve, bool divideIntoSections, List<Surface> srfLower, List<Surface> srfUpper, List<Curve> edgeCurve, ref Curve trimCurveOnSurface, ref Curve splitCurve)

Splits the surface into two and refits the split edge

RemoveClipViewportId(Guid viewportId)

Removes a viewport id that this being clipped by this clipping plane.

Reverse(int direction, bool inPlace)

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

Reverse(int direction)

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

Rotate(double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)

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

Scale(double scaleFactor)

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

SetClipParticipation(IEnumerable<Guid> objectIds, IEnumerable<int> layerIndices, bool isExclusionList)

Set a list of specific object ids and layers that this clipping plane surface clips.

SetDomain(int direction, Interval domain)

Sets the domain in a direction.

SetExtents(int direction, Interval extents, bool syncDomain)

Sets the extents of the plane surface.

SetUserString(string key, string value)

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

ShortPath(Point2d start, Point2d end, double tolerance)

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

Smooth(double smoothFactor, bool bXSmooth, bool bYSmooth, bool bZSmooth, bool bFixBoundaries, SmoothingCoordinateSystem coordinateSystem, Plane plane)

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

Smooth(double smoothFactor, bool bXSmooth, bool bYSmooth, bool bZSmooth, bool bFixBoundaries, SmoothingCoordinateSystem coordinateSystem)

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

SpanCount(int direction)

Gets number of smooth nonempty spans in the parameter direction.

Split(int direction, double parameter)

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

ToBrep()

Converts the surface into a Brep.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

ToMesh()

Computes a polygon mesh of the surface made of one quad.

ToNurbsSurface()

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

ToNurbsSurface(double tolerance, out int accuracy)

Gets a NURBS surface representation of this surface.

Transform(Transform xform)

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.

Translate(double x, double y, double z)

Translates the object along the specified vector.

Translate(Vector3d translationVector)

Translates the object along the specified vector.

Transpose()

Transposes surface parameterization (swap U and V)

Transpose(bool inPlace)

Transposes surface parameterization (swap U and V)

Trim(Interval u, Interval v)

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

TryGetCone(out Cone cone, double tolerance)

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

TryGetCone(out Cone cone)

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

TryGetCylinder(out Cylinder cylinder, double tolerance)

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

TryGetCylinder(out Cylinder cylinder)

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

TryGetFiniteCylinder(out Cylinder cylinder, double tolerance)

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

TryGetPlane(out Plane plane, double tolerance)

Tests a surface for planarity and return the plane.

TryGetPlane(out Plane plane)

Tests a surface for planarity and return the plane.

TryGetSphere(out Sphere sphere, double tolerance)

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

TryGetSphere(out Sphere sphere)

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

TryGetTorus(out Torus torus, double tolerance)

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

TryGetTorus(out Torus torus)

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

VariableOffset(double uMinvMin, double uMinvMax, double uMaxvMin, double uMaxvMax, double tolerance)

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

VariableOffset(double uMinvMin, double uMinvMax, double uMaxvMin, double uMaxvMax, IEnumerable<Point2d> interiorParameters, IEnumerable<double> interiorDistances, double tolerance)

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.

ViewportIds()

Returns the ids of RhinoViewport objects that are clipped by this clipping plane.

Nothing found