All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.TransparencyAttributes

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.NodeComponent
                   |
                   +----java.media.j3d.TransparencyAttributes

public class TransparencyAttributes
extends NodeComponent
The TransparencyAttributes object defines all attributes affecting transparency of the object.


Variable Index

 o ALLOW_MODE_READ
Specifies that this TransparencyAttributes object allows reading its transparency mode component information.
 o ALLOW_MODE_WRITE
Specifies that this TransparencyAttributes object allows writing its transparency mode component information.
 o ALLOW_VALUE_READ
Specifies that this TransparencyAttributes object allows reading its transparency value.
 o ALLOW_VALUE_WRITE
Specifies that this TransparencyAttributes object allows writing its transparency value.
 o BLENDED
Use alpha blended transparency.
 o FASTEST
Use the fastest available method for transparency.
 o NICEST
Use the nicest available method for transparency.
 o NONE
No transparency, opaque object.
 o SCREEN_DOOR
Use screen-door transparency.

Constructor Index

 o TransparencyAttributes()
Construct TransparencyAttributes object with default values.
 o TransparencyAttributes(int, float)
Construct TransparencyAttributes object with specified values.

Method Index

 o getTransparency()
Retrieves this appearance's transparency.
 o getTransparencyMode()
Gets the transparency mode for this appearance component object.
 o setTransparency(float)
Sets this appearance's transparency.
 o setTransparencyMode(int)
Sets the transparency mode for this appearance component object.

Variables

 o ALLOW_MODE_READ
 public static final int ALLOW_MODE_READ
Specifies that this TransparencyAttributes object allows reading its transparency mode component information.

 o ALLOW_MODE_WRITE
 public static final int ALLOW_MODE_WRITE
Specifies that this TransparencyAttributes object allows writing its transparency mode component information.

 o ALLOW_VALUE_READ
 public static final int ALLOW_VALUE_READ
Specifies that this TransparencyAttributes object allows reading its transparency value.

 o ALLOW_VALUE_WRITE
 public static final int ALLOW_VALUE_WRITE
Specifies that this TransparencyAttributes object allows writing its transparency value.

 o FASTEST
 public static final int FASTEST
Use the fastest available method for transparency.

 o NICEST
 public static final int NICEST
Use the nicest available method for transparency.

 o BLENDED
 public static final int BLENDED
Use alpha blended transparency. A blend equation of: alpha*src + (1-alpha)*dst is used where alpha is 1-transparency.

 o SCREEN_DOOR
 public static final int SCREEN_DOOR
Use screen-door transparency. This is done using an on/off stipple pattern where the percentage of pixels that are transparent is approximately equal to the value specified by the transparency parameter.

 o NONE
 public static final int NONE
No transparency, opaque object.

Constructors

 o TransparencyAttributes
 public TransparencyAttributes()
Construct TransparencyAttributes object with default values.

 o TransparencyAttributes
 public TransparencyAttributes(int tMode,
                               float tVal)
Construct TransparencyAttributes object with specified values.

Parameters:
tMode - the transparency mode.
tVal - the transparency value.

Methods

 o setTransparencyMode
 public final void setTransparencyMode(int transparencyMode)
Sets the transparency mode for this appearance component object.

Parameters:
transparencyMode - the transparency mode to be used, one of FASTEST, NICEST, SCREEN_DOOR, or BLENDED
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
 o getTransparencyMode
 public final int getTransparencyMode()
Gets the transparency mode for this appearance component object.

Returns:
transparencyMode the transparency mode
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
 o setTransparency
 public final void setTransparency(float transparency)
Sets this appearance's transparency.

Parameters:
transparency - the appearance's transparency in the range [0.0, 1.0] with 0.0 being fully opaque and 1.0 being fully transparent
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
 o getTransparency
 public final float getTransparency()
Retrieves this appearance's transparency.

Returns:
the appearance's transparency
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph

All Packages  Class Hierarchy  This Package  Previous  Next  Index