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
).
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.
Modifier and Type | Field and Description |
---|---|
protected NGShape.Mode |
impl_mode
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
BASELINE_OFFSET_SAME_AS_HEIGHT
Constructor and Description |
---|
Shape() |
Modifier and Type | Method and Description |
---|---|
ObjectProperty<Paint> |
fillProperty() |
static List<CssMetaData<? extends Styleable,?>> |
getClassCssMetaData() |
List<CssMetaData<? extends Styleable,?>> |
getCssMetaData()
This method should delegate to
Node.getClassCssMetaData() so that
a Node's CssMetaData can be accessed without the need for reflection. |
Paint |
getFill() |
Paint |
getStroke() |
ObservableList<Double> |
getStrokeDashArray()
Defines the array representing the lengths of the dash segments.
|
double |
getStrokeDashOffset() |
StrokeLineCap |
getStrokeLineCap() |
StrokeLineJoin |
getStrokeLineJoin() |
double |
getStrokeMiterLimit() |
StrokeType |
getStrokeType() |
double |
getStrokeWidth() |
protected boolean |
impl_computeContains(double localX,
double localY)
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
BaseBounds |
impl_computeGeomBounds(BaseBounds bounds,
BaseTransform tx)
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
abstract Shape |
impl_configShape()
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
protected NGNode |
impl_createPeer()
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
protected Paint |
impl_cssGetFillInitialValue()
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
protected Paint |
impl_cssGetStrokeInitialValue()
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
protected void |
impl_markDirty(DirtyBits dirtyBits)
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
Object |
impl_processMXNode(MXNodeAlgorithm alg,
MXNodeAlgorithmContext ctx)
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
void |
impl_setShapeChangeListener(Runnable listener)
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
void |
impl_updatePeer()
Deprecated.
This is an internal API that is not intended for use and will be removed in the next version
|
static Shape |
intersect(Shape shape1,
Shape shape2)
Returns a new
Shape which is created as an intersection of the
specified input shapes. |
boolean |
isSmooth() |
void |
setFill(Paint value) |
void |
setSmooth(boolean value) |
void |
setStroke(Paint value) |
void |
setStrokeDashOffset(double value) |
void |
setStrokeLineCap(StrokeLineCap value) |
void |
setStrokeLineJoin(StrokeLineJoin value) |
void |
setStrokeMiterLimit(double value) |
void |
setStrokeType(StrokeType value) |
void |
setStrokeWidth(double value) |
BooleanProperty |
smoothProperty() |
DoubleProperty |
strokeDashOffsetProperty()
Defines a distance specified in user coordinates that represents
an offset into the dashing pattern.
|
ObjectProperty<StrokeLineCap> |
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 . |
ObjectProperty<StrokeLineJoin> |
strokeLineJoinProperty()
Defines the decoration applied where path segments meet.
|
DoubleProperty |
strokeMiterLimitProperty()
Defines the limit for the
StrokeLineJoin.MITER line join style. |
ObjectProperty<Paint> |
strokeProperty() |
ObjectProperty<StrokeType> |
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. |
static Shape |
union(Shape shape1,
Shape shape2)
Returns a new
Shape which is created as a union of the specified
input shapes. |
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBaselineOffset, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_computeLayoutBounds, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_notifyLayoutBoundsChanged, impl_pickNode, impl_pickNodeLocal, impl_processCSS, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty
@Deprecated protected NGShape.Mode impl_mode
@Deprecated protected NGNode impl_createPeer()
impl_createPeer
in class Node
public final void setStrokeType(StrokeType value)
public final StrokeType getStrokeType()
public final ObjectProperty<StrokeType> strokeTypeProperty()
The image shows a shape without stroke and with a thick stroke applied inside, centered and outside.
StrokeType
public final void setStrokeWidth(double value)
public final double getStrokeWidth()
public final DoubleProperty strokeWidthProperty()
public final void setStrokeLineJoin(StrokeLineJoin value)
public final StrokeLineJoin getStrokeLineJoin()
public final ObjectProperty<StrokeLineJoin> strokeLineJoinProperty()
StrokeLineJoin.MITER
, StrokeLineJoin.BEVEL
,
and StrokeLineJoin.ROUND
. The image shows a shape
using the values in the mentioned order.
StrokeLineJoin
public final void setStrokeLineCap(StrokeLineCap value)
public final StrokeLineCap getStrokeLineCap()
public final ObjectProperty<StrokeLineCap> 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.
StrokeLineCap
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
.
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.
public final ObservableList<Double> 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
public final void setFill(Paint value)
public final Paint getFill()
public final ObjectProperty<Paint> fillProperty()
public final void setStroke(Paint value)
public final Paint getStroke()
public final ObjectProperty<Paint> strokeProperty()
public final void setSmooth(boolean value)
public final boolean isSmooth()
public final BooleanProperty smoothProperty()
@Deprecated protected Paint impl_cssGetFillInitialValue()
@Deprecated protected Paint impl_cssGetStrokeInitialValue()
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
Node.getClassCssMetaData()
so that
a Node's CssMetaData can be accessed without the need for reflection.getCssMetaData
in interface Styleable
getCssMetaData
in class Node
@Deprecated public BaseBounds impl_computeGeomBounds(BaseBounds bounds, BaseTransform tx)
Node
impl_computeGeomBounds
in class Node
@Deprecated protected boolean impl_computeContains(double localX, double localY)
impl_computeContains
in class Node
@Deprecated public abstract Shape impl_configShape()
@Deprecated protected void impl_markDirty(DirtyBits dirtyBits)
Node
impl_markDirty
in class Node
@Deprecated public void impl_setShapeChangeListener(Runnable listener)
@Deprecated public void impl_updatePeer()
Node
impl_updatePeer
in class Node
@Deprecated public Object impl_processMXNode(MXNodeAlgorithm alg, MXNodeAlgorithmContext ctx)
Node
impl_processMXNode
in class Node
alg
- current algorithm to process this nodectx
- current contextpublic 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
Copyright © 2020. All rights reserved.