Difference between revisions of "Scene graph node list"

From Developer Documents
Jump to navigation Jump to search
Line 109: Line 109:
 
|LR
 
|LR
 
|A node that delegates #render(Graphics2D) and #getBoundsInLocal() invocations to another node in the same scene graph. The delegate node is identified using a String ID that refers to the node through the scene graph [[Org.simantics.scenegraph#Node_.E2.87.94_ID_mapping|lookup service]].  
 
|A node that delegates #render(Graphics2D) and #getBoundsInLocal() invocations to another node in the same scene graph. The delegate node is identified using a String ID that refers to the node through the scene graph [[Org.simantics.scenegraph#Node_.E2.87.94_ID_mapping|lookup service]].  
 +
|-
 +
|LocalDelegateNode
 +
|L
 +
|A node that delegates #render(Graphics2D) and #getBoundsInLocal() invocations to another node in the same scene graph. The delegate node is directly the delegation target 2D node object.
 +
|- style="background-color: tomato;"
 +
|MessageNotificationNode
 +
|LR
 +
|A node for rendering simple messages on the. See Notifications org.simantics.g2d.participant.Notifications for more info.
 +
|- style="background-color: tomato;"
 +
|NavigationNode
 +
|LR
 +
|A node for adding support for mouse-based camera navigation for a canvas.
 +
|- style="background-color: tomato;"
 +
|PageBorderNode
 +
|LR
 +
|Renders page borders and margins.
 +
|- style="background-color: tomato;"
 +
|RelationshipNode, RelationshipNode2
 +
|LR
 +
|Renders "animated" straight lines between two canvas locations. Used by <em>ShowRelatedElements</em> diagram profile style.
 +
|- style="background-color: tomato;"
 +
|RulerNode
 +
|LR
 +
|Renders (transparent) horizontal and vertical rulers on the left and top sides of the canvas control area.
 +
|- style="background-color: tomato;"
 +
|SelectionNode
 +
|LR
 +
|Renders a simple visual cue (dashed rectangle) used to emphasize a selected element on the canvas.
 +
|- style="background-color: tomato;"
 +
|SelectionPivotNode
 +
|LR
 +
|Do not use.
 +
|- style="background-color: greenyellow;"
 +
|ShapeNode
 +
|LR
 +
|Renders an arbitrary shape with the specified fills, strokes and paints.
 +
|- style="background-color: greenyellow;"
 +
|SingleElementNode
 +
|R
 +
|A parent node for diagram elements.
 +
|- style="background-color: tomato;"
 +
|StateMaskNode
 +
|LR
 +
|Internal. Not for general use.
 +
|-
 +
|SVGHolderNode
 +
|LR
 +
|A node for visualizing an SVG image so that it is scaled to stay within the specified bounds.
 +
|- style="background-color: greenyellow;"
 +
|SVGNode
 +
|LR
 +
|A node that renders an SVG image.
 +
|- style="background-color: tomato;"
 +
|TextNode
 +
|LR
 +
|A really simple node that renders a text.
 +
|- style="background-color: tomato;"
 +
|TransformableSelectionNode
 +
|R
 +
|A decorator for any node for resizing and moving its child nodes around. Renders grabbing widgets on top of its children.
 
|}
 
|}
  

Revision as of 14:43, 13 October 2011

2D Nodes

org.simantics.scenegraph.g2d

Class Description
IG2DNode Interface implemented by all 2D scene graph nodes.
G2DNode Base class for all 2D rendering leaf nodes.
G2DParentNode Base class for all 2D rendering nodes that may have children.
G2DSceneGraph 2D scene graph root node.

For the code, see org.simantics.scenegraph.g2d.

Node traits

Character Meaning
L Leaf node
R Works with remote rendering

org.simantics.scenegraph.g2d.nodes

Class Traits Description
AnimatedSVGNode LR Do not use.
BackgroundNode LR Paints current clipping bounds or specified rectangle with the specified color/paint.
BooleanToggleValueNode LR A simple statically sized/styled push-button widget that can be pressed on off. Nofitications of changes are deployed through an ActionListener.
BorderDecoratorNode R A decorator node optionally rendering a rectangular box before rendering its children.
BoundsNode LR Internal system support structure. Do not use.
BoxSelectionNode LR Used for visualizing a box selection operation. Box selection ends when the specified mouse button is released. At this time the node will notify its SelectionListener if one has been set with the coordinates of the selection box and the active keyboard modifiers at that time.
BranchPointNode LR Part of the old generation of diagram connections. Do not use.
ClippingNode R A parent node which sets a new rendering clipping shape.
ConnectionNode R A parent node for containing diagram connections. Provides additional support for dynamic coloring/stroking. Do not use.
DataNode R A non-rendering parent node for containing data-oriented nodes that are used for scene-graph-locally describing useful data within the scene graph. One such node with lookup ID "data" is generally available.
EdgeNode LR Part of old generation connections. Do not use.
FlagNode LR Renders a "flag" that is used for describing in- and interdiagram navigation links. Defined by the following aspects: shape, lines of text, text bounds, color, stroke, font, horizontal/vertical alignment.
GalleryItemNode R A parent node for decorating a set of child nodes with a label text rendered below the child nodes. Used by the symbol library UI component.
GridNode LR Renders a grid using the specified grid spacing. It adjusts the rendered spacing based on the current view transformation so that visible grid is always sparse enough to be meaningful to the user.
ImageNode R A node which renders any image readable by javax.imageio.ImageIO. The image is fed to it as a byte array (byte[]).
InstancingShapeNode extends ShapeNode LR Just like ShapeNode but renders the same shape as many times as specified by a set of transformations and paints.
LinkNode LR A node that delegates #render(Graphics2D) and #getBoundsInLocal() invocations to another node in the same scene graph. The delegate node is identified using a String ID that refers to the node through the scene graph lookup service.
LocalDelegateNode L A node that delegates #render(Graphics2D) and #getBoundsInLocal() invocations to another node in the same scene graph. The delegate node is directly the delegation target 2D node object.
MessageNotificationNode LR A node for rendering simple messages on the. See Notifications org.simantics.g2d.participant.Notifications for more info.
NavigationNode LR A node for adding support for mouse-based camera navigation for a canvas.
PageBorderNode LR Renders page borders and margins.
RelationshipNode, RelationshipNode2 LR Renders "animated" straight lines between two canvas locations. Used by ShowRelatedElements diagram profile style.
RulerNode LR Renders (transparent) horizontal and vertical rulers on the left and top sides of the canvas control area.
SelectionNode LR Renders a simple visual cue (dashed rectangle) used to emphasize a selected element on the canvas.
SelectionPivotNode LR Do not use.
ShapeNode LR Renders an arbitrary shape with the specified fills, strokes and paints.
SingleElementNode R A parent node for diagram elements.
StateMaskNode LR Internal. Not for general use.
SVGHolderNode LR A node for visualizing an SVG image so that it is scaled to stay within the specified bounds.
SVGNode LR A node that renders an SVG image.
TextNode LR A really simple node that renders a text.
TransformableSelectionNode R A decorator for any node for resizing and moving its child nodes around. Renders grabbing widgets on top of its children.

For the code, see org.simantics.scenegraph.g2d.nodes.

org.simantics.diagram.elements

Class Description
TextNode A text widget node for the diagram. Supports: in-line editing, background/foreground color, standard font settings, horizontal alignment. Does not (yet) support: multi-line text, vertical alignment.
TextGridNode A 2D parent node holding a NxM grid of TextNode nodes as its children.

For the code, see org.simantics.diagram.elements.