Class APolygonElement

Hierarchy

ARenderElement
- APolygonElement
  - AAnchorElement
  - AHandleElement

Constructors

constructor

new APolygonElement(verts?: number[] | VertexArray<any>, color?: Color | Color): APolygonElement

Overrides ARenderElement.constructor
- Defined in src/anigraph/arender/2d/APolygonElement.ts:9
If you provide just geometry, it will create the geometry but not the element if you provide geometry and material, it will create the element

Parameters
- Optional verts: number[] | VertexArray<any>
- Optional color: Color | Color
Returns APolygonElement

Properties

_element

_element: Mesh<BufferGeometry, Material | Material[]>

_geometry

_geometry: BufferGeometry

_material

_material: Material | Material[]

Accessors

eventHandler

get eventHandler(): Object3D

- Defined in src/anigraph/arender/ARenderObject.ts:26
This should be whatever receives events

Returns Object3D

geometry

get geometry(): BufferGeometry

- Defined in src/anigraph/arender/ARenderElement.ts:26
Returns BufferGeometry

material

get material(): Material | Material[]

- Defined in src/anigraph/arender/ARenderElement.ts:29
Returns Material | Material[]

serializationLabel

get serializationLabel(): any

- Defined in src/anigraph/arender/ARenderObject.ts:52
Returns any

threejs

get threejs(): Mesh<BufferGeometry, Material | Material[]>

- Defined in src/anigraph/arender/ARenderElement.ts:32
Returns Mesh<BufferGeometry, Material | Material[]>

uid

get uid(): string

- Defined in src/anigraph/arender/ARenderObject.ts:41
Returns string

visible

get visible(): boolean
set visible(value: boolean): void

- Defined in src/anigraph/arender/ARenderObject.ts:59
Get set visible

Returns boolean
- Defined in src/anigraph/arender/ARenderObject.ts:58
Get set visible

Parameters
- value: boolean
Returns void

Methods

_initIfNotAlready

_initIfNotAlready(geometry?: VertexArray<any> | BufferGeometry, material?: Color | Color | Material | Material[]): void

Inherited from ARenderElement._initIfNotAlready
- Defined in src/anigraph/arender/ARenderElement.ts:201
Parameters
- Optional geometry: VertexArray<any> | BufferGeometry
- Optional material: Color | Color | Material | Material[]
Returns void

_setBufferGeometry

_setBufferGeometry(verts: VertexArray<any>): void

Inherited from ARenderElement._setBufferGeometry
- Defined in src/anigraph/arender/ARenderElement.ts:105
Parameters
- verts: VertexArray<any>
Returns void

add

add(toAdd: ARenderObject): void

Inherited from ARenderElement.add
- Defined in src/anigraph/arender/ARenderObject.ts:45
Parameters
- toAdd: ARenderObject
Returns void

dispose

dispose(): void

Inherited from ARenderElement.dispose
- Defined in src/anigraph/arender/ARenderElement.ts:11
Returns void

getMatrix

getMatrix(): void

Inherited from ARenderElement.getMatrix
- Defined in src/anigraph/arender/ARenderObject.ts:37
Returns void

init

init(geometry?: VertexArray<any> | BufferGeometry, material?: Color | Color | Material | Material[]): void

Overrides ARenderElement.init
- Defined in src/anigraph/arender/2d/APolygonElement.ts:25
Parameters
- Optional geometry: VertexArray<any> | BufferGeometry
- Optional material: Color | Color | Material | Material[]
Returns void

onMaterialChange

onMaterialChange(newMaterial: AMaterial, ...args: any[]): void

Overrides ARenderElement.onMaterialChange
- Defined in src/anigraph/arender/2d/APolygonElement.ts:20
Parameters
- newMaterial: AMaterial
- Rest ...args: any[]
Returns void

onMaterialUpdate

onMaterialUpdate(newMaterial: AMaterial, ...args: any[]): void

Overrides ARenderElement.onMaterialUpdate
- Defined in src/anigraph/arender/2d/APolygonElement.ts:16
Parameters
- newMaterial: AMaterial
- Rest ...args: any[]
Returns void

remove

remove(toRemove: ARenderObject): void

Inherited from ARenderElement.remove
- Defined in src/anigraph/arender/ARenderObject.ts:48
Parameters
- toRemove: ARenderObject
Returns void

setColor

setColor(color: Color | Color): void

Inherited from ARenderElement.setColor
- Defined in src/anigraph/arender/ARenderElement.ts:78
Parameters
- color: Color | Color
Returns void

setGeometry

setGeometry(geometry: VertexArray<any> | BufferGeometry): void

Inherited from ARenderElement.setGeometry
- Defined in src/anigraph/arender/ARenderElement.ts:112
Parameters
- geometry: VertexArray<any> | BufferGeometry
Returns void

setMaterial

setMaterial(material: Color | Color | Material | Material[]): void

Inherited from ARenderElement.setMaterial
- Defined in src/anigraph/arender/ARenderElement.ts:161
Parameters
- material: Color | Color | Material | Material[]
Returns void

setMaterialAttribute

setMaterialAttribute(name: string, value: any): void

Inherited from ARenderElement.setMaterialAttribute
- Defined in src/anigraph/arender/ARenderElement.ts:62
Parameters
- name: string
- value: any
Returns void

setMatrix

setMatrix(mat: Mat3 | Mat4): void

Inherited from ARenderElement.setMatrix
- Defined in src/anigraph/arender/ARenderObject.ts:28
Parameters
- mat: Mat3 | Mat4
Returns void

setObject3DName

setObject3DName(name: string): void

Inherited from ARenderElement.setObject3DName
- Defined in src/anigraph/arender/ARenderObject.ts:19
Parameters
- name: string
Returns void

setOpacity

setOpacity(opacity: number): void

Inherited from ARenderElement.setOpacity
- Defined in src/anigraph/arender/ARenderElement.ts:87
Parameters
- opacity: number
Returns void

setTransform

setTransform(T: TransformationInterface): void

Inherited from ARenderElement.setTransform
- Defined in src/anigraph/arender/ARenderObject.ts:61
Parameters
- T: TransformationInterface
Returns void

setVerts

setVerts(verts: VertexArray<any>): void

Inherited from ARenderElement.setVerts
- Defined in src/anigraph/arender/ARenderElement.ts:96
For some subclasses this will be different from setGeometry, because some subclasses will compute procedural geometry based on verts and then set the geometry to the output of that procedure

Parameters
- verts: VertexArray<any>
Returns void

setVerts2D

setVerts2D(verts: number[] | VertexArray2D): void

- Defined in src/anigraph/arender/2d/APolygonElement.ts:84
Parameters
- verts: number[] | VertexArray2D
Returns void

Static Create

Create(geometry?: VertexArray<any> | BufferGeometry, material?: Color | Color | Material | Material[], ...args: any[]): ARenderElement

Inherited from ARenderElement.Create
- Defined in src/anigraph/arender/ARenderElement.ts:52
Use to create and immediately init

Parameters
- Optional geometry: VertexArray<any> | BufferGeometry
- Optional material: Color | Color | Material | Material[]
- Rest ...args: any[]
Returns ARenderElement

Static _GetMaterialFromParam

_GetMaterialFromParam(material: Color | Color | Material | Material[]): Material | Material[]

Inherited from ARenderElement._GetMaterialFromParam
- Defined in src/anigraph/arender/ARenderElement.ts:134
Parameters
- material: Color | Color | Material | Material[]
Returns Material | Material[]

Generated using TypeDoc