JavaFX 24 · com.sun.javafx.sg.prism.NGGroup · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Blend.Mode	blendMode The blend mode to use with this group.
private List<NGNode>	children
private static final int	REGION_INTERSECTS_MASK This mask has all bits that mark that a region intersects this group.
private List<NGNode>	removed
private List<NGNode>	unmod
private final List<NGNode>	viewOrderChildren The viewOrderChildren is a list children sorted in decreasing viewOrder order if it is not empty.

Access	Constructor and Description
public	NGGroup()

Method Summary

Modifier and Type	Method and Description
public void	add(int -1, or <= node.size() index, NGNode node) Adds a node to the given index.
public void	addToRemoved(NGNode n)
public void	clear()
public void	clearDirty() Overrides com.sun.javafx.sg.prism.NGNode.clearDirty. Clears the dirty flag.
public void	clearFrom(int fromIndex)
protected NGNode.RenderRootResult	computeRenderRoot(NodePath the NodePath to populate with the path to the render root. Cannot be null. path, RectBounds the current dirty region. Cannot be null. dirtyRegion, int index of culling information cullingIndex, BaseTransform current transform. Cannot be null. tx, GeneralTransform3D current perspective transform. Cannot be null. pvTx) Overrides com.sun.javafx.sg.prism.NGNode.computeRenderRoot. * Culling Related Methods * *
public void	drawDirtyOpts(final BaseTransform The scene->parent transform. tx, final GeneralTransform3D The perspective camera transform. pvTx, Rectangle The bounds in scene coordinates clipBounds, int[] A pixel array where each pixel contains a color indicating how many times it has been "drawn" countBuffer, int the index of the dirty region we're gathering information for. This is needed so we can shift the "painted" field to find out if this node was drawn in this dirty region. dirtyRegionIndex) Overrides com.sun.javafx.sg.prism.NGNode.drawDirtyOpts. Helper method draws rectangles indicating the overdraw rectangles.
public List<NGNode>	getChildren() Gets an unmodifiable list of the current children on this group
private List<NGNode>	getOrderedChildren()
public List<NGNode>	getRemovedChildren()
protected boolean	hasOverlappingContents() Implements abstract com.sun.javafx.sg.prism.NGNode.hasOverlappingContents.
protected boolean	hasVisuals() Overrides com.sun.javafx.sg.prism.NGNode.hasVisuals. Marks if the node has some visuals and that the bounds change should be taken into account when using the dirty region.
public boolean	isEmpty()
protected void	markCullRegions(DirtyRegionContainer The array of dirty regions. drc, int culling bits of parent. -1 if there's no parent. cullingRegionsBitsOfParent, BaseTransform The transform for this render operation. Cannot be null. tx, GeneralTransform3D Perspective camera transform. Cannot be null. pvTx) Overrides com.sun.javafx.sg.prism.NGNode.markCullRegions. Marks placement of the node in dirty region encoded into 2 bit flag: 00 - node outside dirty region 01 - node intersecting dirty region 11 - node completely within dirty region 32 bits = 15 regions max.
protected boolean	needsBlending() Overrides com.sun.javafx.sg.prism.NGNode.needsBlending. Return true if this node has a blend mode that requires special processing.
public void	remove(NGNode node)
public void	remove(int index)
protected void	renderContent(Graphics g) Implements abstract com.sun.javafx.sg.prism.NGNode.renderContent.
public void	renderForcedContent(Graphics the Graphics object that was used to render the Scene, or null gOptional) Overrides com.sun.javafx.sg.prism.NGNode.renderForcedContent. Called on every render pulse for all nodes in case they have render-time operations that must be completed on a pulse, but were not otherwise rendered by the ordinary damage management logic.
public void	setBlendMode(Object cannot be null blendMode) Set by the FX scene graph.
public void	setViewOrderChildren(List<Node> sortedChildren)

Inherited from com.sun.javafx.sg.prism.NGNode:: accumulateDirtyRegions accumulateGroupDirtyRegion accumulateNodeDirtyRegion applyClip applyEffect applyTransform checkBoundsInQuad clearPainted computeNodeRenderRoot computeOpaqueRegion computePadding doPreCulling doRender effectChanged geometryChanged getCacheFilter getClipNode getClippedBounds getCompleteBounds getContentBounds getEffect getEffectBounds getEffectFilter getFilterContext getName getNodeBlendMode getOpacity getOpaqueRegion getParent getRenderRoot getTransform hasOpaqueRegion invalidateCache invalidateCacheByTranslation invalidateOpaqueRegion isClean isContentBounds2D isDepthTest isOpaqueRegionInvalid isReadbackSupported isRectClip isShape3D isVisible markDirty markTreeDirty markTreeDirtyNoIncrement printDirtyOpts release render renderClip renderEffect renderForClip setCachedAsBitmap setClipNode setContentBounds setDepthTest setEffect setName setNodeBlendMode setOpacity setParent setTransformedBounds setTransformMatrix setViewOrder setVisible supportsOpaqueRegions toString visualsChanged

blendMode	back to summary
private Blend.Mode blendMode The blend mode to use with this group.

children	back to summary
private List<NGNode> children

REGION_INTERSECTS_MASK	back to summary
private static final int REGION_INTERSECTS_MASK This mask has all bits that mark that a region intersects this group. Which means it looks like this: 00010101010101010101010101010101 (first bit for sign)

removed	back to summary
private List<NGNode> removed

unmod	back to summary
private List<NGNode> unmod

viewOrderChildren	back to summary
private final List<NGNode> viewOrderChildren The viewOrderChildren is a list children sorted in decreasing viewOrder order if it is not empty. Its size should always be equal to children.size(). If viewOrderChildren is empty it implies that the rendering order of the children is the same as the order in the children list.

NGGroup	back to summary
public NGGroup()

Method Detail

add	back to summary
public void add(int index, NGNode node) Adds a node to the given index. An index of -1 means "append", for legacy reasons (it was easier than asking for the number of children, iirc). Parameters index:int -1, or <= node.size()

add

back to summary

public void add(int index, NGNode node)

Adds a node to the given index. An index of -1 means "append", for legacy reasons (it was easier than asking for the number of children, iirc).

Parameters

index:int: -1, or <= node.size()

addToRemoved	back to summary
public void addToRemoved(NGNode n)

clear	back to summary
public void clear()

clearDirty	back to summary
public void clearDirty() Overrides com.sun.javafx.sg.prism.NGNode.clearDirty. Doc from com.sun.javafx.sg.prism.NGNode.clearDirty. Clears the dirty flag. This should only happen during rendering. Annotations @Override

clearDirty

back to summary

public void clearDirty()

Overrides com.sun.javafx.sg.prism.NGNode.clearDirty.

Doc from com.sun.javafx.sg.prism.NGNode.clearDirty.

Clears the dirty flag. This should only happen during rendering.

Annotations

@Override

clearFrom	back to summary
public void clearFrom(int fromIndex)

computeRenderRoot	back to summary
protected NGNode.RenderRootResult computeRenderRoot(NodePath path, RectBounds dirtyRegion, int cullingIndex, BaseTransform tx, GeneralTransform3D pvTx) Overrides com.sun.javafx.sg.prism.NGNode.computeRenderRoot. * Culling Related Methods * * Parameters path:NodePath Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. the NodePath to populate with the path to the render root. Cannot be null. dirtyRegion:RectBounds Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. the current dirty region. Cannot be null. cullingIndex:int Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. index of culling information tx:BaseTransform Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. current transform. Cannot be null. pvTx:GeneralTransform3D Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. current perspective transform. Cannot be null. Returns:NGNode.RenderRootResult Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot. The result of visiting this node. Annotations @Override

computeRenderRoot

back to summary

protected NGNode.RenderRootResult computeRenderRoot(NodePath path, RectBounds dirtyRegion, int cullingIndex, BaseTransform tx, GeneralTransform3D pvTx)

Overrides com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

* Culling Related Methods * *

Parameters

path:NodePath

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

the NodePath to populate with the path to the render root. Cannot be null.

dirtyRegion:RectBounds

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

the current dirty region. Cannot be null.

cullingIndex:int

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

index of culling information

tx:BaseTransform

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

current transform. Cannot be null.

pvTx:GeneralTransform3D

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

current perspective transform. Cannot be null.

Returns:NGNode.RenderRootResult

Doc from com.sun.javafx.sg.prism.NGNode.computeRenderRoot.

The result of visiting this node.

Annotations

@Override

drawDirtyOpts	back to summary
public void drawDirtyOpts(final BaseTransform tx, final GeneralTransform3D pvTx, Rectangle clipBounds, int[] countBuffer, int dirtyRegionIndex) Overrides com.sun.javafx.sg.prism.NGNode.drawDirtyOpts. Doc from com.sun.javafx.sg.prism.NGNode.drawDirtyOpts. Helper method draws rectangles indicating the overdraw rectangles. Parameters tx:BaseTransform The scene->parent transform. pvTx:GeneralTransform3D The perspective camera transform. clipBounds:Rectangle The bounds in scene coordinates countBuffer:int[] A pixel array where each pixel contains a color indicating how many times it has been "drawn" dirtyRegionIndex:int the index of the dirty region we're gathering information for. This is needed so we can shift the "painted" field to find out if this node was drawn in this dirty region. Annotations @Override

drawDirtyOpts

back to summary

public void drawDirtyOpts(final BaseTransform tx, final GeneralTransform3D pvTx, Rectangle clipBounds, int[] countBuffer, int dirtyRegionIndex)

Overrides com.sun.javafx.sg.prism.NGNode.drawDirtyOpts.

Doc from com.sun.javafx.sg.prism.NGNode.drawDirtyOpts.

Helper method draws rectangles indicating the overdraw rectangles.

Parameters

tx:BaseTransform: The scene->parent transform.
pvTx:GeneralTransform3D: The perspective camera transform.
clipBounds:Rectangle: The bounds in scene coordinates
countBuffer:int[]: A pixel array where each pixel contains a color indicating how many times it has been "drawn"
dirtyRegionIndex:int: the index of the dirty region we're gathering information for. This is needed so we can shift the "painted" field to find out if this node was drawn in this dirty region.

Annotations

@Override

getChildren	back to summary
public List<NGNode> getChildren() Gets an unmodifiable list of the current children on this group

getOrderedChildren	back to summary
private List<NGNode> getOrderedChildren()

getRemovedChildren	back to summary
public List<NGNode> getRemovedChildren()

hasOverlappingContents	back to summary
protected boolean hasOverlappingContents() Implements abstract com.sun.javafx.sg.prism.NGNode.hasOverlappingContents. Annotations @Override

hasOverlappingContents

back to summary

protected boolean hasOverlappingContents()

Implements abstract com.sun.javafx.sg.prism.NGNode.hasOverlappingContents.

Annotations

@Override

hasVisuals	back to summary
protected boolean hasVisuals() Overrides com.sun.javafx.sg.prism.NGNode.hasVisuals. Doc from com.sun.javafx.sg.prism.NGNode.hasVisuals. Marks if the node has some visuals and that the bounds change should be taken into account when using the dirty region. This will be false for NGGroup (but not for NGRegion) Returns:boolean true if the node has some visuals Annotations @Override

hasVisuals

back to summary

protected boolean hasVisuals()

Overrides com.sun.javafx.sg.prism.NGNode.hasVisuals.

Doc from com.sun.javafx.sg.prism.NGNode.hasVisuals.

Marks if the node has some visuals and that the bounds change should be taken into account when using the dirty region. This will be false for NGGroup (but not for NGRegion)

Returns:boolean

true if the node has some visuals

Annotations

@Override

isEmpty	back to summary
public boolean isEmpty()

markCullRegions	back to summary
protected void markCullRegions(DirtyRegionContainer drc, int cullingRegionsBitsOfParent, BaseTransform tx, GeneralTransform3D pvTx) Overrides com.sun.javafx.sg.prism.NGNode.markCullRegions. Doc from com.sun.javafx.sg.prism.NGNode.markCullRegions. Marks placement of the node in dirty region encoded into 2 bit flag: 00 - node outside dirty region 01 - node intersecting dirty region 11 - node completely within dirty region 32 bits = 15 regions max. * 2 bit each. The first two bits are not used because we have a special use case for -1, so they should only be set if in that case. Parameters drc:DirtyRegionContainer The array of dirty regions. cullingRegionsBitsOfParent:int culling bits of parent. -1 if there's no parent. tx:BaseTransform The transform for this render operation. Cannot be null. pvTx:GeneralTransform3D Perspective camera transform. Cannot be null. Annotations @Override

markCullRegions

back to summary

protected void markCullRegions(DirtyRegionContainer drc, int cullingRegionsBitsOfParent, BaseTransform tx, GeneralTransform3D pvTx)

Overrides com.sun.javafx.sg.prism.NGNode.markCullRegions.

Doc from com.sun.javafx.sg.prism.NGNode.markCullRegions.

Marks placement of the node in dirty region encoded into 2 bit flag: 00 - node outside dirty region 01 - node intersecting dirty region 11 - node completely within dirty region 32 bits = 15 regions max. * 2 bit each. The first two bits are not used because we have a special use case for -1, so they should only be set if in that case.

Parameters

drc:DirtyRegionContainer: The array of dirty regions.
cullingRegionsBitsOfParent:int: culling bits of parent. -1 if there's no parent.
tx:BaseTransform: The transform for this render operation. Cannot be null.
pvTx:GeneralTransform3D: Perspective camera transform. Cannot be null.

Annotations

@Override

needsBlending	back to summary
protected boolean needsBlending() Overrides com.sun.javafx.sg.prism.NGNode.needsBlending. Doc from com.sun.javafx.sg.prism.NGNode.needsBlending. Return true if this node has a blend mode that requires special processing. Regular nodes can handle null or SRC_OVER just by rendering into the existing buffer. Groups override this since they must collect their children into a single rendering pass if their mode is explicitly SRC_OVER. Returns:boolean true if this node needs special blending support Annotations @Override

needsBlending

back to summary

protected boolean needsBlending()

Overrides com.sun.javafx.sg.prism.NGNode.needsBlending.

Doc from com.sun.javafx.sg.prism.NGNode.needsBlending.

Return true if this node has a blend mode that requires special processing. Regular nodes can handle null or SRC_OVER just by rendering into the existing buffer. Groups override this since they must collect their children into a single rendering pass if their mode is explicitly SRC_OVER.

Returns:boolean

true if this node needs special blending support

Annotations

@Override

remove	back to summary
public void remove(NGNode node)

remove	back to summary
public void remove(int index)

renderContent	back to summary
protected void renderContent(Graphics g) Implements abstract com.sun.javafx.sg.prism.NGNode.renderContent. Annotations @Override

renderContent

back to summary

protected void renderContent(Graphics g)

Implements abstract com.sun.javafx.sg.prism.NGNode.renderContent.

Annotations

@Override

renderForcedContent	back to summary
public void renderForcedContent(Graphics gOptional) Overrides com.sun.javafx.sg.prism.NGNode.renderForcedContent. Doc from com.sun.javafx.sg.prism.NGNode.renderForcedContent. Called on every render pulse for all nodes in case they have render-time operations that must be completed on a pulse, but were not otherwise rendered by the ordinary damage management logic. The graphics argument will be the graphics that was used to render the scene if it is available, but may be null for cases when the scene required no visible updates and thus no back buffer graphics was actually obtained. Implementors must have a backup plan for that case when the Graphics object is null. Parameters gOptional:Graphics the Graphics object that was used to render the Scene, or null Annotations @Override

renderForcedContent

back to summary

public void renderForcedContent(Graphics gOptional)

Overrides com.sun.javafx.sg.prism.NGNode.renderForcedContent.

Doc from com.sun.javafx.sg.prism.NGNode.renderForcedContent.

Called on every render pulse for all nodes in case they have render-time operations that must be completed on a pulse, but were not otherwise rendered by the ordinary damage management logic. The graphics argument will be the graphics that was used to render the scene if it is available, but may be null for cases when the scene required no visible updates and thus no back buffer graphics was actually obtained. Implementors must have a backup plan for that case when the Graphics object is null.

Parameters

gOptional:Graphics: the Graphics object that was used to render the Scene, or null

Annotations

@Override

setBlendMode	back to summary
public void setBlendMode(Object blendMode) Set by the FX scene graph. Parameters blendMode:Object cannot be null

setBlendMode

back to summary

public void setBlendMode(Object blendMode)

Set by the FX scene graph.

Parameters

blendMode:Object: cannot be null

setViewOrderChildren	back to summary
public void setViewOrderChildren(List<Node> sortedChildren)

public Class NGGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail