@orillusion/graphic

---

Class: Path3DShape3D

Defined in: packages/graphic/renderer/shape3d/Path3DShape3D.ts:15

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

Path3DShape3D

Extends

• LineShape3D

Constructors

Constructor

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

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

Parameters

structs

Shape3DStruct

sharedPoints

Float32Array

sharedIndecies

Uint32Array

matrixIndex

number

Returns

Path3DShape3D

Overrides

LineShape3D.constructor

Properties

shapeType

readonly shapeType: number

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

Overrides

LineShape3D.shapeType

---

computeEveryFrame

readonly computeEveryFrame: boolean = true

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

Overrides

LineShape3D.computeEveryFrame

---

shapeIndex

readonly shapeIndex: number = 0

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

Inherited from

LineShape3D.shapeIndex

Accessors

corner

Get Signature

get corner(): number

Defined in: packages/graphic/renderer/shape3d/LineShape3D.ts:20

Returns

number

Set Signature

set corner(value): void

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

Parameters

value

number

Returns

void

Inherited from

LineShape3D.corner

---

lineJoin

Get Signature

get lineJoin(): LineJoin

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

Returns

LineJoin

Set Signature

set lineJoin(value): void

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

Parameters

value

LineJoin

Returns

void

Overrides

LineShape3D.lineJoin

---

isClosed

Get Signature

get isClosed(): boolean

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

Returns

boolean

Set Signature

set isClosed(value): void

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

Parameters

value

boolean

Returns

void

Overrides

LineShape3D.isClosed

---

isChange

Get Signature

get isChange(): boolean

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:120

Returns

boolean

Inherited from

LineShape3D.isChange

---

lineColor

Get Signature

get lineColor(): Color

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:135

Returns

Color

Set Signature

set lineColor(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:130

Parameters

value

Color

Returns

void

Inherited from

LineShape3D.lineColor

---

fillColor

Get Signature

get fillColor(): Color

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:144

Returns

Color

Set Signature

set fillColor(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:139

Parameters

value

Color

Returns

void

Inherited from

LineShape3D.fillColor

---

lineTextureID

Get Signature

get lineTextureID(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:148

Returns

number

Set Signature

set lineTextureID(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:151

Parameters

value

number

Returns

void

Inherited from

LineShape3D.lineTextureID

---

fillTextureID

Get Signature

get fillTextureID(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:157

Returns

number

Set Signature

set fillTextureID(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:160

Parameters

value

number

Returns

void

Inherited from

LineShape3D.fillTextureID

---

fillRotation

Get Signature

get fillRotation(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:167

Returns

number

Set Signature

set fillRotation(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:170

Parameters

value

number

Returns

void

Inherited from

LineShape3D.fillRotation

---

shapeOrder

Get Signature

get shapeOrder(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:177

Returns

number

Set Signature

set shapeOrder(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:180

Parameters

value

number

Returns

void

Inherited from

LineShape3D.shapeOrder

---

srcPointStart

Get Signature

get srcPointStart(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:188

Returns

number

Set Signature

set srcPointStart(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:191

Parameters

value

number

Returns

void

Inherited from

LineShape3D.srcPointStart

---

srcPointCount

Get Signature

get srcPointCount(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:198

Returns

number

Inherited from

LineShape3D.srcPointCount

---

srcIndexStart

Get Signature

get srcIndexStart(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:202

Returns

number

Set Signature

set srcIndexStart(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:205

Parameters

value

number

Returns

void

Inherited from

LineShape3D.srcIndexStart

---

srcIndexCount

Get Signature

get srcIndexCount(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:212

Returns

number

Inherited from

LineShape3D.srcIndexCount

---

destPointStart

Get Signature

get destPointStart(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:216

Returns

number

Set Signature

set destPointStart(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:219

Parameters

value

number

Returns

void

Inherited from

LineShape3D.destPointStart

---

destPointCount

Get Signature

get destPointCount(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:225

Returns

number

Inherited from

LineShape3D.destPointCount

---

points3D

Get Signature

get points3D(): Point3D[]

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:229

Returns

Point3D[]

Set Signature

set points3D(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:232

Parameters

value

Point3D[]

Returns

void

Inherited from

LineShape3D.points3D

---

fill

Get Signature

get fill(): boolean

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:248

Returns

boolean

Set Signature

set fill(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:251

Parameters

value

boolean

Returns

void

Inherited from

LineShape3D.fill

---

line

Get Signature

get line(): boolean

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:257

Returns

boolean

Set Signature

set line(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:260

Parameters

value

boolean

Returns

void

Inherited from

LineShape3D.line

---

lineWidth

Get Signature

get lineWidth(): number

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:267

Returns

number

Set Signature

set lineWidth(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:271

Parameters

value

number

Returns

void

Inherited from

LineShape3D.lineWidth

---

lineUVRect

Get Signature

get lineUVRect(): Vector4

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:288

x: u offset of line. y: v offset of line. z: u scale of line. w: v scale of line.

Memberof

Shape3D

Returns

Vector4

Set Signature

set lineUVRect(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:291

Parameters

value

Vector4

Returns

void

Inherited from

LineShape3D.lineUVRect

---

fillUVRect

Get Signature

get fillUVRect(): Vector4

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:305

x: u offset of filled area. y: v offset of filled area. z: u scale of filled area. w: v scale of filled area.

Memberof

Shape3D

Returns

Vector4

Set Signature

set fillUVRect(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:308

Parameters

value

Vector4

Returns

void

Inherited from

LineShape3D.fillUVRect

---

uvSpeed

Get Signature

get uvSpeed(): Vector4

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:322

x: u speed of filled area. y: v speed of filled area. z: u speed of line. w: v speed of line.

Memberof

Shape3D

Returns

Vector4

Set Signature

set uvSpeed(value): void

Defined in: packages/graphic/renderer/shape3d/Shape3D.ts:325

Parameters

value

Vector4

Returns

void

Inherited from

LineShape3D.uvSpeed

Methods

sampleQuadraticCurve()

sampleQuadraticCurve(start, cp, end, t, ret?): vec3

Defined in: packages/graphic/renderer/shape3d/LineShape3D.ts:56

Parameters

start

vec3

cp

vec3

end

vec3

t

number

ret?

vec3

Returns

vec3

Inherited from

LineShape3D.sampleQuadraticCurve

---

sampleCurve()

sampleCurve(start, cp1, cp2, end, t, ret?): vec3

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

Parameters

start

vec3

cp1

vec3

cp2

vec3

end

vec3

t

number

ret?

vec3

Returns

vec3

Inherited from

LineShape3D.sampleCurve

---

reset()

reset(): void

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

Returns

void

---

calcRequireSource()

calcRequireSource(): void

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

Returns

void

Overrides

LineShape3D.calcRequireSource

---

arc()

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

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

Parameters

x

number

y

number

radius

number

startAngle

number

endAngle

number

counterclockwise?

boolean

segment?

number

height?

number

Returns

void

---

arcTo()

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

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

Parameters

ctrlX

number

ctrlY

number

toX

number

toY

number

radius

number

segment?

number

height?

number

Returns

void

---

bezierCurveTo()

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

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

Parameters

cp1x

number

cp1y

number

cp1h

number

cp2x

number

cp2y

number

cp2h

number

x

number

y

number

h

number

segment?

number

Returns

void

---

closePath()

closePath(): void

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

Returns

void

---

ellipse()

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

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

Parameters

x

number

y

number

radiusX

number

radiusY

number

rotation

number

startAngle

number

endAngle

number

counterclockwise?

boolean

segment?

number

height?

number

Returns

void

---

moveTo()

moveTo(x, y, h?): void

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

Parameters

x

number

y

number

h?

number

Returns

void

---

quadraticCurveTo()

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

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

Parameters

cpx

number

cpy

number

cph

number

x

number

y

number

h

number

segment?

number

Returns

void

---

rect()

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

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

Parameters

x

number

y

number

w

number

h

number

height?

number

Returns

void

---

roundRect()

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

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

Parameters

x

number

y

number

w

number

h

number

radii?

number

segment?

number

height?

number

Returns

void

---

lineTo()

lineTo(x, y, h?): void

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

Parameters

x

number

y

number

h?

number

Returns

void

---

writeData()

writeData(): void

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

Returns

void

Inherited from

LineShape3D.writeData

---

clean()

clean(): void

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

Returns

void

Inherited from

LineShape3D.clean