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

Index

Constructors

constructor

new AcGeCatmullRomCurve3d(
    points?: AcGeVector3dLike[],
    closed?: boolean,
    curveType?: CatmullRomCurveType,
    tension?: number,
): AcGeCatmullRomCurve3d
Constructs a new Catmull-Rom curve.
Parameters
- points: AcGeVector3dLike[] = []
  An array of 3D points defining the curve.
- closed: boolean = false
  Whether the curve is closed or not.
- curveType: CatmullRomCurveType = 'centripetal'
  The curve type.
- tension: number = 0.5
  Tension of the curve.
Returns AcGeCatmullRomCurve3d
Overrides AcGeCurve3d.constructor
- Defined in geometry/AcGeCatmullRomCurve3d.ts:161

Properties

`Protected`_boundingBoxNeedsUpdate

_boundingBoxNeedsUpdate: boolean = false

`Readonly`isCatmullRomCurve3d

isCatmullRomCurve3d: true

This flag can be used for type testing.

`Readonly`type

type: "CatmullRomCurve3d" = '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
Inherited from AcGeCurve3d.boundingBoxNeedUpdate
- Defined in geometry/AcGeShape.ts:11

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
Inherited from AcGeCurve3d.box
- Defined in geometry/AcGeShape3d.ts:32

closed

get closed(): boolean
Whether the curve is closed or not.

Returns boolean
Overrides AcGeCurve3d.closed
- Defined in geometry/AcGeCatmullRomCurve3d.ts:184

curveType

get curveType(): CatmullRomCurveType
The curve type.

Returns CatmullRomCurveType
- Defined in geometry/AcGeCatmullRomCurve3d.ts:191

endPoint

get endPoint(): AcGePoint3d
End point of this curve.

Returns AcGePoint3d
Overrides AcGeCurve3d.endPoint
- Defined in geometry/AcGeCatmullRomCurve3d.ts:212

length

get length(): number
Length of this curve (approximated).

Returns number
Overrides AcGeCurve3d.length
- Defined in geometry/AcGeCatmullRomCurve3d.ts:221

points

get points(): AcGePoint3d[]
An array of 3D points defining the curve.

Returns AcGePoint3d[]
- Defined in geometry/AcGeCatmullRomCurve3d.ts:177

startPoint

get startPoint(): AcGePoint3d
Start point of this curve.

Returns AcGePoint3d
Overrides AcGeCurve3d.startPoint
- Defined in geometry/AcGeCatmullRomCurve3d.ts:205

tension

get tension(): number
Tension of the curve.

Returns number
- Defined in geometry/AcGeCatmullRomCurve3d.ts:198

Methods

`Protected`calculateBoundingBox

calculateBoundingBox(): AcGeBox3d
Calculate the bounding box of this curve.

Returns AcGeBox3d
The bounding box
Overrides AcGeCurve3d.calculateBoundingBox
- Defined in geometry/AcGeCatmullRomCurve3d.ts:395

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].
- optionalTarget: AcGePoint3d = ...
  The optional target vector the result is written to.
Returns AcGePoint3d
The position on the curve.
- Defined in geometry/AcGeCatmullRomCurve3d.ts:245

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
- Defined in geometry/AcGeCatmullRomCurve3d.ts:327

setClosed

setClosed(closed: boolean): void
Set whether the curve is closed
Parameters
- closed: boolean
  Whether the curve should be closed
Returns void
- Defined in geometry/AcGeCatmullRomCurve3d.ts:350

setCurveType

setCurveType(curveType: CatmullRomCurveType): void
Set the curve type
Parameters
- curveType: CatmullRomCurveType
  The curve type
Returns void
- Defined in geometry/AcGeCatmullRomCurve3d.ts:363

setPoints

setPoints(points: AcGeVector3dLike[]): void
Set the points defining the curve
Parameters
- points: AcGeVector3dLike[]
  Array of points
Returns void
- Defined in geometry/AcGeCatmullRomCurve3d.ts:341

setTension

setTension(tension: number): void
Set the tension of the curve
Parameters
- tension: number
  The tension value
Returns void
- Defined in geometry/AcGeCatmullRomCurve3d.ts:371

transform

transform(matrix: AcGeMatrix3d): this
Transforms the curve by applying the input matrix.
Parameters
- matrix: AcGeMatrix3d
  Input transformation matrix
Returns this
Return this curve
Overrides AcGeCurve3d.transform
- Defined in geometry/AcGeCatmullRomCurve3d.ts:380

translate

translate(v: AcGeVector3dLike): AcGeShape3d
Return new shape translated by given vector. Translation vector may be also defined by a pair of numbers.
Parameters
- v: AcGeVector3dLike
Returns AcGeShape3d
Inherited from AcGeCurve3d.translate
- Defined in geometry/AcGeShape3d.ts:16

Class AcGeCatmullRomCurve3d

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AcGeCatmullRomCurve3d

Properties

Protected_boundingBoxNeedsUpdate

ReadonlyisCatmullRomCurve3d

Readonlytype

Accessors

boundingBoxNeedUpdate

Returns boolean

box

Returns AcGeBox3d

closed

Returns boolean

curveType

Returns CatmullRomCurveType

endPoint

Returns AcGePoint3d

length

Returns number

points

Returns AcGePoint3d[]

startPoint

Returns AcGePoint3d

tension

Returns number

Methods

ProtectedcalculateBoundingBox

Returns AcGeBox3d

getPoint

Parameters

Returns AcGePoint3d

getPoints

Parameters

Returns AcGePoint3d[]

setClosed

Parameters

Returns void

setCurveType

Parameters

Returns void

setPoints

Parameters

Returns void

setTension

Parameters

Returns void

transform

Parameters

Returns this

translate

Parameters

Returns AcGeShape3d

Settings

On This Page

`Protected`_boundingBoxNeedsUpdate

`Readonly`isCatmullRomCurve3d

`Readonly`type

`Protected`calculateBoundingBox