Class: Path2DShape3D 
Define class for drawing path on the xz plane He implemented the interface CanvasPath
Export
Implements
Hierarchy 
↳
Path2DShape3D
Implements 
CanvasPath
Constructors 
Properties 
Accessors 
- corner
 - lineJoin
 - isClosed
 - isChange
 - lineColor
 - fillColor
 - lineTextureID
 - fillTextureID
 - fillRotation
 - shapeOrder
 - srcPointStart
 - srcPointCount
 - srcIndexStart
 - srcIndexCount
 - destPointStart
 - destPointCount
 - points3D
 - fill
 - line
 - lineWidth
 - lineUVRect
 - fillUVRect
 - uvSpeed
 
Methods 
- sampleQuadraticCurve
 - sampleCurve
 - reset
 - calcRequireSource
 - arc
 - arcTo
 - bezierCurveTo
 - closePath
 - ellipse
 - moveTo
 - quadraticCurveTo
 - rect
 - roundRect
 - lineTo
 - writeData
 - clean
 
Constructors 
constructor 
• new Path2DShape3D(structs, sharedPoints, sharedIndecies, matrixIndex): Path2DShape3D
Parameters 
| Name | Type | 
|---|---|
structs | Shape3DStruct | 
sharedPoints | Float32Array | 
sharedIndecies | Uint32Array | 
matrixIndex | number | 
Returns 
Overrides 
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:17
Properties 
shapeType 
• Readonly shapeType: number
Inherited from 
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:18
shapeIndex 
• Readonly shapeIndex: number = 0
Inherited from 
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:109
computeEveryFrame 
• Optional Readonly computeEveryFrame: boolean
Inherited from 
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:111
Accessors 
corner 
• get corner(): number
Returns 
number
Inherited from 
LineShape3D.corner
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:20
• set corner(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.corner
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:23
lineJoin 
• get lineJoin(): LineJoin
Returns 
Inherited from 
LineShape3D.lineJoin
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:30
• set lineJoin(value): void
Parameters 
| Name | Type | 
|---|---|
value | LineJoin | 
Returns 
void
Inherited from 
LineShape3D.lineJoin
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:33
isClosed 
• get isClosed(): boolean
Returns 
boolean
Overrides 
LineShape3D.isClosed
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:24
• set isClosed(value): void
Parameters 
| Name | Type | 
|---|---|
value | boolean | 
Returns 
void
Overrides 
LineShape3D.isClosed
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:27
isChange 
• get isChange(): boolean
Returns 
boolean
Inherited from 
LineShape3D.isChange
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:120
lineColor 
• get lineColor(): Color
Returns 
Color
Inherited from 
LineShape3D.lineColor
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:135
• set lineColor(value): void
Parameters 
| Name | Type | 
|---|---|
value | Color | 
Returns 
void
Inherited from 
LineShape3D.lineColor
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:130
fillColor 
• get fillColor(): Color
Returns 
Color
Inherited from 
LineShape3D.fillColor
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:144
• set fillColor(value): void
Parameters 
| Name | Type | 
|---|---|
value | Color | 
Returns 
void
Inherited from 
LineShape3D.fillColor
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:139
lineTextureID 
• get lineTextureID(): number
Returns 
number
Inherited from 
LineShape3D.lineTextureID
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:148
• set lineTextureID(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.lineTextureID
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:151
fillTextureID 
• get fillTextureID(): number
Returns 
number
Inherited from 
LineShape3D.fillTextureID
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:157
• set fillTextureID(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.fillTextureID
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:160
fillRotation 
• get fillRotation(): number
Returns 
number
Inherited from 
LineShape3D.fillRotation
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:167
• set fillRotation(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.fillRotation
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:170
shapeOrder 
• get shapeOrder(): number
Returns 
number
Inherited from 
LineShape3D.shapeOrder
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:177
• set shapeOrder(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.shapeOrder
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:180
srcPointStart 
• get srcPointStart(): number
Returns 
number
Inherited from 
LineShape3D.srcPointStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:188
• set srcPointStart(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.srcPointStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:191
srcPointCount 
• get srcPointCount(): number
Returns 
number
Inherited from 
LineShape3D.srcPointCount
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:198
srcIndexStart 
• get srcIndexStart(): number
Returns 
number
Inherited from 
LineShape3D.srcIndexStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:202
• set srcIndexStart(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.srcIndexStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:205
srcIndexCount 
• get srcIndexCount(): number
Returns 
number
Inherited from 
LineShape3D.srcIndexCount
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:212
destPointStart 
• get destPointStart(): number
Returns 
number
Inherited from 
LineShape3D.destPointStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:216
• set destPointStart(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.destPointStart
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:219
destPointCount 
• get destPointCount(): number
Returns 
number
Inherited from 
LineShape3D.destPointCount
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:225
points3D 
• get points3D(): Point3D[]
Returns 
Point3D[]
Inherited from 
LineShape3D.points3D
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:229
• set points3D(value): void
Parameters 
| Name | Type | 
|---|---|
value | Point3D[] | 
Returns 
void
Inherited from 
LineShape3D.points3D
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:232
fill 
• get fill(): boolean
Returns 
boolean
Inherited from 
LineShape3D.fill
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:248
• set fill(value): void
Parameters 
| Name | Type | 
|---|---|
value | boolean | 
Returns 
void
Inherited from 
LineShape3D.fill
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:251
line 
• get line(): boolean
Returns 
boolean
Inherited from 
LineShape3D.line
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:257
• set line(value): void
Parameters 
| Name | Type | 
|---|---|
value | boolean | 
Returns 
void
Inherited from 
LineShape3D.line
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:260
lineWidth 
• get lineWidth(): number
Returns 
number
Inherited from 
LineShape3D.lineWidth
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:267
• set lineWidth(value): void
Parameters 
| Name | Type | 
|---|---|
value | number | 
Returns 
void
Inherited from 
LineShape3D.lineWidth
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:271
lineUVRect 
• get lineUVRect(): Vector4
x: u offset of line. y: v offset of line. z: u scale of line. w: v scale of line.
Returns 
Vector4
Memberof
Shape3D
Inherited from 
LineShape3D.lineUVRect
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:288
• set lineUVRect(value): void
Parameters 
| Name | Type | 
|---|---|
value | Vector4 | 
Returns 
void
Inherited from 
LineShape3D.lineUVRect
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:291
fillUVRect 
• get fillUVRect(): Vector4
x: u offset of filled area. y: v offset of filled area. z: u scale of filled area. w: v scale of filled area.
Returns 
Vector4
Memberof
Shape3D
Inherited from 
LineShape3D.fillUVRect
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:305
• set fillUVRect(value): void
Parameters 
| Name | Type | 
|---|---|
value | Vector4 | 
Returns 
void
Inherited from 
LineShape3D.fillUVRect
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:308
uvSpeed 
• get uvSpeed(): Vector4
x: u speed of filled area. y: v speed of filled area. z: u speed of line. w: v speed of line.
Returns 
Vector4
Memberof
Shape3D
Inherited from 
LineShape3D.uvSpeed
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:322
• set uvSpeed(value): void
Parameters 
| Name | Type | 
|---|---|
value | Vector4 | 
Returns 
void
Inherited from 
LineShape3D.uvSpeed
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:325
Methods 
sampleQuadraticCurve 
▸ sampleQuadraticCurve(start, cp, end, t, ret?): vec3
Parameters 
| Name | Type | 
|---|---|
start | vec3 | 
cp | vec3 | 
end | vec3 | 
t | number | 
ret? | vec3 | 
Returns 
vec3
Inherited from 
LineShape3D.sampleQuadraticCurve
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:56
sampleCurve 
▸ sampleCurve(start, cp1, cp2, end, t, ret?): vec3
Parameters 
| Name | Type | 
|---|---|
start | vec3 | 
cp1 | vec3 | 
cp2 | vec3 | 
end | vec3 | 
t | number | 
ret? | vec3 | 
Returns 
vec3
Inherited from 
Defined in 
packages/graphic/renderer/shape3d/LineShape3D.ts:66
reset 
▸ reset(): void
Returns 
void
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:32
calcRequireSource 
▸ calcRequireSource(): void
Returns 
void
Overrides 
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:38
arc 
▸ arc(x, y, radius, startAngle, endAngle, counterclockwise?, segment?): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
radius | number | 
startAngle | number | 
endAngle | number | 
counterclockwise? | boolean | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.arc
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:43
arcTo 
▸ arcTo(ctrlX, ctrlY, toX, toY, radius, segment?): void
Parameters 
| Name | Type | 
|---|---|
ctrlX | number | 
ctrlY | number | 
toX | number | 
toY | number | 
radius | number | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.arcTo
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:67
bezierCurveTo 
▸ bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y, segment?): void
Parameters 
| Name | Type | 
|---|---|
cp1x | number | 
cp1y | number | 
cp2x | number | 
cp2y | number | 
x | number | 
y | number | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.bezierCurveTo
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:101
closePath 
▸ closePath(): void
Returns 
void
Implementation of 
CanvasPath.closePath
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:123
ellipse 
▸ ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?, segment?): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
radiusX | number | 
radiusY | number | 
rotation | number | 
startAngle | number | 
endAngle | number | 
counterclockwise? | boolean | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.ellipse
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:132
moveTo 
▸ moveTo(x, y, h?): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
h? | number | 
Returns 
void
Implementation of 
CanvasPath.moveTo
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:168
quadraticCurveTo 
▸ quadraticCurveTo(cpx, cpy, x, y, segment?): void
Parameters 
| Name | Type | 
|---|---|
cpx | number | 
cpy | number | 
x | number | 
y | number | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.quadraticCurveTo
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:174
rect 
▸ rect(x, y, w, h): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
w | number | 
h | number | 
Returns 
void
Implementation of 
CanvasPath.rect
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:196
roundRect 
▸ roundRect(x, y, w, h, radii?, segment?): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
w | number | 
h | number | 
radii? | number | 
segment? | number | 
Returns 
void
Implementation of 
CanvasPath.roundRect
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:205
lineTo 
▸ lineTo(x, y): void
Parameters 
| Name | Type | 
|---|---|
x | number | 
y | number | 
Returns 
void
Implementation of 
CanvasPath.lineTo
Defined in 
packages/graphic/renderer/shape3d/Path2DShape3D.ts:249
writeData 
▸ writeData(): void
Returns 
void
Inherited from 
Defined in 
packages/graphic/renderer/shape3d/Shape3D.ts:124
clean 
▸ clean(): void
Returns 
void

