public class Stroke
- Object
- Stroke
Encapsulates the stroke used for drawing paths.
Fields
public static final int JOIN_MITER = 0 | Join style constant to join strokes MITER (i.e. pointy) Examples can be seen at here. |
public static final int JOIN_ROUND = 1 | Join style constant to join strokes rounded. |
public static final int JOIN_BEVEL = 2 | Join style constant to join strokes bevel. |
public static final int CAP_BUTT = 0 | Cap style constant to cap strokes with a butt (or flat). |
public static final int CAP_ROUND = 1 | Cap style constant to cap strokes with a round end. |
public static final int CAP_SQUARE = 2 | Cap style constant to cap strokes with a square end. |
Constructors
public Stroke(float lineWidth, int capStyle, int joinStyle, float miterLimit) | Creates a stroke with the specified characteristics. |
public Stroke() | Creates a stroke with default settings. |
Methods
public void setStroke(Stroke stroke) | Copies the properties of stroke into this stroke. |
public int getJoinStyle() | Returns the join style used for this stroke. |
public void setJoinStyle(int joinStyle) | Sets the join style of the stroke. |
public int getCapStyle() | Gets the cap style of the stroke. |
public void setCapStyle(int capStyle) | Gets the cap style of the stroke. |
public float getLineWidth() | Returns the line width of the stroke. |
public void setLineWidth(float lineWidth) | Sets the line width of the stroke. |
public float getMiterLimit() | Gets the miter limit of the stroke. |
public void setMiterLimit(float miterLimit) | Sets the miter limit of the stroke. |
public boolean equals(Object obj) | Indicates whether some other object is “equal to” this one. |
public String toString() | Returns a string representation of the object. |
public int hashCode() | Returns a hash code value for the object. |
Inherited methods
Field details
JOIN_MITER
public static final int JOIN_MITER = 0Join style constant to join strokes MITER (i.e. pointy)
Examples can be seen at here.
See also
JOIN_ROUND
public static final int JOIN_ROUND = 1Join style constant to join strokes rounded.
Examples can be seen here.
See also
JOIN_BEVEL
public static final int JOIN_BEVEL = 2Join style constant to join strokes bevel.
Examples can be seen here.
See also
CAP_BUTT
public static final int CAP_BUTT = 0Cap style constant to cap strokes with a butt (or flat).
Examples can be seen here.
See also
CAP_ROUND
public static final int CAP_ROUND = 1Cap style constant to cap strokes with a round end.
Examples can be seen here
See also
CAP_SQUARE
public static final int CAP_SQUARE = 2Cap style constant to cap strokes with a square end.
Examples can be seen here
See also
Constructor details
Stroke
public Stroke(float lineWidth, int capStyle, int joinStyle, float miterLimit)Creates a stroke with the specified characteristics.
Parameters
lineWidthfloat- The width of the stroke pixels.
capStyleint- The cap style of the stroke. Should be one of
#CAP_BUTT,#CAP_ROUND, or#CAP_SQUARE. joinStyleint- The join style of the strokes. Should be one of
#JOIN_MITER,#JOIN_ROUND, or#JOIN_BEVEL. miterLimitfloat- The Miter limit controls the point at which a Miter join automatically is converted to a Bevel join. If the distance from the inner intersection point to the tip of the triangle measured in stroke widths is more than the Miter limit, the join will be drawn in the Bevel style.
Stroke
public Stroke()Creates a stroke with default settings. Default settings are:
Join style#JOIN_MITER
Cap style#CAP_BUTT
Line Width1.0
Miter Limit4.0
Method details
setStroke
public void setStroke(Stroke stroke)Copies the properties of
stroke into this stroke.Parameters
strokeStroke- The stroke whose properties we wish to copy into the current stroke.
getJoinStyle
public int getJoinStyle()Returns the join style used for this stroke.
See visual examples of join styles here.
Returns
the joinStyle This will be one of
#JOIN_MITER,
#JOIN_ROUND, and #JOIN_BEVEL.setJoinStyle
public void setJoinStyle(int joinStyle)Sets the join style of the stroke.
See visual examples of join styles here.
Parameters
joinStyleint- the joinStyle to set. This should be one of
#JOIN_MITER,#JOIN_ROUND, and#JOIN_BEVEL.
getCapStyle
public int getCapStyle()Gets the cap style of the stroke.
See visual examples of cap styles here.
Returns
the capStyle. This will be one of
#CAP_BUTT, #CAP_ROUND, and #CAP_SQUARE.See also
setCapStyle
public void setCapStyle(int capStyle)Gets the cap style of the stroke.
See visual examples of cap styles here.
Parameters
capStyleint- the capStyle to set. This will be one of
#CAP_BUTT,#CAP_ROUND, and#CAP_SQUARE.
See also
getLineWidth
public float getLineWidth()Returns the line width of the stroke.
Returns
the lineWidth
setLineWidth
public void setLineWidth(float lineWidth)Sets the line width of the stroke.
Parameters
lineWidthfloat- the lineWidth to set
getMiterLimit
public float getMiterLimit()Gets the miter limit of the stroke. The Miter limit controls the point at which a Miter join automatically is converted to a Bevel join. If the distance from the inner intersection point to the tip of the triangle measured in stroke widths is more than the Miter limit, the join will be drawn in the Bevel style.
Returns
the miterLimit
setMiterLimit
public void setMiterLimit(float miterLimit)Sets the miter limit of the stroke. The Miter limit controls the point at which a Miter join automatically is converted to a Bevel join. If the distance from the inner intersection point to the tip of the triangle measured in stroke widths is more than the Miter limit, the join will be drawn in the Bevel style.
Parameters
miterLimitfloat- the miterLimit to set
equals
public boolean equals(Object obj)Indicates whether some other object is “equal to” this one.
The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false.
The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
toString
public String toString()Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + ‘@’ + Integer.toHexString(hashCode())
hashCode
public int hashCode()Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)