PlaneSurface

PlaneSurface

Represents a plane surface, with plane and two intervals.

Constructor

new PlaneSurface()

Extends

Members

hasBrepForm :bool

Inherited From:
Returns true if the Brep.TryConvertBrep function will be successful for this object
Type:
  • bool

isDeformable :bool

Inherited From:
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
Type:
  • bool

isSolid :bool

Inherited From:
Gets a values indicating whether a surface is solid.
Type:
  • bool

isValid :bool

Inherited From:
Tests an object to see if it is valid.
Type:
  • bool

objectType :ObjectType

Inherited From:
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
Type:
  • ObjectType

userStringCount

Inherited From:

Methods

degree(direction) → {int}

Inherited From:
Returns the maximum algebraic degree of any span (or a good estimate if curve spans are not algebraic).
Parameters:
Name Type Description
direction int 0 gets first parameter's domain, 1 gets second parameter's domain.
Returns:
The maximum degree.
Type
int

domain(direction) → {Interval}

Inherited From:
Gets the domain in a direction.
Parameters:
Name Type Description
direction int 0 gets first parameter, 1 gets second parameter.
Returns:
An interval value.
Type
Interval

duplicate() → {GeometryBase}

Inherited From:
Constructs a deep (full) copy of this object.
Returns:
An object of the same type as this, with the same properties and behavior.
Type
GeometryBase

encode()

Inherited From:
...

frameAt(u, v) → {Array}

Inherited From:
Computes the orient plane on a surface given a U and V parameter. This is the simple evaluation call with no error handling.
Parameters:
Name Type Description
u double A first parameter.
v double A second parameter.
Returns:
[bool, Plane]
  • (bool) true if this operation succeeded; otherwise false.
  • (Plane) A frame plane that will be computed during this call.
Type
Array

getBoundingBox(plane) → {Array}

Inherited From:
Aligned Bounding box solver. Gets the plane aligned bounding box.
Parameters:
Name Type Description
plane Plane Orientation plane for BoundingBox.
Returns:
[BoundingBox, Box]
  • (BoundingBox) A BoundingBox in plane coordinates.
  • (Box) Aligned box in World coordinates.
Type
Array

getNurbsFormParameterFromSurfaceParameter(surfaceS, surfaceT) → {Array}

Inherited From:
Translates a parameter from the current surface to the parameter space of the surface returned by .
Parameters:
Name Type Description
surfaceS double The parameter in the S, or sometimes U, direction, of this surface.
surfaceT double The parameter in the T, or sometimes V, direction of this surface.
Returns:
[bool, double, double]
  • (bool) True if the operation succeeded; otherwise, false.
  • (double) S on the NURBS form.
  • (double) T on the NURBS form.
Type
Array

getSpanVector(direction) → {Array.<double>}

Inherited From:
Gets array of span "knots".
Parameters:
Name Type Description
direction int 0 gets first parameter's domain, 1 gets second parameter's domain.
Returns:
An array with span vectors; or null on error.
Type
Array.<double>

getSurfaceParameterFromNurbsFormParameter(nurbsS, nurbsT) → {Array}

Inherited From:
Translates a parameter from a value on the surface returned by to the current surface.
Parameters:
Name Type Description
nurbsS double The parameter in the S, or sometimes U, direction of the NURBS form surface.
nurbsT double The parameter in the T, or sometimes V, direction of the NURBS form surface.
Returns:
[bool, double, double]
  • (bool) True if the operation succeeded; otherwise, false.
  • (double) S on this surface.
  • (double) T o n this surface.
Type
Array

getUserString()

Inherited From:
...

getUserStrings()

Inherited From:
...

isAtSeam(u, v) → {int}

Inherited From:
Tests if a surface parameter value is at a seam.
Parameters:
Name Type Description
u double Surface u parameter to test.
v double Surface v parameter to test.
Returns:
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.
Type
int

isAtSingularity(u, v, exact) → {bool}

Inherited From:
Tests if a surface parameter value is at a singularity.
Parameters:
Name Type Description
u double Surface u parameter to test.
v double Surface v parameter to test.
exact bool If true, test if (u,v) is exactly at a singularity. If false, test if close enough to cause numerical problems.
Returns:
true if surface is singular at (s,t)
Type
bool

isClosed(direction) → {bool}

Inherited From:
Gets a value indicating if the surface is closed in a direction.
Parameters:
Name Type Description
direction int 0 = U, 1 = V.
Returns:
The indicating boolean value.
Type
bool

isCone(tolerance) → {bool}

Inherited From:
Determines if the surface is a portion of a cone within a given tolerance.
Parameters:
Name Type Description
tolerance double tolerance to use when checking.
Returns:
true if the surface is a portion of a cone.
Type
bool

isCylinder(tolerance) → {bool}

Inherited From:
Determines if the surface is a portion of a cylinder within a given tolerance.
Parameters:
Name Type Description
tolerance double tolerance to use when checking.
Returns:
true if the surface is a portion of a cylinder.
Type
bool

isoCurve(direction, constantParameter) → {Curve}

Inherited From:
Gets isoparametric curve.
Parameters:
Name Type Description
direction int 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 double The parameter that was constant on the original surface.
Returns:
An isoparametric curve or null on error.
Type
Curve

isPeriodic(direction) → {bool}

Inherited From:
Gets a value indicating if the surface is periodic in a direction (default is false).
Parameters:
Name Type Description
direction int 0 = U, 1 = V.
Returns:
The indicating boolean value.
Type
bool

isPlanar(tolerance) → {bool}

Inherited From:
Tests a surface to see if it is planar to a given tolerance.
Parameters:
Name Type Description
tolerance double tolerance to use when checking.
Returns:
true if there is a plane such that the maximum distance from the surface to the plane is <= tolerance.
Type
bool

isSingular(side) → {bool}

Inherited From:
true if surface side is collapsed to a point.
Parameters:
Name Type Description
side int side of parameter space to test 0 = south, 1 = east, 2 = north, 3 = west.
Returns:
True if this specific side of the surface is singular; otherwise, false.
Type
bool

isSphere(tolerance) → {bool}

Inherited From:
Determines if the surface is a portion of a sphere within a given tolerance.
Parameters:
Name Type Description
tolerance double tolerance to use when checking.
Returns:
true if the surface is a portion of a sphere.
Type
bool

isTorus(tolerance) → {bool}

Inherited From:
Determines if the surface is a portion of a torus within a given tolerance.
Parameters:
Name Type Description
tolerance double tolerance to use when checking.
Returns:
true if the surface is a portion of a torus.
Type
bool

makeDeformable() → {bool}

Inherited From:
If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
Returns:
false if object cannot be converted to a deformable object. true if object was already deformable or was converted into a deformable object.
Type
bool

normalAt(u, v) → {Array.<x, y, z>}

Inherited From:
Computes the surface normal at a point. This is the simple evaluation call - it does not support error handling.
Parameters:
Name Type Description
u double A U parameter.
v double A V parameter.
Returns:
The normal.
Type
Array.<x, y, z>

pointAt(u, v) → {Array.<x, y, z>}

Inherited From:
Evaluates a point at a given parameter.
Parameters:
Name Type Description
u double evaluation parameters.
v double evaluation parameters.
Returns:
Point3d.Unset on failure.
Type
Array.<x, y, z>

rdkXml()

Inherited From:
...

rotate(angleRadians, rotationAxis, rotationCenter) → {bool}

Inherited From:
Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
Parameters:
Name Type Description
angleRadians double Angle of rotation in radians.
rotationAxis Array.<x, y, z> Direction of the axis of rotation.
rotationCenter Array.<x, y, z> Point on the axis of rotation.
Returns:
true if geometry successfully rotated.
Type
bool

scale(scaleFactor) → {bool}

Inherited From:
Scales the object by the specified factor. The scale is centered at the origin.
Parameters:
Name Type Description
scaleFactor double The uniform scaling factor.
Returns:
true if geometry successfully scaled.
Type
bool

setDomain(direction, domain) → {bool}

Inherited From:
Sets the domain in a direction.
Parameters:
Name Type Description
direction int 0 sets first parameter's domain, 1 sets second parameter's domain.
domain Interval A new domain to be assigned.
Returns:
true if setting succeeded, otherwise false.
Type
bool

setUserString()

Inherited From:
...

spanCount(direction) → {int}

Inherited From:
Gets number of smooth nonempty spans in the parameter direction.
Parameters:
Name Type Description
direction int 0 gets first parameter's domain, 1 gets second parameter's domain.
Returns:
The span count.
Type
int

toJSON()

Inherited From:
Create a JSON string representation of this object

toNurbsSurface() → {NurbsSurface}

Inherited From:
Gets a NURBS surface representation of this surface. Default tolerance of 0.0 is used.
Returns:
NurbsSurface on success, null on failure.
Type
NurbsSurface

transform(xform) → {bool}

Inherited From:
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.
Parameters:
Name Type Description
xform Transform Transformation to apply to geometry.
Returns:
true if geometry successfully transformed.
Type
bool

translate(translationVector) → {bool}

Inherited From:
Translates the object along the specified vector.
Parameters:
Name Type Description
translationVector Array.<x, y, z> A moving vector.
Returns:
true if geometry successfully translated.
Type
bool