public abstract class Shape
extends Node
Shape
class provides definitions of common properties for
objects that represent some form of geometric shape. These properties
include:
Paint
to be applied to the fillable interior of the
shape (see setFill
).
Paint
to be applied to stroke the outline of the
shape (see setStroke
).
StrokeType
).
An application should not extend the Shape class directly. Doing so may lead to an UnsupportedOperationException being thrown.
On the other hand, stroking those same shapes can often lead to fuzzy outlines because the default stroking attributes specify both that the default stroke width is 1.0 coordinates which often maps to exactly 1 device pixel and also that the stroke should straddle the border of the shape, falling half on either side of the border. Since the borders in many common shapes tend to fall directly on integer coordinates and those integer coordinates often map precisely to integer device locations, the borders tend to result in 50% coverage over the pixel rows and columns on either side of the border of the shape rather than 100% coverage on one or the other. Thus, fills may typically be crisp, but strokes are often fuzzy.
Two common solutions to avoid these fuzzy outlines are to use wider
strokes that cover more pixels completely - typically a stroke width of
2.0 will achieve this if there are no scale transforms in effect - or
to specify either the StrokeType.INSIDE
or StrokeType.OUTSIDE
stroke styles - which will bias the default single unit stroke onto one
of the full pixel rows or columns just inside or outside the border of
the shape.
Type | Property and Description |
---|---|
<any> |
fill
Defines parameters to fill the interior of an
Shape
using the settings of the Paint context. |
BooleanProperty |
smooth
Defines whether antialiasing hints are used or not for this
Shape . |
DoubleProperty |
strokeDashOffset
Defines a distance specified in user coordinates that represents
an offset into the dashing pattern.
|
<any> |
strokeLineCap
The end cap style of this
Shape as one of the following
values that define possible end cap styles:
StrokeLineCap.BUTT , StrokeLineCap.ROUND ,
and StrokeLineCap.SQUARE . |
<any> |
strokeLineJoin
Defines the decoration applied where path segments meet.
|
DoubleProperty |
strokeMiterLimit
Defines the limit for the
StrokeLineJoin.MITER line join style. |
<any> |
stroke
Defines parameters of a stroke that is drawn around the outline of
a
Shape using the settings of the specified Paint . |
<any> |
strokeType
Defines the direction (inside, centered, or outside) that the strokeWidth
is applied to the boundary of the shape.
|
DoubleProperty |
strokeWidth
Defines a square pen line width.
|
Modifier and Type | Class and Description |
---|---|
private class |
Shape.StrokeAttributes |
private static class |
Shape.StyleableProperties |
Modifier and Type | Field and Description |
---|---|
private static float[] |
DEFAULT_PG_STROKE_DASH_ARRAY |
private static double |
DEFAULT_STROKE_DASH_OFFSET |
private static StrokeLineCap |
DEFAULT_STROKE_LINE_CAP |
private static StrokeLineJoin |
DEFAULT_STROKE_LINE_JOIN |
private static double |
DEFAULT_STROKE_MITER_LIMIT |
private static StrokeType |
DEFAULT_STROKE_TYPE |
private static double |
DEFAULT_STROKE_WIDTH |
private <any> |
fill
Defines parameters to fill the interior of an
Shape
using the settings of the Paint context. |
private static double |
MIN_STROKE_MITER_LIMIT |
private static double |
MIN_STROKE_WIDTH |
private NGShape.Mode |
mode |
(package private) Paint |
old_fill |
(package private) Paint |
old_stroke |
private AbstractNotifyListener |
platformImageChangeListener |
private java.lang.ref.Reference<java.lang.Runnable> |
shapeChangeListener |
private BooleanProperty |
smooth
Defines whether antialiasing hints are used or not for this
Shape . |
private <any> |
stroke
Defines parameters of a stroke that is drawn around the outline of
a
Shape using the settings of the specified Paint . |
private Shape.StrokeAttributes |
strokeAttributes |
private boolean |
strokeAttributesDirty |
Constructor and Description |
---|
Shape()
Creates an empty instance of Shape.
|
Modifier and Type | Method and Description |
---|---|
private static BaseTransform |
calculateNodeToSceneTransform(Node node) |
private void |
checkModeChanged() |
(package private) BaseBounds |
computeBounds(BaseBounds bounds,
BaseTransform tx,
double upad,
double dpad,
double x,
double y,
double w,
double h)
Helper function for rectangular shapes such as Rectangle and Ellipse
for computing their bounds.
|
private NGShape.Mode |
computeMode() |
(package private) BaseBounds |
computeShapeBounds(BaseBounds bounds,
BaseTransform tx,
com.sun.javafx.geom.Shape s) |
(package private) boolean |
computeShapeContains(double localX,
double localY,
com.sun.javafx.geom.Shape s) |
(package private) StrokeLineJoin |
convertLineJoin(StrokeLineJoin t) |
private static Path |
createFromGeomShape(com.sun.javafx.geom.Shape geomShape) |
private static Area |
createTransformedArea(com.sun.javafx.geom.Shape geomShape,
BaseTransform transform) |
private boolean |
doComputeContains(double localX,
double localY) |
private BaseBounds |
doComputeGeomBounds(BaseBounds bounds,
BaseTransform tx) |
private Paint |
doCssGetFillInitialValue()
*
Stylesheet Handling *
*
|
private Paint |
doCssGetStrokeInitialValue() |
private void |
doMarkDirty(DirtyBits dirtyBits) |
private void |
doUpdatePeer() |
<any> |
fillProperty()
Defines parameters to fill the interior of an
Shape
using the settings of the Paint context. |
static java.util.List<<any>> |
getClassCssMetaData() |
java.util.List<<any>> |
getCssMetaData() |
Paint |
getFill()
Gets the value of the property fill.
|
(package private) NGShape.Mode |
getMode() |
Paint |
getStroke()
Gets the value of the property stroke.
|
private Shape.StrokeAttributes |
getStrokeAttributes() |
<any> |
getStrokeDashArray()
Defines the array representing the lengths of the dash segments.
|
double |
getStrokeDashOffset()
Gets the value of the property strokeDashOffset.
|
StrokeLineCap |
getStrokeLineCap()
Gets the value of the property strokeLineCap.
|
StrokeLineJoin |
getStrokeLineJoin()
Gets the value of the property strokeLineJoin.
|
double |
getStrokeMiterLimit()
Gets the value of the property strokeMiterLimit.
|
StrokeType |
getStrokeType()
Gets the value of the property strokeType.
|
double |
getStrokeWidth()
Gets the value of the property strokeWidth.
|
private Area |
getTransformedArea() |
private Area |
getTransformedArea(BaseTransform transform) |
private boolean |
hasStrokeDashArray() |
static Shape |
intersect(Shape shape1,
Shape shape2)
Returns a new
Shape which is created as an intersection of the
specified input shapes. |
boolean |
isSmooth()
Gets the value of the property smooth.
|
void |
setFill(Paint value)
Sets the value of the property fill.
|
(package private) void |
setMode(NGShape.Mode mode) |
(package private) void |
setShapeChangeListener(java.lang.Runnable listener) |
void |
setSmooth(boolean value)
Sets the value of the property smooth.
|
void |
setStroke(Paint value)
Sets the value of the property stroke.
|
void |
setStrokeDashOffset(double value)
Sets the value of the property strokeDashOffset.
|
void |
setStrokeLineCap(StrokeLineCap value)
Sets the value of the property strokeLineCap.
|
void |
setStrokeLineJoin(StrokeLineJoin value)
Sets the value of the property strokeLineJoin.
|
void |
setStrokeMiterLimit(double value)
Sets the value of the property strokeMiterLimit.
|
void |
setStrokeType(StrokeType value)
Sets the value of the property strokeType.
|
void |
setStrokeWidth(double value)
Sets the value of the property strokeWidth.
|
BooleanProperty |
smoothProperty()
Defines whether antialiasing hints are used or not for this
Shape . |
DoubleProperty |
strokeDashOffsetProperty()
Defines a distance specified in user coordinates that represents
an offset into the dashing pattern.
|
<any> |
strokeLineCapProperty()
The end cap style of this
Shape as one of the following
values that define possible end cap styles:
StrokeLineCap.BUTT , StrokeLineCap.ROUND ,
and StrokeLineCap.SQUARE . |
<any> |
strokeLineJoinProperty()
Defines the decoration applied where path segments meet.
|
DoubleProperty |
strokeMiterLimitProperty()
Defines the limit for the
StrokeLineJoin.MITER line join style. |
<any> |
strokeProperty()
Defines parameters of a stroke that is drawn around the outline of
a
Shape using the settings of the specified Paint . |
<any> |
strokeTypeProperty()
Defines the direction (inside, centered, or outside) that the strokeWidth
is applied to the boundary of the shape.
|
DoubleProperty |
strokeWidthProperty()
Defines a square pen line width.
|
static Shape |
subtract(Shape shape1,
Shape shape2)
Returns a new
Shape which is created by subtracting the specified
second shape from the first shape. |
private static float[] |
toPGDashArray(java.util.List<java.lang.Double> dashArray) |
static Shape |
union(Shape shape1,
Shape shape2)
Returns a new
Shape which is created as a union of the specified
input shapes. |
private void |
updatePGShape() |
public final <any> strokeTypeProperty
The image shows a shape without stroke and with a thick stroke applied inside, centered and outside.
getStrokeType()
,
setStrokeType(StrokeType)
public final DoubleProperty strokeWidthProperty
getStrokeWidth()
,
setStrokeWidth(double)
public final <any> strokeLineJoinProperty
StrokeLineJoin.MITER
, StrokeLineJoin.BEVEL
,
and StrokeLineJoin.ROUND
. The image shows a shape
using the values in the mentioned order.
public final <any> strokeLineCapProperty
Shape
as one of the following
values that define possible end cap styles:
StrokeLineCap.BUTT
, StrokeLineCap.ROUND
,
and StrokeLineCap.SQUARE
. The image shows a line
using the values in the mentioned order.
public final DoubleProperty strokeMiterLimitProperty
StrokeLineJoin.MITER
line join style.
A value of less than 1.0 will be treated as 1.0.
The image demonstrates the behavior. Miter length (A
) is computed
as the distance of the most inside point to the most outside point of
the joint, with the stroke width as a unit. If the miter length is bigger
than the given miter limit, the miter is cut at the edge of the shape
(B
). For the situation in the image it means that the miter
will be cut at B
for limit values less than 4.65
.
getStrokeMiterLimit()
,
setStrokeMiterLimit(double)
public final DoubleProperty strokeDashOffsetProperty
The image shows a stroke with dash array [25, 20, 5, 20]
and
a stroke with the same pattern and offset 45
which shifts
the pattern about the length of the first dash segment and
the following space.
getStrokeDashOffset()
,
setStrokeDashOffset(double)
public final <any> fillProperty
Shape
using the settings of the Paint
context.
The default value is Color.BLACK
for all shapes except
Line, Polyline, and Path. The default value is null
for
those shapes.getFill()
,
setFill(Paint)
public final <any> strokeProperty
Shape
using the settings of the specified Paint
.
The default value is null
for all shapes except
Line, Polyline, and Path. The default value is Color.BLACK
for
those shapes.getStroke()
,
setStroke(Paint)
public final BooleanProperty smoothProperty
Shape
.
If the value equals true the rendering hints are applied.isSmooth()
,
setSmooth(boolean)
private NGShape.Mode mode
private <any> fill
Shape
using the settings of the Paint
context.
The default value is Color.BLACK
for all shapes except
Line, Polyline, and Path. The default value is null
for
those shapes.Paint old_fill
private <any> stroke
Shape
using the settings of the specified Paint
.
The default value is null
for all shapes except
Line, Polyline, and Path. The default value is Color.BLACK
for
those shapes.private final AbstractNotifyListener platformImageChangeListener
Paint old_stroke
private BooleanProperty smooth
Shape
.
If the value equals true the rendering hints are applied.private static final double MIN_STROKE_WIDTH
private static final double MIN_STROKE_MITER_LIMIT
private java.lang.ref.Reference<java.lang.Runnable> shapeChangeListener
private boolean strokeAttributesDirty
private Shape.StrokeAttributes strokeAttributes
private static final StrokeType DEFAULT_STROKE_TYPE
private static final double DEFAULT_STROKE_WIDTH
private static final StrokeLineJoin DEFAULT_STROKE_LINE_JOIN
private static final StrokeLineCap DEFAULT_STROKE_LINE_CAP
private static final double DEFAULT_STROKE_MITER_LIMIT
private static final double DEFAULT_STROKE_DASH_OFFSET
private static final float[] DEFAULT_PG_STROKE_DASH_ARRAY
StrokeLineJoin convertLineJoin(StrokeLineJoin t)
public final void setStrokeType(StrokeType value)
public final StrokeType getStrokeType()
public final <any> strokeTypeProperty()
The image shows a shape without stroke and with a thick stroke applied inside, centered and outside.
getStrokeType()
,
setStrokeType(StrokeType)
public final void setStrokeWidth(double value)
public final double getStrokeWidth()
public final DoubleProperty strokeWidthProperty()
getStrokeWidth()
,
setStrokeWidth(double)
public final void setStrokeLineJoin(StrokeLineJoin value)
public final StrokeLineJoin getStrokeLineJoin()
public final <any> strokeLineJoinProperty()
StrokeLineJoin.MITER
, StrokeLineJoin.BEVEL
,
and StrokeLineJoin.ROUND
. The image shows a shape
using the values in the mentioned order.
public final void setStrokeLineCap(StrokeLineCap value)
public final StrokeLineCap getStrokeLineCap()
public final <any> strokeLineCapProperty()
Shape
as one of the following
values that define possible end cap styles:
StrokeLineCap.BUTT
, StrokeLineCap.ROUND
,
and StrokeLineCap.SQUARE
. The image shows a line
using the values in the mentioned order.
public final void setStrokeMiterLimit(double value)
public final double getStrokeMiterLimit()
public final DoubleProperty strokeMiterLimitProperty()
StrokeLineJoin.MITER
line join style.
A value of less than 1.0 will be treated as 1.0.
The image demonstrates the behavior. Miter length (A
) is computed
as the distance of the most inside point to the most outside point of
the joint, with the stroke width as a unit. If the miter length is bigger
than the given miter limit, the miter is cut at the edge of the shape
(B
). For the situation in the image it means that the miter
will be cut at B
for limit values less than 4.65
.
getStrokeMiterLimit()
,
setStrokeMiterLimit(double)
public final void setStrokeDashOffset(double value)
public final double getStrokeDashOffset()
public final DoubleProperty strokeDashOffsetProperty()
The image shows a stroke with dash array [25, 20, 5, 20]
and
a stroke with the same pattern and offset 45
which shifts
the pattern about the length of the first dash segment and
the following space.
getStrokeDashOffset()
,
setStrokeDashOffset(double)
public final <any> getStrokeDashArray()
Shape
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 (counting from 0
) and
transparent otherwise.
An empty strokeDashArray indicates a solid line with no spaces.
An odd length strokeDashArray behaves the same as an even length
array constructed by implicitly repeating the indicated odd length
array twice in succession ([20, 5, 15]
behaves as if it
were [20, 5, 15, 20, 5, 15]
).
Note that each dash segment will be capped by the decoration specified by the current stroke line cap.
The image shows a shape with stroke dash array [25, 20, 5, 20]
and 3 different values for the stroke line cap:
StrokeLineCap.BUTT
, StrokeLineCap.SQUARE
(the default),
and StrokeLineCap.ROUND
private NGShape.Mode computeMode()
NGShape.Mode getMode()
void setMode(NGShape.Mode mode)
private void checkModeChanged()
public final void setFill(Paint value)
public final Paint getFill()
public final <any> fillProperty()
Shape
using the settings of the Paint
context.
The default value is Color.BLACK
for all shapes except
Line, Polyline, and Path. The default value is null
for
those shapes.getFill()
,
setFill(Paint)
public final void setStroke(Paint value)
public final Paint getStroke()
public final <any> strokeProperty()
Shape
using the settings of the specified Paint
.
The default value is null
for all shapes except
Line, Polyline, and Path. The default value is Color.BLACK
for
those shapes.getStroke()
,
setStroke(Paint)
public final void setSmooth(boolean value)
public final boolean isSmooth()
public final BooleanProperty smoothProperty()
Shape
.
If the value equals true the rendering hints are applied.isSmooth()
,
setSmooth(boolean)
private Paint doCssGetFillInitialValue()
private Paint doCssGetStrokeInitialValue()
public static java.util.List<<any>> getClassCssMetaData()
public java.util.List<<any>> getCssMetaData()
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private boolean doComputeContains(double localX, double localY)
private void updatePGShape()
private void doMarkDirty(DirtyBits dirtyBits)
void setShapeChangeListener(java.lang.Runnable listener)
private void doUpdatePeer()
BaseBounds computeBounds(BaseBounds bounds, BaseTransform tx, double upad, double dpad, double x, double y, double w, double h)
BaseBounds computeShapeBounds(BaseBounds bounds, BaseTransform tx, com.sun.javafx.geom.Shape s)
boolean computeShapeContains(double localX, double localY, com.sun.javafx.geom.Shape s)
private Shape.StrokeAttributes getStrokeAttributes()
private boolean hasStrokeDashArray()
private static float[] toPGDashArray(java.util.List<java.lang.Double> dashArray)
public static Shape union(Shape shape1, Shape shape2)
Shape
which is created as a union of the specified
input shapes.
The operation works with geometric areas occupied by the input shapes.
For a single Shape
such area includes the area occupied by the
fill if the shape has a non-null fill and the area occupied by the stroke
if the shape has a non-null stroke. So the area is empty for a shape
with null
stroke and null
fill. The area of an input
shape considered by the operation is independent on the type and
configuration of the paint used for fill or stroke. Before the final
operation the areas of the input shapes are transformed to the parent
coordinate space of their respective topmost parent nodes.
The resulting shape will include areas that were contained in any of the input shapes.
shape1 + shape2 = result +----------------+ +----------------+ +----------------+ |################| |################| |################| |############## | | ##############| |################| |############ | | ############| |################| |########## | | ##########| |################| |######## | | ########| |################| |###### | | ######| |###### ######| |#### | | ####| |#### ####| |## | | ##| |## ##| +----------------+ +----------------+ +----------------+
shape1
- the first shapeshape2
- the second shapeShape
public static Shape subtract(Shape shape1, Shape shape2)
Shape
which is created by subtracting the specified
second shape from the first shape.
The operation works with geometric areas occupied by the input shapes.
For a single Shape
such area includes the area occupied by the
fill if the shape has a non-null fill and the area occupied by the stroke
if the shape has a non-null stroke. So the area is empty for a shape
with null
stroke and null
fill. The area of an input
shape considered by the operation is independent on the type and
configuration of the paint used for fill or stroke. Before the final
operation the areas of the input shapes are transformed to the parent
coordinate space of their respective topmost parent nodes.
The resulting shape will include areas that were contained only in the first shape and not in the second shape.
shape1 - shape2 = result +----------------+ +----------------+ +----------------+ |################| |################| | | |############## | | ##############| |## | |############ | | ############| |#### | |########## | | ##########| |###### | |######## | | ########| |######## | |###### | | ######| |###### | |#### | | ####| |#### | |## | | ##| |## | +----------------+ +----------------+ +----------------+
shape1
- the first shapeshape2
- the second shapeShape
public static Shape intersect(Shape shape1, Shape shape2)
Shape
which is created as an intersection of the
specified input shapes.
The operation works with geometric areas occupied by the input shapes.
For a single Shape
such area includes the area occupied by the
fill if the shape has a non-null fill and the area occupied by the stroke
if the shape has a non-null stroke. So the area is empty for a shape
with null
stroke and null
fill. The area of an input
shape considered by the operation is independent on the type and
configuration of the paint used for fill or stroke. Before the final
operation the areas of the input shapes are transformed to the parent
coordinate space of their respective topmost parent nodes.
The resulting shape will include only areas that were contained in both of the input shapes.
shape1 + shape2 = result +----------------+ +----------------+ +----------------+ |################| |################| |################| |############## | | ##############| | ############ | |############ | | ############| | ######## | |########## | | ##########| | #### | |######## | | ########| | | |###### | | ######| | | |#### | | ####| | | |## | | ##| | | +----------------+ +----------------+ +----------------+
shape1
- the first shapeshape2
- the second shapeShape
private Area getTransformedArea()
private Area getTransformedArea(BaseTransform transform)
private static BaseTransform calculateNodeToSceneTransform(Node node)
private static Area createTransformedArea(com.sun.javafx.geom.Shape geomShape, BaseTransform transform)
private static Path createFromGeomShape(com.sun.javafx.geom.Shape geomShape)