|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.havi.ui.HImageMatte
public class HImageMatte
The HImageMatte
class represents a
matte that varies over space but is constant over time, it can be
specified by an "image mask" (a single channel image)
where the pixels indicate matte transparency.
Parameter | Description | Default value | Set method | Get method |
---|---|---|---|---|
data | The transparency value for this image matte. | null (the matte should be treated as being spatially unvarying and opaque) | setMatteData(java.awt.Image) |
getMatteData() |
Description | Default value | Set method | Get method |
---|---|---|---|
The pixel offset for the image matte, relative to the top, left corner of its associated component. | A java.awt.Point (0, 0) | setOffset(java.awt.Point) |
getOffset() |
Constructor Summary | |
---|---|
HImageMatte()
Creates an HImageMatte
object. |
|
HImageMatte(java.awt.Image data)
Creates an HImageMatte
object. |
Method Summary | |
---|---|
java.awt.Image |
getMatteData()
Returns the data used for this matte. |
java.awt.Point |
getOffset()
Get the offset of the matte relative to its component in pixels. |
void |
setMatteData(java.awt.Image data)
Sets the data for this matte. |
void |
setOffset(java.awt.Point p)
Set the offset of the matte relative to its component in pixels. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HImageMatte()
HImageMatte
object. See the class description for details of constructor
parameters and default values.
public HImageMatte(java.awt.Image data)
HImageMatte
object. See the class description for details of constructor
parameters and default values.
Method Detail |
---|
public void setMatteData(java.awt.Image data)
Note that if the size of the image is smaller than the size of the component to which the matte is applied, the empty space behaves as if it were an opaque flat matte of value 1.0. By default images are aligned at the top left corner of the component. This can be changed with the setOffset method.
data
- the data for this matte. Specify a null object to
remove the associated data for this matte.public java.awt.Image getMatteData()
public void setOffset(java.awt.Point p)
p
- the offset of the matte relative to its component in
pixels. If p is null a NullPointerException is thrown.public java.awt.Point getOffset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |