Winter Cardinal UI - v0.457.0 / DBaseMeshGeometry

Class: DBaseMeshGeometry

Hierarchy

• MeshGeometry

  ↳ DBaseMeshGeometry

  ↳↳ DBaseBackgroundMeshGeometry

  ↳↳ DBaseBorderMeshGeometry

Table of contents

Constructors

• constructor

Properties

• _cornerMask
• _cornerRadius
• _height
• _indexBuffer
• _indices
• _isDirty
• _resolution
• _uvBuffer
• _uvs
• _vertexBuffer
• _vertices
• _width
• glVertexArrayObjects
• instanceCount
• refCount
• N
• TABLES

Accessors

• cornerMask
• cornerRadius
• height
• width

Methods

• addAttribute
• addIndex
• clone
• destroy
• dispose
• getAttribute
• getBuffer
• getIndex
• getTables
• interleave
• newTable
• newTables
• merge

Constructors

constructor

• new DBaseMeshGeometry(vertices, uvs, indices): DBaseMeshGeometry

Parameters

Name	Type
vertices	number[] | Float32Array
uvs	number[] | Float32Array
indices	number[] | Uint16Array

Returns

DBaseMeshGeometry

Overrides

MeshGeometry.constructor

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:32

Properties

_cornerMask

• Protected _cornerMask: number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:22

---

_cornerRadius

• Protected _cornerRadius: number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:21

---

_height

• Protected _height: number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:20

---

_indexBuffer

• Protected _indexBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:29

---

_indices

• Protected _indices: Uint16Array

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:26

---

_isDirty

• Protected _isDirty: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:23

---

_resolution

• Protected _resolution: number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:30

---

_uvBuffer

• Protected _uvBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:28

---

_uvs

• Protected _uvs: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:25

---

_vertexBuffer

• Protected _vertexBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:27

---

_vertices

• Protected _vertices: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:24

---

_width

• Protected _width: number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:19

---

glVertexArrayObjects

• Protected glVertexArrayObjects: any

A map of renderer IDs to webgl VAOs

Inherited from

MeshGeometry.glVertexArrayObjects

Defined in

node_modules/pixi.js/pixi.js.d.ts:14256

---

instanceCount

• instanceCount: number

Number of instances in this geometry, pass it to GeometrySystem.draw()

Member

PIXI.Geometry#instanceCount

Default

1

Inherited from

MeshGeometry.instanceCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:14262

---

refCount

• refCount: number

Count of existing (not destroyed) meshes that reference this geometry

Member

PIXI.Geometry#refCount

Inherited from

MeshGeometry.refCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:14267

---

N

▪ Static Protected N: number = 5

Note that this must be an odd number.

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:16

---

TABLES

▪ Static Protected Optional TABLES: DBaseMeshGeometryTable[]

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:17

Accessors

cornerMask

• get cornerMask(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:87

• set cornerMask(cornerMask): void

Parameters

Name	Type
cornerMask	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:91

---

cornerRadius

• get cornerRadius(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:76

• set cornerRadius(borderSize): void

Parameters

Name	Type
borderSize	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:80

---

height

• get height(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:65

• set height(height): void

Parameters

Name	Type
height	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:69

---

width

• get width(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:54

• set width(width): void

Parameters

Name	Type
width	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:58

Methods

addAttribute

▸ addAttribute(id, buffer?, size?, normalized?, type?, stride?, start?, instance?): Geometry

Adds an attribute to the geometry Note: stride and start should be undefined if you dont know them, not 0!

Parameters

Name	Type	Description
id	string	the name of the attribute (matching up to a shader)
buffer?	number[] | Buffer	the buffer that holds the data of the attribute . You can also provide an Array and a buffer will be created from it.
size?	number	the size of the attribute. If you have 2 floats per vertex (eg position x and y) this would be 2
normalized?	boolean	should the data be normalized.
type?	number	what type of number is the attribute. Check {PIXI.TYPES} to see the ones available
stride?	number	How far apart (in floats) the start of each value is. (used for interleaving data)
start?	number	How far into the array to start reading values (used for interleaving data)
instance?	boolean	Instancing flag

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.addAttribute

Defined in

node_modules/pixi.js/pixi.js.d.ts:14284

---

addIndex

▸ addIndex(buffer?): Geometry

Adds an index buffer to the geometry The index buffer contains integers, three for each triangle in the geometry, which reference the various attribute buffers (position, colour, UV coordinates, other UV coordinates, normal, …). There is only ONE index buffer.

Parameters

Name	Type	Description
buffer?	number[] | Buffer	the buffer that holds the data of the index buffer. You can also provide an Array and a buffer will be created from it.

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.addIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:14307

---

clone

▸ clone(): Geometry

returns a clone of the geometry

Returns

Geometry

a new clone of this geometry

Inherited from

MeshGeometry.clone

Defined in

node_modules/pixi.js/pixi.js.d.ts:14334

---

destroy

▸ destroy(): void

Destroys the geometry.

Returns

void

Inherited from

MeshGeometry.destroy

Defined in

node_modules/pixi.js/pixi.js.d.ts:14328

---

dispose

▸ dispose(): void

disposes WebGL resources that are connected to this geometry

Returns

void

Inherited from

MeshGeometry.dispose

Defined in

node_modules/pixi.js/pixi.js.d.ts:14324

---

getAttribute

▸ getAttribute(id): Attribute

returns the requested attribute

Parameters

Name	Type	Description
id	string	the name of the attribute required

Returns

Attribute

the attribute requested.

Inherited from

MeshGeometry.getAttribute

Defined in

node_modules/pixi.js/pixi.js.d.ts:14291

---

getBuffer

▸ getBuffer(id): Buffer

returns the requested buffer

Parameters

Name	Type	Description
id	string	the name of the buffer required

Returns

Buffer

the buffer requested.

Inherited from

MeshGeometry.getBuffer

Defined in

node_modules/pixi.js/pixi.js.d.ts:14298

---

getIndex

▸ getIndex(): Buffer

returns the index buffer

Returns

Buffer

the index buffer.

Inherited from

MeshGeometry.getIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:14313

---

getTables

▸ getTables(): DBaseMeshGeometryTable[]

Returns

DBaseMeshGeometryTable[]

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:98

---

interleave

▸ interleave(): Geometry

this function modifies the structure so that all current attributes become interleaved into a single buffer This can be useful if your model remains static as it offers a little performance boost

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.interleave

Defined in

node_modules/pixi.js/pixi.js.d.ts:14320

---

newTable

▸ newTable(n, a0, da): DBaseMeshGeometryTable

Parameters

Name	Type
n	number
a0	number
da	number

Returns

DBaseMeshGeometryTable

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:118

---

newTables

▸ newTables(n): DBaseMeshGeometryTable[]

Parameters

Name	Type
n	number

Returns

DBaseMeshGeometryTable[]

Defined in

src/main/typescript/wcardinal/ui/d-base-mesh-geometry.ts:107

---

merge

▸ merge(geometries): Geometry

merges an array of geometries into a new single one geometry attribute styles must match for this operation to work

Parameters

Name	Type	Description
geometries	Geometry[]	array of geometries to merge

Returns

Geometry

shiny new geometry!

Inherited from

MeshGeometry.merge

Defined in

node_modules/pixi.js/pixi.js.d.ts:3115

Edit this page.