- java.lang.Object
-
- java.awt.image.renderable.RenderContext
-
- All Implemented Interfaces:
- Cloneable
public class RenderContext extends Object implements Cloneable
A RenderContext encapsulates the information needed to produce a specific rendering from a RenderableImage. It contains the area to be rendered specified in rendering-independent terms, the resolution at which the rendering is to be performed, and hints used to control the rendering process.Users create RenderContexts and pass them to the RenderableImage via the createRendering method. Most of the methods of RenderContexts are not meant to be used directly by applications, but by the RenderableImage and operator classes to which it is passed.
The AffineTransform parameter passed into and out of this class are cloned. The RenderingHints and Shape parameters are not necessarily cloneable and are therefore only reference copied. Altering RenderingHints or Shape instances that are in use by instances of RenderContext may have undesired side effects.
-
-
Constructor Summary
Constructors Constructor and Description RenderContext(AffineTransform usr2dev)
Constructs a RenderContext with a given transform.RenderContext(AffineTransform usr2dev, RenderingHints hints)
Constructs a RenderContext with a given transform and rendering hints.RenderContext(AffineTransform usr2dev, Shape aoi)
Constructs a RenderContext with a given transform and area of interest.RenderContext(AffineTransform usr2dev, Shape aoi, RenderingHints hints)
Constructs a RenderContext with a given transform.
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Makes a copy of a RenderContext.void
concatenateTransform(AffineTransform modTransform)
Modifies the current user-to-device transform by appending another transform.void
concetenateTransform(AffineTransform modTransform)
Deprecated.replaced byconcatenateTransform(AffineTransform)
.Shape
getAreaOfInterest()
Gets the ares of interest currently contained in the RenderContext.RenderingHints
getRenderingHints()
Gets the rendering hints of thisRenderContext
.AffineTransform
getTransform()
Gets the current user-to-device AffineTransform.void
preConcatenateTransform(AffineTransform modTransform)
Modifies the current user-to-device transform by prepending another transform.void
preConcetenateTransform(AffineTransform modTransform)
Deprecated.replaced bypreConcatenateTransform(AffineTransform)
.void
setAreaOfInterest(Shape newAoi)
Sets the current area of interest.void
setRenderingHints(RenderingHints hints)
Sets the rendering hints of thisRenderContext
.void
setTransform(AffineTransform newTransform)
Sets the current user-to-device AffineTransform contained in the RenderContext to a given transform.
-
-
-
Constructor Detail
-
RenderContext
public RenderContext(AffineTransform usr2dev, Shape aoi, RenderingHints hints)
Constructs a RenderContext with a given transform. The area of interest is supplied as a Shape, and the rendering hints are supplied as a RenderingHints object.- Parameters:
usr2dev
- an AffineTransform.aoi
- a Shape representing the area of interest.hints
- a RenderingHints object containing rendering hints.
-
RenderContext
public RenderContext(AffineTransform usr2dev)
Constructs a RenderContext with a given transform. The area of interest is taken to be the entire renderable area. No rendering hints are used.- Parameters:
usr2dev
- an AffineTransform.
-
RenderContext
public RenderContext(AffineTransform usr2dev, RenderingHints hints)
Constructs a RenderContext with a given transform and rendering hints. The area of interest is taken to be the entire renderable area.- Parameters:
usr2dev
- an AffineTransform.hints
- a RenderingHints object containing rendering hints.
-
RenderContext
public RenderContext(AffineTransform usr2dev, Shape aoi)
Constructs a RenderContext with a given transform and area of interest. The area of interest is supplied as a Shape. No rendering hints are used.- Parameters:
usr2dev
- an AffineTransform.aoi
- a Shape representing the area of interest.
-
-
Method Detail
-
getRenderingHints
public RenderingHints getRenderingHints()
Gets the rendering hints of thisRenderContext
.- Returns:
- a
RenderingHints
object that represents the rendering hints of thisRenderContext
. - See Also:
setRenderingHints(RenderingHints)
-
setRenderingHints
public void setRenderingHints(RenderingHints hints)
Sets the rendering hints of thisRenderContext
.- Parameters:
hints
- aRenderingHints
object that represents the rendering hints to assign to thisRenderContext
.- See Also:
getRenderingHints()
-
setTransform
public void setTransform(AffineTransform newTransform)
Sets the current user-to-device AffineTransform contained in the RenderContext to a given transform.- Parameters:
newTransform
- the new AffineTransform.- See Also:
getTransform()
-
preConcatenateTransform
public void preConcatenateTransform(AffineTransform modTransform)
Modifies the current user-to-device transform by prepending another transform. In matrix notation the operation is:[this] = [modTransform] x [this]
- Parameters:
modTransform
- the AffineTransform to prepend to the current usr2dev transform.- Since:
- 1.3
-
preConcetenateTransform
@Deprecated public void preConcetenateTransform(AffineTransform modTransform)
Deprecated. replaced bypreConcatenateTransform(AffineTransform)
.Modifies the current user-to-device transform by prepending another transform. In matrix notation the operation is:[this] = [modTransform] x [this]
This method does the same thing as the preConcatenateTransform method. It is here for backward compatibility with previous releases which misspelled the method name.- Parameters:
modTransform
- the AffineTransform to prepend to the current usr2dev transform.
-
concatenateTransform
public void concatenateTransform(AffineTransform modTransform)
Modifies the current user-to-device transform by appending another transform. In matrix notation the operation is:[this] = [this] x [modTransform]
- Parameters:
modTransform
- the AffineTransform to append to the current usr2dev transform.- Since:
- 1.3
-
concetenateTransform
@Deprecated public void concetenateTransform(AffineTransform modTransform)
Deprecated. replaced byconcatenateTransform(AffineTransform)
.Modifies the current user-to-device transform by appending another transform. In matrix notation the operation is:[this] = [this] x [modTransform]
This method does the same thing as the concatenateTransform method. It is here for backward compatibility with previous releases which misspelled the method name.- Parameters:
modTransform
- the AffineTransform to append to the current usr2dev transform.
-
getTransform
public AffineTransform getTransform()
Gets the current user-to-device AffineTransform.- Returns:
- a reference to the current AffineTransform.
- See Also:
setTransform(AffineTransform)
-
setAreaOfInterest
public void setAreaOfInterest(Shape newAoi)
Sets the current area of interest. The old area is discarded.- Parameters:
newAoi
- The new area of interest.- See Also:
getAreaOfInterest()
-
getAreaOfInterest
public Shape getAreaOfInterest()
Gets the ares of interest currently contained in the RenderContext.- Returns:
- a reference to the area of interest of the RenderContext, or null if none is specified.
- See Also:
setAreaOfInterest(Shape)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/image/renderable/rendercontext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.