On this page

ShaderColorLayer

A color layer where the color is fully computed in the shader.

Constructor

new ShaderColorLayer(properties)

A color layer where the color is fully computed in the shader. The given shader glsl code will be inserted in the main planet shader and color per fragment will be computed via a call to "vec3 getShaderLayerColor(vec3 llh, vec3 xyz, vec3 normal, float level);". Note that the normal is in world space. The given textures map will be automatically loaded and will be accessible in the shader by name (map keys) Only one visible ShaderColorLayer will be taken into account at a time.

Parameters:

Name Type Description

properties

Object

Properties

Name	Type	Attributes	Default	Description
`id`	String \| Number			layer id should be unique
`name`	String			the name can be anything you want and is intended for labeling
`shader`	String			a string representing shader code to be injected. Should at least implement the method : vec3 getShaderLayerColor(vec3 llh, vec3 xyz, vec3 normal, float level)
`textures`	Object	<optional>		an object containing texture names and THREE.Texture objects as key-value pairs
`transparency`	Number	<optional>	0	the layer's transparency (0 to 1)
`bounds`	Array.<Number>	<optional>	[-180, -90, 180, 90]	min longitude, min latitude, max longitude, max latitude in degrees
`visible`	Boolean	<optional>	true	layer will be rendered if true (true by default)

Source: layers/ShaderColorLayer.js, line 8

Extends

Layer

Methods

addListener(key, listener)

Adds a listener for layer events

Parameters:

Name	Type	Description
`key`	*	can be anything but should be unique
`listener`	function	a function : (layer, eventType)=>{}

Overrides: Layer#addListener
Source: layers/Layer.js, line 98

dispose()

disposes of any resources used by this layer

Overrides: Layer#dispose
Source: layers/Layer.js, line 140

getBounds() → {THREE.Box2}

Overrides: Layer#getBounds
Source: layers/Layer.js, line 77

Returns:

bounds in longitude latitude (degrees)

Type:: THREE.Box2

getCenter(sfct) → {THREE.Vector3}

Moves a given point to this layer's center in degree longitude/latitude

Parameters:

Name	Type	Description
`sfct`	THREE.Vector3	a point to move

Overrides: Layer#getCenter
Source: layers/Layer.js, line 33

Returns:

the input point

Type:: THREE.Vector3

getID()

Overrides: Layer#getID
Source: layers/Layer.js, line 43

Returns:

layer id

getName()

Overrides: Layer#getName
Source: layers/Layer.js, line 51

Returns:

layer name

getSelectableObjects()

Get all the selectable objects of this layer.

Overrides: Layer#getSelectableObjects
Source: layers/Layer.js, line 126

Returns:

an array of ray-castable objects with a property "layer" pointing to this layer.

removeListener(key)

Removes the listener associated to the given key

Parameters:

Name	Type	Description
`key`	*	can be anything but should be unique

Overrides: Layer#removeListener
Source: layers/Layer.js, line 89

select(objectsToSelect) → {Boolean}

selects an object from this layer

Parameters:

Name	Type	Description
`objectsToSelect`	Object

Overrides: Layer#select
Source: layers/Layer.js, line 107

Returns:

true if the object was selected, false otherwise

Type:: Boolean

setName(name)

change the layer name

Parameters:

Name	Type	Description
`name`	String

Overrides: Layer#setName
Source: layers/Layer.js, line 59

setVisible(visible)

Modifies the layer visibility

Parameters:

Name	Type	Description
`visible`	Boolean

Overrides: Layer#setVisible
Source: layers/Layer.js, line 66

unselect(objectsToUnselect) → {Boolean}

un-selects an object from this layer

Parameters:

Name	Type	Description
`objectsToUnselect`	Object

Overrides: Layer#unselect
Source: layers/Layer.js, line 117

Returns:

true if the object was un-selected, false otherwise

Type:: Boolean