Class AcGeCatmullRomCurve3d

A curve representing a Catmull-Rom spline.

//Create a closed wavey loop
const curve = new AcGeCatmullRomCurve3d( [
  new AcGePoint3d( -10, 0, 10 ),
  new AcGePoint3d( -5, 5, 5 ),
  new AcGePoint3d( 0, 0, 0 ),
  new AcGePoint3d( 5, -5, 5 ),
  new AcGePoint3d( 10, 0, 10 )
], true ); // true for closed curve

const points = curve.getPoints( 50 );

// Convert to NURBS curve
const nurbsCurve = curve.toNurbsCurve();

Hierarchy

  • AcGeCurve3d
    • AcGeCatmullRomCurve3d

Constructors

constructor

Properties

_boundingBoxNeedsUpdate isCatmullRomCurve3d type

Accessors

boundingBoxNeedUpdate box closed curveType endPoint length points startPoint tension

Methods

calculateBoundingBox getPoint getPoints setClosed setCurveType setPoints setTension transform translate

Constructors

constructor

  • new AcGeCatmullRomCurve3d(
        points?: AcGeVector3dLike[],
        closed?: boolean,
        curveType?: CatmullRomCurveType,
        tension?: number,
    ): AcGeCatmullRomCurve3d

  • Constructs a new Catmull-Rom curve.

    Parameters

    • Optionalpoints: AcGeVector3dLike[]

      An array of 3D points defining the curve.

    • Optionalclosed: boolean

      Whether the curve is closed or not.

    • OptionalcurveType: CatmullRomCurveType

      The curve type.

    • Optionaltension: number

      Tension of the curve.

    Returns AcGeCatmullRomCurve3d

Properties

Protected_boundingBoxNeedsUpdate

_boundingBoxNeedsUpdate: boolean

ReadonlyisCatmullRomCurve3d

isCatmullRomCurve3d: true

This flag can be used for type testing.

Readonlytype

type: "CatmullRomCurve3d"

The curve type identifier

Accessors

boundingBoxNeedUpdate

  • get boundingBoxNeedUpdate(): boolean

  • When this is set, it calculates the bounding box of this shape and resets this property to false. Default is false.

    Returns boolean

box

  • get box(): AcGeBox3d

  • The bounding box of this shape. Because it is a time-consuming operation to calculate the bounding box of one shape, the bounding box value is cached. It will be calculated again lazily once there are any changes to properties of this shape.

    Returns AcGeBox3d

closed

  • get closed(): boolean

  • Whether the curve is closed or not.

    Returns boolean

curveType

endPoint

  • get endPoint(): AcGePoint3d

  • End point of this curve.

    Returns AcGePoint3d

length

  • get length(): number

  • Length of this curve (approximated).

    Returns number

points

  • get points(): AcGePoint3d[]

  • An array of 3D points defining the curve.

    Returns AcGePoint3d[]

startPoint

  • get startPoint(): AcGePoint3d

  • Start point of this curve.

    Returns AcGePoint3d

tension

  • get tension(): number

  • Tension of the curve.

    Returns number

Methods

ProtectedcalculateBoundingBox

  • calculateBoundingBox(): AcGeBox3d

  • Calculate the bounding box of this curve.

    Returns AcGeBox3d

    The bounding box

getPoint

  • getPoint(t: number, optionalTarget?: AcGePoint3d): AcGePoint3d

  • Returns a point on the curve.

    Parameters

    • t: number

      A interpolation factor representing a position on the curve. Must be in the range [0,1].

    • OptionaloptionalTarget: AcGePoint3d

      The optional target vector the result is written to.

    Returns AcGePoint3d

    The position on the curve.

getPoints

  • getPoints(divisions: number): AcGePoint3d[]

  • Get an array of points along the curve

    Parameters

    • divisions: number

      Number of divisions to create

    Returns AcGePoint3d[]

    Array of points along the curve

setClosed

  • setClosed(closed: boolean): void

  • Set whether the curve is closed

    Parameters

    • closed: boolean

      Whether the curve should be closed

    Returns void

setCurveType

  • setCurveType(curveType: CatmullRomCurveType): void

  • Set the curve type

    Parameters

    Returns void

setPoints

  • setPoints(points: AcGeVector3dLike[]): void

  • Set the points defining the curve

    Parameters

    Returns void

setTension

  • setTension(tension: number): void

  • Set the tension of the curve

    Parameters

    • tension: number

      The tension value

    Returns void

transform

  • transform(matrix: AcGeMatrix3d): this

  • Transforms the curve by applying the input matrix.

    Parameters

    Returns this

    Return this curve

translate

  • translate(v: AcGeVector3dLike): AcGeShape3d

  • Return new shape translated by given vector. Translation vector may be also defined by a pair of numbers.

    Parameters

    Returns AcGeShape3d

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods