Class Water3DMaterial

材质

Hierarchy

Material
- Water3DMaterial

Index

Constructors

constructor

new Water3DMaterial(): Water3DMaterial
Returns Water3DMaterial
Overrides Material.constructor
- Defined in node_modules/@feng3d/core/lib/3d/water/WaterMaterial3D.d.ts:15

Properties

drawMode

drawMode: DrawMode

渲染模式，默认 TRIANGLES，每三个顶点绘制一个三角形。

POINTS 绘制单个点。
LINE_LOOP 绘制循环连线。
LINE_STRIP 绘制连线
LINES 每两个顶点绘制一条线段。
TRIANGLES 每三个顶点绘制一个三角形。
TRIANGLE_STRIP 绘制三角形条带。
TRIANGLE_FAN 绘制三角扇形。

A GLenum specifying the type primitive to render. Possible values are:

See

https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/drawElements

name

name: string

renderParams

renderParams: RenderParams

渲染参数

shader

shader: Shader

uniforms

uniforms: {}

Uniform数据

Type declaration

Accessors

shaderName

get shaderName(): string
shader名称

Returns string
Inherited from Material.shaderName
- Defined in node_modules/@feng3d/core/lib/core/Material.d.ts:42

Methods

beforeRender

beforeRender(renderAtomic): void
Parameters
- renderAtomic: RenderAtomic
Returns void
Inherited from Material.beforeRender
- Defined in node_modules/@feng3d/core/lib/core/Material.d.ts:69

broadcast

broadcast<K>(type, data?): IEvent<any>
将事件广播到下级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
返回广播后的事件。
Inherited from Material.broadcast
- Defined in packages/event/src/EventEmitter.ts:176

bubbles

bubbles<K>(type, data?): IEvent<any>
将事件冒泡到上级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
返回冒泡后的事件。
Inherited from Material.bubbles
- Defined in packages/event/src/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
Inherited from Material.dispose
- Defined in packages/event/src/EventEmitter.ts:535

emit

emit<K>(type, data?, bubbles?, broadcast?, share?): IEvent<any>
发射事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<any>
返回发射后的事件。
Inherited from Material.emit
- Defined in packages/event/src/EventEmitter.ts:145

emitEvent

emitEvent<K>(event): IEvent<any>
发射事件。

当事件重复流向一个对象时将不会被处理。
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件对象
Returns IEvent<any>
返回事件是否被处理
Inherited from Material.emitEvent
- Defined in packages/event/src/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
Inherited from Material.eventNames
- Defined in packages/event/src/EventEmitter.ts:70

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from Material.handelEventBroadcast
- Defined in packages/event/src/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from Material.handelEventBubbles
- Defined in packages/event/src/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from Material.handelEventShare
- Defined in packages/event/src/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<any>
  
  事件
Returns void
Inherited from Material.handleEvent
- Defined in packages/event/src/EventEmitter.ts:389

has

has<K>(type): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Inherited from Material.has
- Defined in packages/event/src/EventEmitter.ts:200

init

init(param): Water3DMaterial
Parameters
- param: gPartial<Water3DMaterial>
Returns Water3DMaterial
Inherited from Material.init
- Defined in node_modules/@feng3d/core/lib/core/Material.d.ts:37

listenerCount

listenerCount<K>(type): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from Material.listenerCount
- Defined in packages/event/src/EventEmitter.ts:82

off

off<K>(type?, listener?, thisObject?): Water3DMaterial
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns Water3DMaterial
Inherited from Material.off
- Defined in packages/event/src/EventEmitter.ts:253

offAll

offAll<K>(type?): Water3DMaterial
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns Water3DMaterial
Inherited from Material.offAll
- Defined in packages/event/src/EventEmitter.ts:303

offAny

offAny<K>(listener?, thisObject?): Water3DMaterial
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns Water3DMaterial
Inherited from Material.offAny
- Defined in packages/event/src/EventEmitter.ts:353

on

on<K>(type, listener, thisObject?, priority?, once?): Water3DMaterial
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns Water3DMaterial
Inherited from Material.on
- Defined in packages/event/src/EventEmitter.ts:214

onAny

onAny<K>(listener, thisObject?, priority?, once?): Water3DMaterial
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns Water3DMaterial
Inherited from Material.onAny
- Defined in packages/event/src/EventEmitter.ts:318

once

once<K>(type, listener, thisObject?, priority?): Water3DMaterial
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的侦听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns Water3DMaterial
Inherited from Material.once
- Defined in packages/event/src/EventEmitter.ts:95

`Static` getDefault

getDefault<K>(name): DefaultMaterialMap[K]
获取材质
Type Parameters
- K extends keyof DefaultMaterialMap
Parameters
- name: K
  
  材质名称
Returns DefaultMaterialMap[K]
Inherited from Material.getDefault
- Defined in node_modules/@feng3d/core/lib/core/Material.d.ts:84

`Static` getEventEmitter

getEventEmitter(target): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from Material.getEventEmitter
- Defined in packages/event/src/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from Material.getOrCreateEventEmitter
- Defined in packages/event/src/EventEmitter.ts:44

`Static` setDefault

setDefault<K>(name, material): void
设置默认材质

资源名称与材质名称相同，且无法在检查器界面中编辑。
Type Parameters
- K extends keyof DefaultMaterialMap
Parameters
- name: K
  
  材质名称
- material: Lazy<DefaultMaterialMap[K]>
  
  材质数据
Returns void
Inherited from Material.setDefault
- Defined in node_modules/@feng3d/core/lib/core/Material.d.ts:78

Class Water3DMaterial

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Water3DMaterial

Properties

drawMode

See

name

renderParams

shader

uniforms

Type declaration

Accessors

shaderName

Returns string

Methods

beforeRender

Parameters

renderAtomic: RenderAtomic

Returns void

broadcast

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

bubbles

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

dispose

Returns void

emit

Type Parameters

K extends string

Parameters

type: K

Optional data: any

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<any>

emitEvent

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns IEvent<any>

eventNames

Type Parameters

K extends string

Returns K[]

Protected handelEventBroadcast

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handelEventBubbles

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handelEventShare

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

`Optional` data: any

`Optional` data: any

`Optional` data: any

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` thisObject: any