|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.media.j3d.SceneGraphObject | +--javax.media.j3d.NodeComponent | +--javax.media.j3d.Geometry | +--javax.media.j3d.Raster
The Raster object extends Geometry to allow drawing a raster image that is attached to a 3D location in the virtual world. It contains a point that is defined in the local object coordinate system of the Shape3D node that references the Raster. It also contains a type specifier, a reference to a ImageComponent2D object and/or a DepthComponent object, and an integer x,y offset and a size (width, height) to allow reading or writing a portion of the referenced image. In addition to being used as a type of geometry for drawing, a Raster may be used to readback pixel data (color and/or z-buffer) from the frame buffer in immediate mode.
The geometric extent of a Raster object is a single 3D point, specified by the raster position. This means that geometry-based picking or collision with a Raster object will only intersect the object at this single point; the 2D raster image is neither pickable nor collidable.
Field Summary | |
static int |
ALLOW_DEPTH_COMPONENT_READ
Specifies that this Raster allows reading the depth component. |
static int |
ALLOW_DEPTH_COMPONENT_WRITE
Specifies that this Raster allows writing the depth component. |
static int |
ALLOW_IMAGE_READ
Specifies that this Raster allows reading the image. |
static int |
ALLOW_IMAGE_WRITE
Specifies that this Raster allows writing the image. |
static int |
ALLOW_OFFSET_READ
Specifies that this Raster allows reading the offset . |
static int |
ALLOW_OFFSET_WRITE
Specifies that this Raster allows writing the offset. |
static int |
ALLOW_POSITION_READ
Specifies that this Raster allows reading the position. |
static int |
ALLOW_POSITION_WRITE
Specifies that this Raster allows writing the position. |
static int |
ALLOW_SIZE_READ
Specifies that this Raster allows reading the size. |
static int |
ALLOW_SIZE_WRITE
Specifies that this Raster allows writing the size. |
static int |
ALLOW_TYPE_READ
Specifies that this Raster allows reading the type. |
static int |
RASTER_COLOR
Specifies a Raster object with color data. |
static int |
RASTER_COLOR_DEPTH
Specifies a Raster object with both color and depth (z-buffer) data. |
static int |
RASTER_DEPTH
Specifies a Raster object with depth (z-buffer) data. |
Fields inherited from class javax.media.j3d.Geometry |
ALLOW_INTERSECT |
Constructor Summary | |
Raster()
Constructs a Raster object with default parameters. |
|
Raster(Point3f pos,
int type,
int xOffset,
int yOffset,
int width,
int height,
ImageComponent2D image,
DepthComponent depthComponent)
Constructs a new Raster object with the specified values. |
|
Raster(Point3f pos,
int type,
java.awt.Point offset,
java.awt.Dimension size,
ImageComponent2D image,
DepthComponent depthComponent)
Constructs a new Raster object with the specified values. |
Method Summary | |
NodeComponent |
cloneNodeComponent()
Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate) |
void |
duplicateNodeComponent(NodeComponent originalNodeComponent)
Deprecated. replaced with duplicateNodeComponent( NodeComponent originalNodeComponent, boolean forceDuplicate) |
DepthComponent |
getDepthComponent()
Retrieves the current depth image object. |
ImageComponent2D |
getImage()
Retrieves the current pixel array object. |
void |
getOffset(java.awt.Point offset)
Retrieves the current pixel offset. |
void |
getPosition(Point3f pos)
Retrieves the current position in object coordinates of this raster. |
void |
getSize(java.awt.Dimension size)
Retrieves the current raster size. |
int |
getType()
Retrieves the current type of this raster object, one of: RASTER_COLOR, RASTER_DEPTH, or RASTER_COLOR_DEPTH. |
void |
setDepthComponent(DepthComponent depthComponent)
Sets the depth image used to copy pixels to/from a Canvas3D. |
void |
setImage(ImageComponent2D image)
Sets the pixel array used to copy pixels to/from a Canvas3D. |
void |
setOffset(int xOffset,
int yOffset)
Sets the offset within the array of pixels at which to start copying. |
void |
setOffset(java.awt.Point offset)
Sets the offset within the array of pixels at which to start copying. |
void |
setPosition(Point3f pos)
Sets the position in object coordinates of this raster. |
void |
setSize(java.awt.Dimension size)
Sets the size of the array of pixels to be copied. |
void |
setSize(int width,
int height)
Sets the number of pixels to be copied from the pixel array. |
void |
setType(int type)
Sets the type of this raster object to one of: RASTER_COLOR, RASTER_DEPTH, or RASTER_COLOR_DEPTH. |
Methods inherited from class javax.media.j3d.NodeComponent |
cloneNodeComponent,
duplicateNodeComponent,
getDuplicateOnCloneTree,
setDuplicateOnCloneTree |
Methods inherited from class javax.media.j3d.SceneGraphObject |
clearCapability,
duplicateSceneGraphObject,
getCapability,
getUserData,
isCompiled,
isLive,
setCapability,
setUserData,
updateNodeReferences |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int RASTER_COLOR
public static final int RASTER_DEPTH
public static final int RASTER_COLOR_DEPTH
public static final int ALLOW_POSITION_READ
public static final int ALLOW_POSITION_WRITE
public static final int ALLOW_OFFSET_READ
public static final int ALLOW_OFFSET_WRITE
public static final int ALLOW_IMAGE_READ
public static final int ALLOW_IMAGE_WRITE
public static final int ALLOW_DEPTH_COMPONENT_READ
public static final int ALLOW_DEPTH_COMPONENT_WRITE
public static final int ALLOW_SIZE_READ
public static final int ALLOW_SIZE_WRITE
public static final int ALLOW_TYPE_READ
Constructor Detail |
public Raster()
public Raster(Point3f pos, int type, int xOffset, int yOffset, int width, int height, ImageComponent2D image, DepthComponent depthComponent)
pos
- the position in object coordinates of the upper-left
corner of the rastertype
- the type of raster object, one of: RASTER_COLOR,
RASTER_DEPTH, or RASTER_COLOR_DEPTHxOffset
- the x offset within the array of pixels at which to
start copyingyOffset
- the y offset within the array of pixels at which to
start copyingwidth
- the number of columns of pixels to copyheight
- the number of rows of pixels to copyimage
- the ImageComponent2D object containing the
color datadepthImage
- the DepthComponent object containing the depth
(z-buffer) datapublic Raster(Point3f pos, int type, java.awt.Point offset, java.awt.Dimension size, ImageComponent2D image, DepthComponent depthComponent)
pos
- the position in object coordinates of the upper-left
corner of the rastertype
- the type of raster object, one of: RASTER_COLOR,
RASTER_DEPTH, or RASTER_COLOR_DEPTHoffset
- the offset within the array of pixels at which to
start copyingsize
- the width and height of the image to be copiedimage
- the ImageComponent2D object containing the
color datadepthImage
- the DepthComponent object containing the depth
(z-buffer) dataMethod Detail |
public void setPosition(Point3f pos)
pos
- the new position of this rasterpublic void getPosition(Point3f pos)
pos
- the vector that will receive the current positionpublic void setType(int type)
type
- the new type of this rasterpublic int getType()
public void setOffset(int xOffset, int yOffset)
xOffset
- the x offset within the array of pixels at which to
start copyingyOffset
- the y offset within the array of pixels at which to
start copyingpublic void setOffset(java.awt.Point offset)
offset
- the new pixel offsetpublic void getOffset(java.awt.Point offset)
offset
- the object that will receive the offsetpublic void setSize(int width, int height)
width
- the number of columns in the array of pixels to copyheight
- the number of rows in the array of pixels to copypublic void setSize(java.awt.Dimension size)
size
- the new sizepublic void getSize(java.awt.Dimension size)
size
- the object that will receive the sizepublic void setImage(ImageComponent2D image)
image
- the ImageComponent2D object containing the
color datapublic ImageComponent2D getImage()
public void setDepthComponent(DepthComponent depthComponent)
depthImage
- the DepthComponent object containing the
depth (z-buffer) datapublic DepthComponent getDepthComponent()
public NodeComponent cloneNodeComponent()
public void duplicateNodeComponent(NodeComponent originalNodeComponent)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |