@three3d/effect/doc/api/effect.pathgeometry.md

@three3d/effect 提供了 ThreeJS 的特效

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@three3d/effect](./effect.md) &gt; [PathGeometry](./effect.pathgeometry.md)

## PathGeometry class

路径Geometry

**Signature:**

```typescript
export declare class PathGeometry<Options extends PathGeometryOptions> extends BufferGeometry 
```
**Extends:** BufferGeometry

## Remarks

可根据曲线、点来生成路径几何体； 支持路径追加； 支持设置起始长度 支持起始-终点颜色渐变 支持绘制的指定的长度区间

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(options)](./effect.pathgeometry._constructor_.md) |  | Constructs a new instance of the <code>PathGeometry</code> class |

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [\_curvePath](./effect.pathgeometry._curvepath.md) | <code>protected</code> | CurvePath&lt;Vector3&gt; |  |
|  [\_curves](./effect.pathgeometry._curves.md) | <code>protected</code> | Curve&lt;Vector3&gt;\[\] |  |
|  [\_endDrawLength](./effect.pathgeometry._enddrawlength.md) | <code>protected</code> | number \| null |  |
|  [\_options](./effect.pathgeometry._options.md) | <code>protected</code> | Options \| null |  |
|  [\_pathData](./effect.pathgeometry._pathdata.md) | <code>protected</code> | [PathData](./effect.pathdata.md)<!-- -->&lt;Vector3&gt; |  |
|  [\_startDrawLength](./effect.pathgeometry._startdrawlength.md) | <code>protected</code> | number |  |
|  [autoClose](./effect.pathgeometry.autoclose.md) |  | boolean \| undefined | 是否自动闭合 |
|  [closed](./effect.pathgeometry.closed.md) | <code>readonly</code> | boolean | 当前是否已经闭合 |
|  [closedCurvePath](./effect.pathgeometry.closedcurvepath.md) | <code>readonly</code> | CurvePath&lt;Vector3&gt; | 闭合的曲线路径 |
|  [closedPathData](./effect.pathgeometry.closedpathdata.md) | <code>readonly</code> | [PathData](./effect.pathdata.md)<!-- -->&lt;Vector3&gt; |  |
|  [color](./effect.pathgeometry.color.md) |  | ColorRepresentation \| null \| undefined | 线的颜色 |
|  [curvePath](./effect.pathgeometry.curvepath.md) |  | CurvePath&lt;Vector3&gt; | 表示路径的曲线 |
|  [curves](./effect.pathgeometry.curves.md) |  | Curve&lt;Vector3&gt;\[\] | 组成路径的曲线列表 |
|  [endColor](./effect.pathgeometry.endcolor.md) |  | ColorRepresentation \| null | 终点处的颜色 |
|  [endDrawLength](./effect.pathgeometry.enddrawlength.md) |  | number | 结束绘制的长度范围 |
|  [endLength](./effect.pathgeometry.endlength.md) | <code>readonly</code> | number | 终点位置处的长度 |
|  [firstPoint](./effect.pathgeometry.firstpoint.md) | <code>readonly</code> | Vector3 | curvePath 上的第一个点 |
|  [globalOptions](./effect.pathgeometry.globaloptions.md) | <code>readonly</code> | Options | 全局选项 |
|  [isPathGeometry](./effect.pathgeometry.ispathgeometry.md) | <code>readonly</code> | (not declared) |  |
|  [lastPoint](./effect.pathgeometry.lastpoint.md) | <code>readonly</code> | Vector3 | curvePath 上的最后一个点 |
|  [lastPosition](./effect.pathgeometry.lastposition.md) | <code>readonly</code> | Vector3 \| null | position 属性中的最后一个点 |
|  [length](./effect.pathgeometry.length.md) | <code>readonly</code> | number | 线性几何体本身的长度 |
|  [lengths](./effect.pathgeometry.lengths.md) |  | number\[\] | 曲线上生成的点 |
|  [lineDistance](./effect.pathgeometry.linedistance.md) | <code>readonly</code> | ArrayLike&lt;number&gt; | 获取顶点对应的长度的数组 |
|  [options](./effect.pathgeometry.options.md) |  | Options | 实例级别的选项 |
|  [options](./effect.pathgeometry.options.md) | <code>static</code> | [PathGeometryOptions](./effect.pathgeometryoptions.md) | 全局选项 |
|  [pathData](./effect.pathgeometry.pathdata.md) |  | [PathData](./effect.pathdata.md)<!-- -->&lt;Vector3&gt; | 路径数据 |
|  [points](./effect.pathgeometry.points.md) |  | Vector3\[\] | 所有的顶点 |
|  [sampleLength](./effect.pathgeometry.samplelength.md) |  | number | 采样长度 |
|  [sampleNum](./effect.pathgeometry.samplenum.md) |  | number \| undefined | 采样数 |
|  [startColor](./effect.pathgeometry.startcolor.md) |  | ColorRepresentation \| null | 线开始处的颜色 |
|  [startDrawLength](./effect.pathgeometry.startdrawlength.md) |  | number | 开始绘制的长度范围 |
|  [startLength](./effect.pathgeometry.startlength.md) |  | number | 路径起始位置处的长度 |
|  [vertexCount](./effect.pathgeometry.vertexcount.md) | <code>readonly</code> | number | 顶点个数 |
|  [width](./effect.pathgeometry.width.md) |  | number | 路径的宽度 |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [append(pathItem)](./effect.pathgeometry.append.md) |  |  |
|  [appendAttributes(attrs)](./effect.pathgeometry.appendattributes.md) |  | 追加新的属性 |
|  [copy(source)](./effect.pathgeometry.copy.md) |  |  |
|  [generateCurvePath()](./effect.pathgeometry.generatecurvepath.md) |  | 生成曲线 |
|  [getClosestIndex(length)](./effect.pathgeometry.getclosestindex.md) |  | 获取与指定长度值最近的索引 |
|  [getNearbyIndex(length, right)](./effect.pathgeometry.getnearbyindex.md) |  | 获取目标长度值附近的索引 |
|  [resetAttributes(attrs)](./effect.pathgeometry.resetattributes.md) |  | 重围所有的 Attributes |
|  [set(pathItem)](./effect.pathgeometry.set.md) |  |  |
|  [setDrawLength(startLength, endLength)](./effect.pathgeometry.setdrawlength.md) |  | 设置绘制的长度范围 |
|  [updateGeometry()](./effect.pathgeometry.updategeometry.md) |  |  |