Home > Articles > Programming > Java

Creating Java User Interfaces with Project Scene Graph

Jeff Friesen introduces Project Scene Graph, which provides the graphical runtime for the JavaFX Script language. He explores this technology's support for nodes, animation, and visual effects; and provides several Java applications that leverage this support to create visually compelling and dynamic user interfaces.
Like this article? We recommend

At the May 2007 JavaOne Conference, Sun Microsystems announced its Java-based JavaFX technology for developing rich internet applications (RIAs)—Web applications that typically use Web services for the backend, and provide browser-based, front-end interactivity similar to that offered by traditional desktop applications. JavaFX is itself dependent on another Sun technology: Project Scene Graph.

Project Scene Graph, which is also known as Scenario, amounts to a set of Java classes that provides the graphical runtime for the JavaFX Script language, but can also be used in Swing programs. These classes offer a low-level approach for specifying a graphical scene that's based on a scene graph—a structure that organizes a scene's representation.

This article focuses on Project Scene Graph. After introducing you to this technology via a "hello, world"–style Java application, you explore the "nuts and bolts" of Project Scene Graph: nodes, animation, and effects. You also discover Project Scene Graph's FX-prefixed classes, which offer several advantages to applications over the equivalent SG-prefixed classes.

Hello, Project Scene Graph

In the spirit of introducing new technologies via "hello, world" programs, I've created a similar example that demonstrates key aspects of Project Scene Graph. I've based the example (see Listing 1 for its source code) on a demo presented in former Sun employee and Project Scene Graph lead Hans Muller's January 8, 2008 blog entry.

Listing 1 HelloPSG.java

// HelloPSG.java

import java.awt.*;
import java.awt.geom.*;

import java.util.*;

import javax.swing.*;

import com.sun.scenario.animation.*;
import com.sun.scenario.effect.*;
import com.sun.scenario.scenegraph.*;

public class HelloPSG
{
  final static int WIDTH = 550;
  final static int HEIGHT = 300;
  final static int BORDERWIDTH = 10;

  public static void main (String [] args)
  {
   Runnable r = new Runnable ()
            {
             public void run ()
             {
               createAndShowGUI ();
             }
            };

   EventQueue.invokeLater (r);
  }

  public static void createAndShowGUI ()
  {
   JFrame f = new JFrame ("Hello, PSG!");
   f.setDefaultCloseOperation (JFrame.EXIT_ON_CLOSE);

   // JSGPanel is a JComponent that renders a scene graph. Instead of
   // instantiating this class, this method instantiates a subclass that
   // allows a scene graph to be properly centered.

   CenteringSGPanel panel = new CenteringSGPanel ();
   panel.setBackground (Color.BLACK);
   panel.setPreferredSize (new Dimension (WIDTH, HEIGHT));

   // A scene graph is implemented as a tree of nodes. The scene node is an
   // instance of SGGroup, which serves as a container for adding child
   // nodes.

   SGGroup sceneNode = new SGGroup ();
   sceneNode.setID ("sceneNode: SGGroup");

   // SGText represents a child node that renders a single line of text.

   SGText textNode = new SGText ();
   textNode.setID ("textNode: SGText");
   textNode.setText ("Hello, PSG!");
   textNode.setFont (new Font ("SansSerif", Font.PLAIN, 96));
   textNode.setAntialiasingHint (RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
   textNode.setFillPaint (Color.WHITE);

   // Create a node consisting of the text node surrounded by a border
   // node, and add it to the scene graph via the scene node.

   sceneNode.add (createBorderedNode (textNode));

   // An SGEffect node is required to introduce an effect, such as a drop
   // shadow.

   SGEffect effectNode = new SGEffect ();
   effectNode.setID ("effectNode: SGEffect");
   DropShadow shadow = new DropShadow ();
   shadow.setOffsetX (5);
   shadow.setOffsetY (5);
   effectNode.setEffect (shadow);
   effectNode.setChild (textNode);

   // Add the SGEffect node to the scene graph.

   sceneNode.add (effectNode);

   // An SGComposite node is required to specify opacity. The default
   // opacity is 1.0f (fully opaque).

   SGComposite compNode = new SGComposite ();
   compNode.setID ("compNode: SGComposite");
   compNode.setOpacity (1.0f);
   compNode.setChild (effectNode);

   // Add the SGComposite node to the scene graph.

   sceneNode.add (compNode);

   // Establish the scene.

   panel.setScene (sceneNode);

   // Dump the scene graph hierarchy to the standard output.

   dump (panel.getScene (), 0);

   // Install the panel into the Swing hierarchy, pack it to its preferred
   // size, and don't let it be resized. Furthermore, center and display
   // the main window on the screen.

   f.setContentPane (panel);
   f.pack ();
   f.setResizable (false);
   f.setLocationRelativeTo (null);
   f.setVisible (true);

   // Create an animation clip for animating the scene's text opacity. Each
   // cycle will last for 1.5 seconds, the animation will continue
   // indefinitely, the animation will repeatedly invoke the SGComposite
   // timing target, the property being animated is Opacity, and this
   // property is animated from completely opaque (1.0) to completely
   // transparent (0.0). Also, each cycle reverses the animation direction.

   Clip fader = Clip.create (1500,
                Clip.INDEFINITE,
                compNode,
                "Opacity",
                1.0f,
                0.0f);

   // Start the animation.

   fader.start ();
  }

  static SGNode createBorderedNode (SGNode node)
  {
   Rectangle2D nodeR = node.getBounds ();
   double x = nodeR.getX ()-BORDERWIDTH;
   double y = nodeR.getY ()-BORDERWIDTH;
   double w = nodeR.getWidth ()+(2*BORDERWIDTH);
   double h = nodeR.getHeight ()+(2*BORDERWIDTH);
   double a = 1.5*BORDERWIDTH;
   SGShape borderNode = new SGShape ();
   borderNode.setID ("borderNode: SGShape");
   borderNode.setShape (new RoundRectangle2D.Double (x, y, w, h, a, a));
   borderNode.setFillPaint (new Color (0x660000));
   borderNode.setDrawPaint (new Color (0xFFFF33));
   borderNode.setDrawStroke (new BasicStroke ((float) (BORDERWIDTH/2.0)));
   borderNode.setMode (SGAbstractShape.Mode.STROKE_FILL);
   borderNode.setAntialiasingHint (RenderingHints.VALUE_ANTIALIAS_ON);
   SGGroup borderedNode = new SGGroup ();
   borderedNode.setID ("borderedNode: SGGroup");
   borderedNode.add (borderNode);
   borderedNode.add (node);
   return borderedNode;
  }

  public static void dump (SGNode node, int level)
  {
   for (int i = 0; i < level; i++)
      System.out.print (" ");

   System.out.println (node.getID ());

   if (node instanceof SGParent)
   {
     java.util.List<SGNode> children = ((SGParent) node).getChildren ();
     Iterator<SGNode> it = children.iterator ();
     while (it.hasNext ())
       dump (it.next (), level+1);
   }
  }
}

// JSGPanel has been subclassed in order to properly center the scene within 
// this Swing component.

class CenteringSGPanel extends JSGPanel
{
  private SGNode sceneNode;
  private SGTransform.Translate centeringTNode;

  @Override public void doLayout ()
  {
   if (sceneNode != null)
   {
     Rectangle2D bounds = sceneNode.getBounds ();
     centeringTNode.setTranslateX (-bounds.getX ()+
                    (getWidth ()-bounds.getWidth ())/2.0);
     centeringTNode.setTranslateY (-bounds.getY ()+
                    (getHeight ()-bounds.getHeight ())/2.0);
   }
  }

  @Override public void setScene (SGNode sceneNode)
  {
   this.sceneNode = sceneNode;
   centeringTNode = SGTransform.createTranslation (0f, 0f, sceneNode);
   centeringTNode.setID ("centeringTNode: SGTransform.Translate");
   super.setScene (centeringTNode);
  }
}

Listing 1 describes a Project Scene Graph application whose colorful scene consists of a "Hello, PSG!" message that's located within a rectangle with a rounded border. A black drop shadow is rendered behind the message's text, and the text's opacity continuously animates from opaque to transparent (and vice versa). The resulting scene appears in Figure 1.

Figure 1

Figure 1 Antialiasing is used to improve the text's and each border corner's appearance.

Additionally, HelloPSG outputs its scene's hierarchy of nodes (which I discuss later) to the standard output. This hierarchy (which appears below) is walked by Project Scene Graph each time it needs to render the scene—Project Scene Graph applications don't perform their own rendering. Along with painting pixels, Project Scene Graph performs a translation, applies a drop-shadow effect, and takes care of opacity.

centeringTNode: SGTransform.Translate
 sceneNode: SGGroup
 borderedNode: SGGroup
  borderNode: SGShape
 compNode: SGComposite
  effectNode: SGEffect
  textNode: SGText

To render the scene, Project Scene Graph has these nodes set up a translation (to center the scene), then render the rectangle (taking the translation into account) that serves as a border for the text, subsequently render the drop-shadow effect (taking the translation and opacity into account), and finally render the text (again taking translation and opacity into account).

Before you learn how to compile HelloPSG.java and run the application, consider the following two items, which are applicable to all Project Scene Graph applications:

  • Packages: Project Scene Graph consists of nearly 100 classes, interfaces, and enumerations that are organized into seven packages: com.sun.scenario.animation, com.sun.scenario.animation.util, com.sun.scenario.effect, com.sun.scenario.effect.light, com.sun.scenario.scenegraph, com.sun.scenario.scenegraph.event, and com.sun.scenario.scenegraph.fx. You'll learn about many of these packages' types as you read this article.
  • JSGPanel: The com.sun.scenario.scenegraph.JSGPanel class is used to integrate a scene into a Swing application. The idea is to create an instance of this class, invoke its public void setScene(SGNode scene) method with the scene's root node as an argument, set the panel's preferred size (as recommended by former Project Scene Graph lead Hans Muller), and add the JSGPanel instance to the Swing application's component hierarchy.

Build and Run HelloPSG

You need to obtain the latest version of the Project Scene Graph JAR file before you can build and run HelloPSG. Go to Project Scene Graph's Java.net-hosted project page and download Scenario-0.6.jar. If desired, you can also download the JAR file's source code (Scenario-0.6-src.zip) from this page.

While you're downloading the JAR file and its archived source code, you might want to download Project Scene Graph's Javadoc-based API documentation—this documentation is stored in Scenario-0.6-doc.zip. Although you can alternatively view the API Javadoc online, I don't recommend doing so because that documentation is for a previous version, and the API has subsequently changed.

Assuming that Scenario-0.6.jar and HelloPSG.java are located in the current directory, and assuming that Java SE 6 is installed, execute the command line below to compile the source code:

javac -cp Scenario-0.6.jar HelloPSG.java

If compilation succeeds, invoke the following command line to run the resulting application (refer to Figure 1 for the output, which appears in a Windows XP context):

java -cp Scenario-0.6.jar;. HelloPSG

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020