OpenLIME Class: LayerBRDF

new LayerBRDF(options)

Creates a new LayerBRDF instance

Parameters:

Name	Type	Description
`options`	LayerBRDFOptions	Configuration options

Source:

LayerBRDF.js, line 71

Throws:

If required channels (kd, normals) are not provided

Type

Error
If rasters option is not empty

Type

Error

Example

```javascript
// Create BRDF layer with all channels
const brdfLayer = new OpenLIME.LayerBRDF({
  channels: {
    kd: 'diffuse.jpg',
    ks: 'specular.jpg',
    normals: 'normals.jpg',
    gloss: 'gloss.jpg'
  },
  colorspaces: {
    kd: 'srgb',
    ks: 'linear'
  },
  brightness: 1.2,
  gamma: 2.2
});

// Update light direction
brdfLayer.setLight([0.5, 0.5], 500, 'ease-out');
```

Extends

Layer

Methods

<static> projectToFlattenedSphere(p)

Projects a 2D point onto a flattened sphere using SGI trackball algorithm. This provides more intuitive light control by avoiding acceleration near edges. Based on SIGGRAPH 1988 paper on SGI trackball implementation.

Parameters:

Name	Type	Description
`p`	Array.<number>	2D point [x, y] in range [-1, 1]

Source:

LayerBRDF.js, line 168

Returns:

3D normalized vector [x, y, z] on flattened sphere

Type: Array.<number>

<static> projectToSphere(p)

Projects a 2D point onto a sphere surface Used for converting 2D mouse/touch input to 3D light direction

Parameters:

Name	Type	Description
`p`	Array.<number>	2D point [x, y] in range [-1, 1]

Source:

LayerBRDF.js, line 144

Returns:

3D normalized vector [x, y, z] on sphere surface

Type: Array.<number>

addControl(name, value)

Adds a shader parameter control

Parameters:

Name	Type	Description
`name`	string	Control identifier
`value`	*	Initial value

Inherited From:

Layer#addControl

Overrides:

Layer#addControl

Source:

Layer.js, line 437

Throws:

If control already exists
Type Error

addShaderFilter(filter)

Adds a filter to the current shader

Parameters:

Name	Type	Description
`filter`	Object	Filter specification

Inherited From:

Layer#addShaderFilter

Overrides:

Layer#addShaderFilter

Source:

Layer.js, line 170

Throws:

If no shader is set
Type Error

boundingBox()

Gets layer bounding box in scene coordinates

Inherited From:

Layer#boundingBox

Overrides:

Layer#boundingBox

Source:

Layer.js, line 381

Returns:

Bounding box

Type: BoundingBox

clearShaderFilters(name)

Removes all filters from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#clearShaderFilters

Overrides:

Layer#clearShaderFilters

Source:

Layer.js, line 190

Throws:

If no shader is set
Type Error

getControl(name)

Gets the shader parameter control corresponding to name

Parameters:

Name	Type	Description
`name`	*	The name of the control. return {*} The control

Inherited From:

Layer#getControl

Overrides:

Layer#getControl

Source:

Layer.js, line 422

getMode()

Gets the current shader visualization mode

Inherited From:

Layer#getMode

Overrides:

Layer#getMode

Source:

Layer.js, line 289

Returns:

Current mode or null if no shader

Type: string | null

getModes()

Gets available shader modes

Inherited From:

Layer#getModes

Overrides:

Layer#getModes

Source:

Layer.js, line 299

Returns:

Array of available modes

Type: Array.<string>

getState( [stateMask])

Gets the current layer state

Parameters:

Name	Type	Argument	Default	Description
`stateMask`	Object	<optional>	null	Optional mask to filter returned state properties

Inherited From:

Layer#getState

Overrides:

Layer#getState

Source:

Layer.js, line 216

Returns:

Current state object

Type: Object

pixelSizePerMM()

Gets pixel size in millimeters

Inherited From:

Layer#pixelSizePerMM

Overrides:

Layer#pixelSizePerMM

Source:

Layer.js, line 372

Returns:

Size of one pixel in mm

Type: number

removeShaderFilter(name)

Removes a filter from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#removeShaderFilter

Overrides:

Layer#removeShaderFilter

Source:

Layer.js, line 180

Throws:

If no shader is set
Type Error

scale()

Gets layer scale

Inherited From:

Layer#scale

Overrides:

Layer#scale

Source:

Layer.js, line 362

Returns:

Current scale value

Type: number

setControl(name, value [, dt] [, easing])

Sets a shader control value with optional animation

Parameters:

Name	Type	Argument	Default	Description
`name`	string			Control identifier
`value`	*			New value
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function

Inherited From:

Layer#setControl

Overrides:

Layer#setControl

Source:

Layer.js, line 452

Fires:

Layer#event:update

setLight(light [, dt] [, easing])

Sets the light direction with optional animation

Parameters:

Name	Type	Argument	Default	Description
`light`	Array.<number>			2D vector [x, y] representing light direction
`dt`	number	<optional>		Animation duration in milliseconds
`easing`	string	<optional>	'linear'	Animation easing function

Source:

LayerBRDF.js, line 193

setMode(mode)

Sets shader visualization mode

Parameters:

Name	Type	Description
`mode`	string	Mode to set

Inherited From:

Layer#setMode

Overrides:

Layer#setMode

Source:

Layer.js, line 310

Fires:

Layer#event:update

setShader(id)

Sets the active shader

Parameters:

Name	Type	Description
`id`	string	Shader identifier from registered shaders

Inherited From:

Layer#setShader

Overrides:

Layer#setShader

Source:

Layer.js, line 277

Fires:

Layer#event:update

Throws:

If shader ID is not found
Type Error

setState(state [, dt] [, easing])

Sets the layer state with optional animation

Parameters:

Name	Type	Argument	Default	Description
`state`	Object			State object with controls and mode
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function ('linear'\|'ease-out'\|'ease-in-out')