- java.lang.Object
-
- java.awt.BasicStroke
-
- All Implemented Interfaces:
- Stroke
public class BasicStroke extends Object implements Stroke
TheBasicStroke
class defines a basic set of rendering attributes for the outlines of graphics primitives, which are rendered with aGraphics2D
object that has its Stroke attribute set to thisBasicStroke
. The rendering attributes defined byBasicStroke
describe the shape of the mark made by a pen drawn along the outline of aShape
and the decorations applied at the ends and joins of path segments of theShape
. These rendering attributes include:- width
- The pen width, measured perpendicularly to the pen trajectory.
- end caps
- The decoration applied to the ends of unclosed subpaths and
dash segments. Subpaths that start and end on the same point are
still considered unclosed if they do not have a CLOSE segment.
See
SEG_CLOSE
for more information on the CLOSE segment. The three different decorations are:CAP_BUTT
,CAP_ROUND
, andCAP_SQUARE
. - line joins
- The decoration applied at the intersection of two path segments
and at the intersection of the endpoints of a subpath that is closed
using
SEG_CLOSE
. The three different decorations are:JOIN_BEVEL
,JOIN_MITER
, andJOIN_ROUND
. - miter limit
- The limit to trim a line join that has a JOIN_MITER decoration. A line join is trimmed when the ratio of miter length to stroke width is greater than the miterlimit value. The miter length is the diagonal length of the miter, which is the distance between the inside corner and the outside corner of the intersection. The smaller the angle formed by two line segments, the longer the miter length and the sharper the angle of intersection. The default miterlimit value of 10.0f causes all angles less than 11 degrees to be trimmed. Trimming miters converts the decoration of the line join to bevel.
- dash attributes
- The definition of how to make a dash pattern by alternating between opaque and transparent sections.
Shape
argument. When aGraphics2D
object uses aStroke
object to redefine a path during the execution of one of itsdraw
methods, the geometry is supplied in its original form before theGraphics2D
transform attribute is applied. Therefore, attributes such as the pen width are interpreted in the user space coordinate system of theGraphics2D
object and are subject to the scaling and shearing effects of the user-space-to-device-space transform in that particularGraphics2D
. For example, the width of a rendered shape's outline is determined not only by the width attribute of thisBasicStroke
, but also by the transform attribute of theGraphics2D
object. Consider this code:// sets the Graphics2D object's Tranform attribute g2d.scale(10, 10); // sets the Graphics2D object's Stroke attribute g2d.setStroke(new BasicStroke(1.5f));
Assuming there are no other scaling transforms added to theGraphics2D
object, the resulting line will be approximately 15 pixels wide. As the example code demonstrates, a floating-point line offers better precision, especially when large transforms are used with aGraphics2D
object. When a line is diagonal, the exact width depends on how the rendering pipeline chooses which pixels to fill as it traces the theoretical widened outline. The choice of which pixels to turn on is affected by the antialiasing attribute because the antialiasing rendering pipeline can choose to color partially-covered pixels.For more information on the user space coordinate system and the rendering process, see the
Graphics2D
class comments.- See Also:
Graphics2D
-
-
Field Summary
Fields Modifier and Type Field and Description static int
CAP_BUTT
Ends unclosed subpaths and dash segments with no added decoration.static int
CAP_ROUND
Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the width of the pen.static int
CAP_SQUARE
Ends unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width.static int
JOIN_BEVEL
Joins path segments by connecting the outer corners of their wide outlines with a straight segment.static int
JOIN_MITER
Joins path segments by extending their outside edges until they meet.static int
JOIN_ROUND
Joins path segments by rounding off the corner at a radius of half the line width.
-
Constructor Summary
Constructors Constructor and Description BasicStroke()
Constructs a newBasicStroke
with defaults for all attributes.BasicStroke(float width)
Constructs a solidBasicStroke
with the specified line width and with default values for the cap and join styles.BasicStroke(float width, int cap, int join)
Constructs a solidBasicStroke
with the specified attributes.BasicStroke(float width, int cap, int join, float miterlimit)
Constructs a solidBasicStroke
with the specified attributes.BasicStroke(float width, int cap, int join, float miterlimit, float[] dash, float dash_phase)
Constructs a newBasicStroke
with the specified attributes.
-
Method Summary
Methods Modifier and Type Method and Description Shape
createStrokedShape(Shape s)
Returns aShape
whose interior defines the stroked outline of a specifiedShape
.boolean
equals(Object obj)
Tests if a specified object is equal to thisBasicStroke
by first testing if it is aBasicStroke
and then comparing its width, join, cap, miter limit, dash, and dash phase attributes with those of thisBasicStroke
.float[]
getDashArray()
Returns the array representing the lengths of the dash segments.float
getDashPhase()
Returns the current dash phase.int
getEndCap()
Returns the end cap style.int
getLineJoin()
Returns the line join style.float
getLineWidth()
Returns the line width.float
getMiterLimit()
Returns the limit of miter joins.int
hashCode()
Returns the hashcode for this stroke.
-
-
-
Field Detail
-
JOIN_MITER
public static final int JOIN_MITER
Joins path segments by extending their outside edges until they meet.- See Also:
- Constant Field Values
-
JOIN_ROUND
public static final int JOIN_ROUND
Joins path segments by rounding off the corner at a radius of half the line width.- See Also:
- Constant Field Values
-
JOIN_BEVEL
public static final int JOIN_BEVEL
Joins path segments by connecting the outer corners of their wide outlines with a straight segment.- See Also:
- Constant Field Values
-
CAP_BUTT
public static final int CAP_BUTT
Ends unclosed subpaths and dash segments with no added decoration.- See Also:
- Constant Field Values
-
CAP_ROUND
public static final int CAP_ROUND
Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the width of the pen.- See Also:
- Constant Field Values
-
CAP_SQUARE
public static final int CAP_SQUARE
Ends unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BasicStroke
@ConstructorProperties(value={"lineWidth","endCap","lineJoin","miterLimit","dashArray","dashPhase"}) public BasicStroke(float width, int cap, int join, float miterlimit, float[] dash, float dash_phase)
Constructs a newBasicStroke
with the specified attributes.- Parameters:
width
- the width of thisBasicStroke
. The width must be greater than or equal to 0.0f. If width is set to 0.0f, the stroke is rendered as the thinnest possible line for the target device and the antialias hint setting.cap
- the decoration of the ends of aBasicStroke
join
- the decoration applied where path segments meetmiterlimit
- the limit to trim the miter join. The miterlimit must be greater than or equal to 1.0f.dash
- the array representing the dashing patterndash_phase
- the offset to start the dashing pattern- Throws:
IllegalArgumentException
- ifwidth
is negativeIllegalArgumentException
- ifcap
is not either CAP_BUTT, CAP_ROUND or CAP_SQUAREIllegalArgumentException
- ifmiterlimit
is less than 1 andjoin
is JOIN_MITERIllegalArgumentException
- ifjoin
is not either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITERIllegalArgumentException
- ifdash_phase
is negative anddash
is notnull
IllegalArgumentException
- if the length ofdash
is zeroIllegalArgumentException
- if dash lengths are all zero.
-
BasicStroke
public BasicStroke(float width, int cap, int join, float miterlimit)
Constructs a solidBasicStroke
with the specified attributes.- Parameters:
width
- the width of theBasicStroke
cap
- the decoration of the ends of aBasicStroke
join
- the decoration applied where path segments meetmiterlimit
- the limit to trim the miter join- Throws:
IllegalArgumentException
- ifwidth
is negativeIllegalArgumentException
- ifcap
is not either CAP_BUTT, CAP_ROUND or CAP_SQUAREIllegalArgumentException
- ifmiterlimit
is less than 1 andjoin
is JOIN_MITERIllegalArgumentException
- ifjoin
is not either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
-
BasicStroke
public BasicStroke(float width, int cap, int join)
Constructs a solidBasicStroke
with the specified attributes. Themiterlimit
parameter is unnecessary in cases where the default is allowable or the line joins are not specified as JOIN_MITER.- Parameters:
width
- the width of theBasicStroke
cap
- the decoration of the ends of aBasicStroke
join
- the decoration applied where path segments meet- Throws:
IllegalArgumentException
- ifwidth
is negativeIllegalArgumentException
- ifcap
is not either CAP_BUTT, CAP_ROUND or CAP_SQUAREIllegalArgumentException
- ifjoin
is not either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
-
BasicStroke
public BasicStroke(float width)
Constructs a solidBasicStroke
with the specified line width and with default values for the cap and join styles.- Parameters:
width
- the width of theBasicStroke
- Throws:
IllegalArgumentException
- ifwidth
is negative
-
BasicStroke
public BasicStroke()
Constructs a newBasicStroke
with defaults for all attributes. The default attributes are a solid line of width 1.0, CAP_SQUARE, JOIN_MITER, a miter limit of 10.0.
-
-
Method Detail
-
createStrokedShape
public Shape createStrokedShape(Shape s)
Returns aShape
whose interior defines the stroked outline of a specifiedShape
.- Specified by:
createStrokedShape
in interfaceStroke
- Parameters:
s
- theShape
boundary be stroked- Returns:
- the
Shape
of the stroked outline.
-
getLineWidth
public float getLineWidth()
Returns the line width. Line width is represented in user space, which is the default-coordinate space used by Java 2D. See theGraphics2D
class comments for more information on the user space coordinate system.- Returns:
- the line width of this
BasicStroke
. - See Also:
Graphics2D
-
getEndCap
public int getEndCap()
Returns the end cap style.- Returns:
- the end cap style of this
BasicStroke
as one of the staticint
values that define possible end cap styles.
-
getLineJoin
public int getLineJoin()
Returns the line join style.- Returns:
- the line join style of the
BasicStroke
as one of the staticint
values that define possible line join styles.
-
getMiterLimit
public float getMiterLimit()
Returns the limit of miter joins.- Returns:
- the limit of miter joins of the
BasicStroke
.
-
getDashArray
public float[] getDashArray()
Returns the array representing the lengths of the dash segments. Alternate entries in the array represent the user space lengths of the opaque and transparent segments of the dashes. As the pen moves along the outline of theShape
to be stroked, the user space distance that the pen travels is accumulated. The distance value is used to index into the dash array. The pen is opaque when its current cumulative distance maps to an even element of the dash array and transparent otherwise.- Returns:
- the dash array.
-
getDashPhase
public float getDashPhase()
Returns the current dash phase. The dash phase is a distance specified in user coordinates that represents an offset into the dashing pattern. In other words, the dash phase defines the point in the dashing pattern that will correspond to the beginning of the stroke.- Returns:
- the dash phase as a
float
value.
-
hashCode
public int hashCode()
Returns the hashcode for this stroke.- Overrides:
hashCode
in classObject
- Returns:
- a hash code for this stroke.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
equals
public boolean equals(Object obj)
Tests if a specified object is equal to thisBasicStroke
by first testing if it is aBasicStroke
and then comparing its width, join, cap, miter limit, dash, and dash phase attributes with those of thisBasicStroke
.- Overrides:
equals
in classObject
- Parameters:
obj
- the specified object to compare to thisBasicStroke
- Returns:
true
if the width, join, cap, miter limit, dash, and dash phase are the same for both objects;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/awt/BasicStroke.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.