Class: CircleShape3D

Define class for drawing Circle on the xz plane You can use the API implemented in CanvasPath in Path2DShape3D to draw the xz plane path

Export

Hierarchy

• Shape3D

  ↳ CircleShape3D

Constructors

• constructor

Properties

• shapeType
• shapeIndex
• computeEveryFrame

Accessors

• segment
• radius
• startAngle
• endAngle
• arcType
• isChange
• lineColor
• fillColor
• lineTextureID
• fillTextureID
• fillRotation
• shapeOrder
• srcPointStart
• srcPointCount
• srcIndexStart
• srcIndexCount
• destPointStart
• destPointCount
• points3D
• isClosed
• fill
• line
• lineWidth
• lineUVRect
• fillUVRect
• uvSpeed

Methods

• set
• calcRequireSource
• writeData
• clean

Constructors

constructor

• new CircleShape3D(structs, sharedPoints, sharedIndecies, matrixIndex): CircleShape3D

Parameters

Name	Type
structs	Shape3DStruct
sharedPoints	Float32Array
sharedIndecies	Uint32Array
matrixIndex	number

Returns

CircleShape3D

Inherited from

Shape3D.constructor

Defined in

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

Properties

shapeType

• Readonly shapeType: number

Overrides

Shape3D.shapeType

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:16

---

shapeIndex

• Readonly shapeIndex: number = 0

Inherited from

Shape3D.shapeIndex

Defined in

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

---

computeEveryFrame

• Optional Readonly computeEveryFrame: boolean

Inherited from

Shape3D.computeEveryFrame

Defined in

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

Accessors

segment

• get segment(): number

Returns

number

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:26

• set segment(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:29

---

radius

• get radius(): number

Returns

number

Defined in

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

• set radius(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

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

---

startAngle

• get startAngle(): number

Returns

number

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:45

• set startAngle(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:48

---

endAngle

• get endAngle(): number

Returns

number

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:60

• set endAngle(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:63

---

arcType

• get arcType(): CircleArcType

Returns

CircleArcType

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:76

• set arcType(value): void

Parameters

Name	Type
value	CircleArcType

Returns

void

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:79

---

isChange

• get isChange(): boolean

Returns

boolean

Inherited from

Shape3D.isChange

Defined in

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

---

lineColor

• get lineColor(): Color

Returns

Color

Inherited from

Shape3D.lineColor

Defined in

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

• set lineColor(value): void

Parameters

Name	Type
value	Color

Returns

void

Inherited from

Shape3D.lineColor

Defined in

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

---

fillColor

• get fillColor(): Color

Returns

Color

Inherited from

Shape3D.fillColor

Defined in

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

• set fillColor(value): void

Parameters

Name	Type
value	Color

Returns

void

Inherited from

Shape3D.fillColor

Defined in

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

---

lineTextureID

• get lineTextureID(): number

Returns

number

Inherited from

Shape3D.lineTextureID

Defined in

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

• set lineTextureID(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.lineTextureID

Defined in

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

---

fillTextureID

• get fillTextureID(): number

Returns

number

Inherited from

Shape3D.fillTextureID

Defined in

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

• set fillTextureID(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.fillTextureID

Defined in

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

---

fillRotation

• get fillRotation(): number

Returns

number

Inherited from

Shape3D.fillRotation

Defined in

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

• set fillRotation(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.fillRotation

Defined in

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

---

shapeOrder

• get shapeOrder(): number

Returns

number

Inherited from

Shape3D.shapeOrder

Defined in

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

• set shapeOrder(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.shapeOrder

Defined in

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

---

srcPointStart

• get srcPointStart(): number

Returns

number

Inherited from

Shape3D.srcPointStart

Defined in

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

• set srcPointStart(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.srcPointStart

Defined in

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

---

srcPointCount

• get srcPointCount(): number

Returns

number

Inherited from

Shape3D.srcPointCount

Defined in

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

---

srcIndexStart

• get srcIndexStart(): number

Returns

number

Inherited from

Shape3D.srcIndexStart

Defined in

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

• set srcIndexStart(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.srcIndexStart

Defined in

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

---

srcIndexCount

• get srcIndexCount(): number

Returns

number

Inherited from

Shape3D.srcIndexCount

Defined in

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

---

destPointStart

• get destPointStart(): number

Returns

number

Inherited from

Shape3D.destPointStart

Defined in

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

• set destPointStart(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.destPointStart

Defined in

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

---

destPointCount

• get destPointCount(): number

Returns

number

Inherited from

Shape3D.destPointCount

Defined in

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

---

points3D

• get points3D(): Point3D[]

Returns

Point3D[]

Inherited from

Shape3D.points3D

Defined in

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

• set points3D(value): void

Parameters

Name	Type
value	Point3D[]

Returns

void

Inherited from

Shape3D.points3D

Defined in

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

---

isClosed

• get isClosed(): boolean

Returns

boolean

Inherited from

Shape3D.isClosed

Defined in

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

• set isClosed(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Shape3D.isClosed

Defined in

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

---

fill

• get fill(): boolean

Returns

boolean

Inherited from

Shape3D.fill

Defined in

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

• set fill(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Shape3D.fill

Defined in

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

---

line

• get line(): boolean

Returns

boolean

Inherited from

Shape3D.line

Defined in

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

• set line(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Shape3D.line

Defined in

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

---

lineWidth

• get lineWidth(): number

Returns

number

Inherited from

Shape3D.lineWidth

Defined in

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

• set lineWidth(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Shape3D.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

Shape3D.lineUVRect

Defined in

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

• set lineUVRect(value): void

Parameters

Name	Type
value	Vector4

Returns

void

Inherited from

Shape3D.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

Shape3D.fillUVRect

Defined in

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

• set fillUVRect(value): void

Parameters

Name	Type
value	Vector4

Returns

void

Inherited from

Shape3D.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

Shape3D.uvSpeed

Defined in

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

• set uvSpeed(value): void

Parameters

Name	Type
value	Vector4

Returns

void

Inherited from

Shape3D.uvSpeed

Defined in

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

Methods

set

▸ set(radius, lineWidth, fill, line, segment?): void

Parameters

Name	Type	Default value
radius	number	undefined
lineWidth	number	undefined
fill	boolean	undefined
line	boolean	undefined
segment	number	10

Returns

void

Defined in

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

---

calcRequireSource

▸ calcRequireSource(): void

Returns

void

Overrides

Shape3D.calcRequireSource

Defined in

packages/graphic/renderer/shape3d/CircleShape3D.ts:86

---

writeData

▸ writeData(): void

Returns

void

Inherited from

Shape3D.writeData

Defined in

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

---

clean

▸ clean(): void

Returns

void

Inherited from

Shape3D.clean

Defined in

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