PointGrid

PointGrid

PointGrid

Constructor

new PointGrid()

Extends

Members

hasBrepForm :bool

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

isDeformable :bool

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

isValid :bool

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

objectType :ObjectType

Description:
  • Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
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

duplicate() → {GeometryBase}

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

encode()

Description:
  • ...
Inherited From:

getBoundingBox(plane) → {Array}

Description:
  • Aligned Bounding box solver. Gets the plane aligned bounding box.
Inherited From:
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

getUserString()

Description:
  • ...
Inherited From:

getUserStrings()

Description:
  • ...
Inherited From:

makeDeformable() → {bool}

Description:
  • If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
Inherited From:
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

rdkXml()

Description:
  • ...
Inherited From:

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

Description:
  • Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
Inherited From:
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}

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

setUserString()

Description:
  • ...
Inherited From:

toJSON()

Description:
  • Create a JSON string representation of this object
Inherited From:

transform(xform) → {bool}

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

translate(translationVector) → {bool}

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