Skip to content

Class: Path3DShape3D

Define class for drawing path in 3D space. It implemented an API similar to CanvasPath. Please ensure that the current Shape3D model matrix is identitied.

Export

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Path3DShape3D(structs, sharedPoints, sharedIndecies, matrixIndex): Path3DShape3D

Parameters

NameType
structsShape3DStruct
sharedPointsFloat32Array
sharedIndeciesUint32Array
matrixIndexnumber

Returns

Path3DShape3D

Overrides

LineShape3D.constructor

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:21

Properties

shapeType

Readonly shapeType: number

Overrides

LineShape3D.shapeType

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:18


computeEveryFrame

Readonly computeEveryFrame: boolean = true

Overrides

LineShape3D.computeEveryFrame

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:19


shapeIndex

Readonly shapeIndex: number = 0

Inherited from

LineShape3D.shapeIndex

Defined in

packages/graphic/renderer/shape3d/Shape3D.ts:109

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

NameType
valuenumber

Returns

void

Inherited from

LineShape3D.corner

Defined in

packages/graphic/renderer/shape3d/LineShape3D.ts:23


lineJoin

get lineJoin(): LineJoin

Returns

LineJoin

Overrides

LineShape3D.lineJoin

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:28

set lineJoin(value): void

Parameters

NameType
valueLineJoin

Returns

void

Overrides

LineShape3D.lineJoin

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:31


isClosed

get isClosed(): boolean

Returns

boolean

Overrides

LineShape3D.isClosed

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:35

set isClosed(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

LineShape3D.isClosed

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:38


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

NameType
valueColor

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

NameType
valueColor

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuePoint3D[]

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

NameType
valueboolean

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

NameType
valueboolean

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

NameType
valuenumber

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

NameType
valueVector4

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

NameType
valueVector4

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

NameType
valueVector4

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

NameType
startvec3
cpvec3
endvec3
tnumber
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

NameType
startvec3
cp1vec3
cp2vec3
endvec3
tnumber
ret?vec3

Returns

vec3

Inherited from

LineShape3D.sampleCurve

Defined in

packages/graphic/renderer/shape3d/LineShape3D.ts:66


reset

reset(): void

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:43


calcRequireSource

calcRequireSource(): void

Returns

void

Overrides

LineShape3D.calcRequireSource

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:49


arc

arc(x, y, radius, startAngle, endAngle, counterclockwise?, segment?, height?): void

Parameters

NameType
xnumber
ynumber
radiusnumber
startAnglenumber
endAnglenumber
counterclockwise?boolean
segment?number
height?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:54


arcTo

arcTo(ctrlX, ctrlY, toX, toY, radius, segment?, height?): void

Parameters

NameType
ctrlXnumber
ctrlYnumber
toXnumber
toYnumber
radiusnumber
segment?number
height?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:78


bezierCurveTo

bezierCurveTo(cp1x, cp1y, cp1h, cp2x, cp2y, cp2h, x, y, h, segment?): void

Parameters

NameType
cp1xnumber
cp1ynumber
cp1hnumber
cp2xnumber
cp2ynumber
cp2hnumber
xnumber
ynumber
hnumber
segment?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:112


closePath

closePath(): void

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:137


ellipse

ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?, segment?, height?): void

Parameters

NameType
xnumber
ynumber
radiusXnumber
radiusYnumber
rotationnumber
startAnglenumber
endAnglenumber
counterclockwise?boolean
segment?number
height?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:146


moveTo

moveTo(x, y, h?): void

Parameters

NameType
xnumber
ynumber
h?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:182


quadraticCurveTo

quadraticCurveTo(cpx, cpy, cph, x, y, h, segment?): void

Parameters

NameType
cpxnumber
cpynumber
cphnumber
xnumber
ynumber
hnumber
segment?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:188


rect

rect(x, y, w, h, height?): void

Parameters

NameType
xnumber
ynumber
wnumber
hnumber
height?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:210


roundRect

roundRect(x, y, w, h, radii?, segment?, height?): void

Parameters

NameType
xnumber
ynumber
wnumber
hnumber
radii?number
segment?number
height?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:219


lineTo

lineTo(x, y, h?): void

Parameters

NameType
xnumber
ynumber
h?number

Returns

void

Defined in

packages/graphic/renderer/shape3d/Path3DShape3D.ts:263


writeData

writeData(): void

Returns

void

Inherited from

LineShape3D.writeData

Defined in

packages/graphic/renderer/shape3d/Shape3D.ts:124


clean

clean(): void

Returns

void

Inherited from

LineShape3D.clean

Defined in

packages/graphic/renderer/shape3d/Shape3D.ts:330