Package com.luciad.tea.lightspeed.hypsometry

Class TLspHypsometricHillShadingShader

java.lang.Object

com.luciad.tea.lightspeed.hypsometry.ALspHypsometricShader

com.luciad.tea.lightspeed.hypsometry.ALspHypsometric3DDirectionShader

com.luciad.tea.lightspeed.hypsometry.TLspHypsometricHillShadingShader

public class TLspHypsometricHillShadingShader
extends ALspHypsometric3DDirectionShader

A shader that computes the cosine of the angle between a given 3D reference direction and the normal. The reference direction should generally have a positive z-component. Negative cosine values are clamped to 0, so the values lie in the range [0, 1].

This shader is typically useful for computing hill shading, by selecting a reference direction that specifies the direction of the sun (in the local coordinate system of the raster). The computed values then correspond to diffuse shading resulting from the sunlight, ranging for 0 for unlit areas to 1 for brightly lit areas.

This shader provides similar results to the TLcdHypsometricSlope.

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TLspHypsometricHillShadingShader.Builder<B extends TLspHypsometricHillShadingShader.Builder<B>>	Builder for hill shading shaders.

Method Summary

Modifier and Type	Method	Description
TLspHypsometricHillShadingShader.Builder<?>	asBuilder()	Creates a new builder initialized with all the properties of this shader.
double	getMaxValue()	Returns the maximum hypsometric value that this provider may return.
double	getMinValue()	Returns the minimum hypsometric value that this provider may return.
static TLspHypsometricHillShadingShader.Builder<?>	newBuilder()	Creates a new builder with the default values.

Methods inherited from class com.luciad.tea.lightspeed.hypsometry.ALspHypsometric3DDirectionShader

equals, getReferenceDirectionX, getReferenceDirectionY, getReferenceDirectionZ, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

newBuilder

public static TLspHypsometricHillShadingShader.Builder<?> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

asBuilder

public TLspHypsometricHillShadingShader.Builder<?> asBuilder()

Creates a new builder initialized with all the properties of this shader.

Specified by:

asBuilder in class ALspHypsometric3DDirectionShader

Returns:

the new builder.

getMinValue

public double getMinValue()

Description copied from class: ALspHypsometricShader

Returns the minimum hypsometric value that this provider may return.

Specified by:

getMinValue in class ALspHypsometricShader

Returns:

the minimum hypsometric value

getMaxValue

public double getMaxValue()

Description copied from class: ALspHypsometricShader

Returns the maximum hypsometric value that this provider may return.

Specified by:

getMaxValue in class ALspHypsometricShader

Returns:

the maximum hypsometric value