com.sun.scenario.effect

Class PhongLighting

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.FilterEffect<T>

com.sun.scenario.effect.CoreEffect<RenderState>

com.sun.scenario.effect.PhongLighting

public class PhongLighting
extends CoreEffect<RenderState>

An effect that applies diffuse and specular lighting to an arbitrary input using a positionable light source.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private float	diffuseConstant
private Light	light
private float	specularConstant
private float	specularExponent
private float	surfaceScale

Fields inherited from class com.sun.scenario.effect.Effect

DefaultInput

Constructor Summary

Constructors

Constructor and Description
PhongLighting(Light light) Constructs a new PhongLighting effect for the given Light, with default values for all other properties, using the default input for source data.
PhongLighting(Light light, Effect bumpInput, Effect contentInput) Constructs a new PhongLighting effect for the given Light and the given bump and content input Effects with default values for all other properties.

Method Summary

Modifier and Type	Method and Description
BaseBounds	getBounds(BaseTransform transform, Effect defaultInput) Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect.
Effect	getBumpInput() Returns the bump input for this Effect.
Effect	getContentInput() Returns the content input for this Effect.
private Effect	getContentInput(Effect defaultInput)
float	getDiffuseConstant() Returns the diffuse constant.
DirtyRegionContainer	getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Returns the dirty region container containing dirty regions affected by this filter operation.
Light	getLight() Returns the light source.
RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput) Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas)
float	getSpecularConstant() Returns the specular constant.
float	getSpecularExponent() Returns the specular exponent.
float	getSurfaceScale() Returns the surface scale.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setBumpInput(Effect bumpInput) Sets the bump input for this Effect to a specific Effect or to the default input if input is null.
void	setContentInput(Effect contentInput) Sets the content input for this Effect to a specific Effect or to the default input if input is null.
void	setDiffuseConstant(float diffuseConstant) Sets the diffuse constant.
void	setLight(Light light) Sets the light source.
void	setSpecularConstant(float specularConstant) Sets the specular constant.
void	setSpecularExponent(float specularExponent) Sets the specular exponent.
void	setSurfaceScale(float surfaceScale) Sets the surface scale.
Point2D	transform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output.
Point2D	untransform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input.

Methods inherited from class com.sun.scenario.effect.CoreEffect

filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey

Methods inherited from class com.sun.scenario.effect.FilterEffect

filter, untransformClip

Methods inherited from class com.sun.scenario.effect.Effect

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, getState, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

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

Field Detail

surfaceScale

private float surfaceScale

diffuseConstant

private float diffuseConstant

specularConstant

private float specularConstant

specularExponent

private float specularExponent

light

private Light light

Constructor Detail

PhongLighting

public PhongLighting(Light light)

Constructs a new PhongLighting effect for the given Light, with default values for all other properties, using the default input for source data. This is a convenience constructor that automatically generates a bump map using the default input.

Parameters:

light - the light source

Throws:

java.lang.IllegalArgumentException - if light is null

PhongLighting

public PhongLighting(Light light,
                     Effect bumpInput,
                     Effect contentInput)

Constructs a new PhongLighting effect for the given Light and the given bump and content input Effects with default values for all other properties.

Parameters:

light - the light source

bumpInput - the input containing the bump map

contentInput - the input containing the content data

Throws:

java.lang.IllegalArgumentException - if light is null

Method Detail

getBumpInput

public final Effect getBumpInput()

Returns the bump input for this Effect.

Returns:

the bump input for this Effect

setBumpInput

public void setBumpInput(Effect bumpInput)

Sets the bump input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

bumpInput - the bump input for this Effect

getContentInput

public final Effect getContentInput()

Returns the content input for this Effect.

Returns:

the content input for this Effect

getContentInput

private Effect getContentInput(Effect defaultInput)

setContentInput

public void setContentInput(Effect contentInput)

Sets the content input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

contentInput - the content input for this Effect

getLight

public Light getLight()

Returns the light source.

Returns:

the light source

setLight

public void setLight(Light light)

Sets the light source.

Parameters:

light - the light source

Throws:

java.lang.IllegalArgumentException - if light is null

getDiffuseConstant

public float getDiffuseConstant()

Returns the diffuse constant.

Returns:

the diffuse constant value

setDiffuseConstant

public void setDiffuseConstant(float diffuseConstant)

Sets the diffuse constant.

       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 

Parameters:

diffuseConstant - the diffuse constant value

Throws:

java.lang.IllegalArgumentException - if diffuseConstant is outside the allowable range

getSpecularConstant

public float getSpecularConstant()

Returns the specular constant.

Returns:

the specular constant value

setSpecularConstant

public void setSpecularConstant(float specularConstant)

Sets the specular constant.

       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 

Parameters:

specularConstant - the specular constant value

Throws:

java.lang.IllegalArgumentException - if specularConstant is outside the allowable range

getSpecularExponent

public float getSpecularExponent()

Returns the specular exponent.

Returns:

the specular exponent value

setSpecularExponent

public void setSpecularExponent(float specularExponent)

Sets the specular exponent.

       Min:  0.0
       Max: 40.0
   Default:  1.0
  Identity:  n/a
 

Parameters:

specularExponent - the specular exponent value

Throws:

java.lang.IllegalArgumentException - if specularExponent is outside the allowable range

getSurfaceScale

public float getSurfaceScale()

Returns the surface scale.

Returns:

the surface scale value

setSurfaceScale

public void setSurfaceScale(float surfaceScale)

Sets the surface scale.

       Min:  0.0
       Max: 10.0
   Default:  1.0
  Identity:  n/a
 

Parameters:

surfaceScale - the surface scale value

Throws:

java.lang.IllegalArgumentException - if surfaceScale is outside the allowable range

getBounds

public BaseBounds getBounds(BaseTransform transform,
                            Effect defaultInput)

Description copied from class: Effect

Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect. Note that the returned bounds can be smaller or larger than one or more of the inputs.

Overrides:

getBounds in class FilterEffect<RenderState>

Parameters:

transform - the transform the effect will be viewed under

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the bounding box of this filter

getResultBounds

public Rectangle getResultBounds(BaseTransform transform,
                                 Rectangle outputClip,
                                 ImageData... inputDatas)

Overrides:

getResultBounds in class Effect

transform

public Point2D transform(Point2D p,
                         Effect defaultInput)

Description copied from class: Effect

Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output. In essence, this method asks the question "Which output coordinate is most affected by the data at the specified coordinate in the primary source input?"

The definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map source coordinates to destination coordinates, but not the reverse. In particular, effects which map source coordinates discontiguously into the result may have several output coordinates that are affected by a given input coordinate and may choose to return one of many equally valid answers, or an undefined result such as NaN, or some other anomalous value. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

Overrides:

transform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the primary content input to be transformed

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the transformed point in the coordinate space of the result

untransform

public Point2D untransform(Point2D p,
                           Effect defaultInput)

Description copied from class: Effect

Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input. In essence, this method asks the question "Which source coordinate contributes most to the definition of the output at the specified coordinate?"

The definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map destination coordinates back to source coordinates, but not the reverse. In particular, effects which produce entirely synthetic results not based on any content input may not be able to give a meaningful result to this query and may return undefined coordinates such as 0, Infinity, or NaN. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

Overrides:

untransform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the result output to be transformed

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the untransformed point in the coordinate space of the primary content input

getRenderState

public RenderState getRenderState(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  java.lang.Object renderHelper,
                                  Effect defaultInput)

Description copied from class: FilterEffect

Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments. This call can also be used to get a state object for non-rendering cases like querying the bounds of an operation in which case the FilterContext object may be null. outputClip and renderHelper may always be null just as they may be null for a given filter operation.

Specified by:

getRenderState in class FilterEffect<RenderState>

Parameters:

fctx - the context object that would be used by the Renderer if this call is preparing for a render operation, or null

transform - the transform for the output of this operation

outputClip - the clip rectangle that may restrict this operation, or null

renderHelper - the rendering helper object that can be used to shortcut this operation under certain conditions, or null

defaultInput - the Effect to be used in place of any null inputs

Returns:

reducesOpaquePixels

public boolean reducesOpaquePixels()

Description copied from class: Effect

Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input. It is always safe to return true from this method, though the consequences may be that the caller chooses to not utilize a planned optimization.

Specified by:

reducesOpaquePixels in class Effect

Returns:

true if this effect may reduce opacity of some pixels of one of it's input (and thus the default input) or it's relevant input(s) might have reduced opaque pixels of the default input already.

getDirtyRegions

public DirtyRegionContainer getDirtyRegions(Effect defaultInput,
                                            DirtyRegionPool regionPool)

Description copied from class: Effect

Returns the dirty region container containing dirty regions affected by this filter operation.

Overrides:

getDirtyRegions in class Effect

Parameters:

defaultInput - the default input Effect to be used in all cases where a filter has a null input

regionPool - the pool of dirty regions

Returns:

the dirty region container