JavaFX 24 · com.sun.scenario.effect.PhongLighting · APIdia, the JavaDoc alternative

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

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

Method Summary

Modifier and Type	Method and Description
public BaseBounds	getBounds(BaseTransform the transform the effect will be viewed under transform, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) Overrides com.sun.scenario.effect.FilterEffect.getBounds. Returns the bounding box that will be affected by this filter operation when viewed under the specified `transform`, given its list of input `Effect`s and the specified `defaultInput` effect.
public final Effect	Returns: the bump input for this `Effect` getBumpInput() Returns the bump input for this `Effect`.
public final Effect	Returns: the content input for this `Effect` getContentInput() Returns the content input for this `Effect`.
private Effect	getContentInput(Effect defaultInput)
public float	Returns: the diffuse constant value getDiffuseConstant() Returns the diffuse constant.
public DirtyRegionContainer	getDirtyRegions(Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput, DirtyRegionPool the pool of dirty regions regionPool) Overrides com.sun.scenario.effect.Effect.getDirtyRegions. Returns the dirty region container containing dirty regions affected by this filter operation.
public Light	Returns: the light source getLight() Returns the light source.
public RenderState	getRenderState(FilterContext the context object that would be used by the Renderer if this call is preparing for a render operation, or null fctx, BaseTransform the transform for the output of this operation transform, Rectangle the clip rectangle that may restrict this operation, or null outputClip, Object the rendering helper object that can be used to shortcut this operation under certain conditions, or null renderHelper, Effect the `Effect` to be used in place of any null inputs defaultInput) Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState. Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
public Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas) Overrides com.sun.scenario.effect.Effect.getResultBounds.
public float	Returns: the specular constant value getSpecularConstant() Returns the specular constant.
public float	Returns: the specular exponent value getSpecularExponent() Returns the specular exponent.
public float	Returns: the surface scale value getSurfaceScale() Returns the surface scale.
public boolean	reducesOpaquePixels() Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels. Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
public void	setBumpInput(Effect the bump input for this `Effect` bumpInput) Sets the bump input for this `Effect` to a specific `Effect` or to the default input if `input` is `null`.
public void	setContentInput(Effect the content input for this `Effect` contentInput) Sets the content input for this `Effect` to a specific `Effect` or to the default input if `input` is `null`.
public void	setDiffuseConstant(float the diffuse constant value diffuseConstant) Sets the diffuse constant.
public void	setLight(Light the light source light) Sets the light source.
public void	setSpecularConstant(float the specular constant value specularConstant) Sets the specular constant.
public void	setSpecularExponent(float the specular exponent value specularExponent) Sets the specular exponent.
public void	setSurfaceScale(float the surface scale value surfaceScale) Sets the surface scale.
public Point2D	transform(Point2D the point in the coordinate space of the primary content input to be transformed p, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) Overrides com.sun.scenario.effect.FilterEffect.transform. Transform the specified point `p` from the coordinate space of the primary content input to the coordinate space of the effect output.
public Point2D	untransform(Point2D the point in the coordinate space of the result output to be transformed p, Effect the default input `Effect` to be used in all cases where a filter has a null input defaultInput) Overrides com.sun.scenario.effect.FilterEffect.untransform. Transform the specified point `p` from the coordinate space of the output of the effect into the coordinate space of the primary content input.

Inherited from com.sun.scenario.effect.CoreEffect:: filterImageDatas getAccelType getPeer updatePeerKey updatePeerKey

diffuseConstant	back to summary
private float diffuseConstant

light	back to summary
private Light light

specularConstant	back to summary
private float specularConstant

specularExponent	back to summary
private float specularExponent

surfaceScale	back to summary
private float surfaceScale

PhongLighting	back to summary
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:Light the light source Exceptions IllegalArgumentException: if `light` is null

PhongLighting	back to summary
public PhongLighting(Light light, Effect bumpInput, Effect contentInput) Constructs a new `PhongLighting` effect for the given `Light` and the given bump and content input `Effect`s with default values for all other properties. Parameters light:Light the light source bumpInput:Effect the input containing the bump map contentInput:Effect the input containing the content data Exceptions IllegalArgumentException: if `light` is null

Method Detail

getBounds back to summary

getBounds	back to summary
public BaseBounds getBounds(BaseTransform transform, Effect defaultInput) Overrides com.sun.scenario.effect.FilterEffect.getBounds. Doc from com.sun.scenario.effect.Effect.getBounds. Returns the bounding box that will be affected by this filter operation when viewed under the specified `transform`, given its list of input `Effect`s and the specified `defaultInput` effect. Note that the returned bounds can be smaller or larger than one or more of the inputs. Parameters transform:BaseTransform the transform the effect will be viewed under defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input Returns:BaseBounds the bounding box of this filter Annotations @Override

public BaseBounds getBounds(BaseTransform transform, Effect defaultInput)

Overrides com.sun.scenario.effect.FilterEffect.getBounds.

Doc from com.sun.scenario.effect.Effect.getBounds.

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.

Parameters

transform:BaseTransform: the transform the effect will be viewed under
defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input

Returns:BaseBounds

the bounding box of this filter

Annotations

@Override

getBumpInput back to summary

getBumpInput	back to summary
public final Effect getBumpInput() Returns the bump input for this `Effect`. Returns:Effect the bump input for this `Effect`

public final Effect getBumpInput()

Returns the bump input for this Effect.

Returns:Effect: the bump input for this Effect

getContentInput back to summary

getContentInput	back to summary
public final Effect getContentInput() Returns the content input for this `Effect`. Returns:Effect the content input for this `Effect`

public final Effect getContentInput()

Returns the content input for this Effect.

Returns:Effect: the content input for this Effect

getContentInput	back to summary
private Effect getContentInput(Effect defaultInput)

getDiffuseConstant	back to summary
public float getDiffuseConstant() Returns the diffuse constant. Returns:float the diffuse constant value

getDiffuseConstant

back to summary

public float getDiffuseConstant()

Returns the diffuse constant.

Returns:float: the diffuse constant value

getDirtyRegions back to summary

getDirtyRegions	back to summary
public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Overrides com.sun.scenario.effect.Effect.getDirtyRegions. Doc from com.sun.scenario.effect.Effect.getDirtyRegions. Returns the dirty region container containing dirty regions affected by this filter operation. Parameters defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input regionPool:DirtyRegionPool the pool of dirty regions Returns:DirtyRegionContainer the dirty region container Annotations @Override

public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool)

Overrides com.sun.scenario.effect.Effect.getDirtyRegions.

Doc from com.sun.scenario.effect.Effect.getDirtyRegions.

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

Parameters

defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input
regionPool:DirtyRegionPool: the pool of dirty regions

Returns:DirtyRegionContainer

the dirty region container

Annotations

@Override

getLight	back to summary
public Light getLight() Returns the light source. Returns:Light the light source

getLight

back to summary

public Light getLight()

Returns the light source.

Returns:Light: the light source

getRenderState back to summary

getRenderState	back to summary
public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput) Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState. Doc from com.sun.scenario.effect.FilterEffect.getRenderState. 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. Parameters fctx:FilterContext the context object that would be used by the Renderer if this call is preparing for a render operation, or null transform:BaseTransform the transform for the output of this operation outputClip:Rectangle the clip rectangle that may restrict this operation, or null renderHelper:Object the rendering helper object that can be used to shortcut this operation under certain conditions, or null defaultInput:Effect the `Effect` to be used in place of any null inputs Annotations @Override

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

Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState.

Doc from com.sun.scenario.effect.FilterEffect.getRenderState.

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.

Parameters

fctx:FilterContext: the context object that would be used by the Renderer if this call is preparing for a render operation, or null
transform:BaseTransform: the transform for the output of this operation
outputClip:Rectangle: the clip rectangle that may restrict this operation, or null
renderHelper:Object: the rendering helper object that can be used to shortcut this operation under certain conditions, or null
defaultInput:Effect: the Effect to be used in place of any null inputs

Annotations

@Override

getResultBounds	back to summary
public Rectangle getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas) Overrides com.sun.scenario.effect.Effect.getResultBounds. Annotations @Override

getResultBounds

back to summary

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

Overrides com.sun.scenario.effect.Effect.getResultBounds.

Annotations

@Override

getSpecularConstant	back to summary
public float getSpecularConstant() Returns the specular constant. Returns:float the specular constant value

getSpecularConstant

back to summary

public float getSpecularConstant()

Returns the specular constant.

Returns:float: the specular constant value

getSpecularExponent	back to summary
public float getSpecularExponent() Returns the specular exponent. Returns:float the specular exponent value

getSpecularExponent

back to summary

public float getSpecularExponent()

Returns the specular exponent.

Returns:float: the specular exponent value

getSurfaceScale	back to summary
public float getSurfaceScale() Returns the surface scale. Returns:float the surface scale value

getSurfaceScale

back to summary

public float getSurfaceScale()

Returns the surface scale.

Returns:float: the surface scale value

reducesOpaquePixels	back to summary
public boolean reducesOpaquePixels() Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels. Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels. 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. Returns:boolean 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. Annotations @Override

reducesOpaquePixels

back to summary

public boolean reducesOpaquePixels()

Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels.

Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels.

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.

Returns:boolean

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.

Annotations

@Override

setBumpInput back to summary

setBumpInput	back to summary
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:Effect the bump input for this `Effect`

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:Effect: the bump input for this Effect

setContentInput back to summary

setContentInput	back to summary
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:Effect the content input for this `Effect`

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:Effect: the content input for this Effect

setDiffuseConstant back to summary

setDiffuseConstant	back to summary
public void setDiffuseConstant(float diffuseConstant) Sets the diffuse constant. Min: 0.0 Max: 2.0 Default: 1.0 Identity: n/a Parameters diffuseConstant:float the diffuse constant value Exceptions IllegalArgumentException: if `diffuseConstant` is outside the allowable range

public void setDiffuseConstant(float diffuseConstant)

Sets the diffuse constant.

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

Parameters

diffuseConstant:float: the diffuse constant value

Exceptions

IllegalArgumentException:: if diffuseConstant is outside the allowable range

setLight back to summary

setLight	back to summary
public void setLight(Light light) Sets the light source. Parameters light:Light the light source Exceptions IllegalArgumentException: if `light` is null

public void setLight(Light light)

Sets the light source.

Parameters

light:Light: the light source

Exceptions

IllegalArgumentException:: if light is null

setSpecularConstant back to summary

setSpecularConstant	back to summary
public void setSpecularConstant(float specularConstant) Sets the specular constant. Min: 0.0 Max: 2.0 Default: 1.0 Identity: n/a Parameters specularConstant:float the specular constant value Exceptions IllegalArgumentException: if `specularConstant` is outside the allowable range

public void setSpecularConstant(float specularConstant)

Sets the specular constant.

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

Parameters

specularConstant:float: the specular constant value

Exceptions

IllegalArgumentException:: if specularConstant is outside the allowable range

setSpecularExponent back to summary

setSpecularExponent	back to summary
public void setSpecularExponent(float specularExponent) Sets the specular exponent. Min: 0.0 Max: 40.0 Default: 1.0 Identity: n/a Parameters specularExponent:float the specular exponent value Exceptions IllegalArgumentException: if `specularExponent` is outside the allowable range

public void setSpecularExponent(float specularExponent)

Sets the specular exponent.

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

Parameters

specularExponent:float: the specular exponent value

Exceptions

IllegalArgumentException:: if specularExponent is outside the allowable range

setSurfaceScale back to summary

setSurfaceScale	back to summary
public void setSurfaceScale(float surfaceScale) Sets the surface scale. Min: 0.0 Max: 10.0 Default: 1.0 Identity: n/a Parameters surfaceScale:float the surface scale value Exceptions IllegalArgumentException: if `surfaceScale` is outside the allowable range

public void setSurfaceScale(float surfaceScale)

Sets the surface scale.

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

Parameters

surfaceScale:float: the surface scale value

Exceptions

IllegalArgumentException:: if surfaceScale is outside the allowable range

transform back to summary

transform	back to summary
public Point2D transform(Point2D p, Effect defaultInput) Overrides com.sun.scenario.effect.FilterEffect.transform. Doc from com.sun.scenario.effect.Effect.transform. 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. Parameters p:Point2D the point in the coordinate space of the primary content input to be transformed defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input Returns:Point2D the transformed point in the coordinate space of the result Annotations @Override

public Point2D transform(Point2D p, Effect defaultInput)

Overrides com.sun.scenario.effect.FilterEffect.transform.

Doc from com.sun.scenario.effect.Effect.transform.

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.

Parameters

p:Point2D: the point in the coordinate space of the primary content input to be transformed
defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input

Returns:Point2D

the transformed point in the coordinate space of the result

Annotations

@Override

untransform back to summary

untransform	back to summary
public Point2D untransform(Point2D p, Effect defaultInput) Overrides com.sun.scenario.effect.FilterEffect.untransform. Doc from com.sun.scenario.effect.Effect.untransform. 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. Parameters p:Point2D the point in the coordinate space of the result output to be transformed defaultInput:Effect the default input `Effect` to be used in all cases where a filter has a null input Returns:Point2D the untransformed point in the coordinate space of the primary content input Annotations @Override

public Point2D untransform(Point2D p, Effect defaultInput)

Overrides com.sun.scenario.effect.FilterEffect.untransform.

Doc from com.sun.scenario.effect.Effect.untransform.

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.

Parameters

p:Point2D: the point in the coordinate space of the result output to be transformed
defaultInput:Effect: the default input Effect to be used in all cases where a filter has a null input

Returns:Point2D

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

Annotations

@Override

public Class PhongLighting

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail