ilog.tgo.graphic.renderer

Class IltPortImageBaseRendererFactory

java.lang.Object

ilog.tgo.graphic.renderer.IltAbstractImageBaseRendererFactory

ilog.tgo.graphic.renderer.IltPortImageBaseRendererFactory

All Implemented Interfaces:

IltBaseRendererFactory

public class IltPortImageBaseRendererFactory
extends IltAbstractImageBaseRendererFactory

This class lets you to easily create new types of ports from an image. For example, the image representing a new connector type can be an image file (with or without transparency). This class then performs the necessary processing on the given image to generate all the graphic representations corresponding to the different base styles and alarm colors.

Note: Image processing is carried out only when necessary. This means that when a new type is defined, no memory or CPU is used. The real processing and memory allocation are performed only when the first time the image is drawn.

You can easily create a new port connector with the following code:

 IltPort.Type newType = new IltPort.Type(YOUR_NEW_TYPE_NAME);
 try {
   Image img = null;
   URL url = new URL("file", "", YOUR_IMAGE_FILE_NAME);
   img = getImage(url);
   if (img != null) {
     IltPortImageBaseRendererFactory factory =
       new IltPortImageBaseRendererFactory(img, YOUR_IMAGE_PARAMETERS );
     IltSettings.SetValue("Port.Type.YOUR_NEW_TYPE_NAME.Renderer", factory);
   }
 } catch (Exception e) {
   e.printStackTrace();
 }
 

Note: YOUR_NEW_TYPE_NAME should be replaced with any String you want.

YOUR_IMAGE_FILE_NAME should be replaced with the appropriate String to create a URL object for your image.

YOUR_IMAGE_PARAMETERS is optional.

To obtain YOUR_IMAGE_PARAMETERS, follow these steps:

1. Run the Image Color Tuner application located in the samples/framework/imagecolortuner/ directory of JTGO. The parameters are the same as for IltNetworkElement objects and ports.
2. Load the image file you want to use for your new object type by clicking on the "Load Image..." button.
3. Customize the image rendering using the provided sliders for the different base styles and alarm colors.
4. Display the Java source code corresponding to your new type using the "View Source..." button. The constructor of the BaseRenderer factory contains the parameters corresponding to the current display.

Since:

JTGO 4.0

See Also:

IltPort.Type, IltSettings, IltPortBaseRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IltPortImageBaseRendererFactory.BaseRenderer This implementation of BaseRenderer can draw a modified version of the sourceImage (given as parameter of the constructor of the BaseRenderer factory) according to the baseStyle and alarms of the object that is represented.

Constructor Summary

Constructors

Constructor and Description
IltPortImageBaseRendererFactory() Creates a new IltPortImageBaseRendererFactory.
IltPortImageBaseRendererFactory(Image sourceImage) Creates a new IltImagePortBaseRendererFactory.
IltPortImageBaseRendererFactory(Image sourceImage, int brightThreshold, int darkThreshold, int normGray) Creates a new IltImagePortBaseRendererFactory.
IltPortImageBaseRendererFactory(Image sourceImage, int brightThreshold, int darkThreshold, int normGray, boolean dottedBorderVisible) Creates a new IltImagePortBaseRendererFactory.
IltPortImageBaseRendererFactory(String sourceImageName, int brightThreshold, int darkThreshold, int normGray, boolean dottedBorderVisible) Creates a new IltImagePortBaseRendererFactory.

Method Summary

Modifier and Type	Method and Description
protected IltBaseRenderer	createBaseRenderer() This method can be overridden to create the real base renderer that displays the image.

Methods inherited from class ilog.tgo.graphic.renderer.IltAbstractImageBaseRendererFactory

createValue, getBrightThreshold, getDarkThreshold, getGrayLevel, getImageFactory, getSourceImage, getSourceImageName, isDottedBorderVisible, isPolygonalBorder, setBrightThreshold, setDarkThreshold, setDottedBorderVisible, setGrayLevel, setPolygonalBorder, setSourceImage, setSourceImageName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IltPortImageBaseRendererFactory

public IltPortImageBaseRendererFactory(Image sourceImage,
                                       int brightThreshold,
                                       int darkThreshold,
                                       int normGray)

Creates a new IltImagePortBaseRendererFactory.

Parameters:

sourceImage - The image that will be processed to create the different BaseStyle representations.

brightThreshold - The threshold (0..255) used for bright colors when computing the NoTraffic representation.

darkThreshold - The threshold (0..255) used for dark colors when computing the NoTraffic representation.

normGray - The gray level (0..255) used when computing the alarmed CarryingTraffic representation.

IltPortImageBaseRendererFactory

public IltPortImageBaseRendererFactory(Image sourceImage,
                                       int brightThreshold,
                                       int darkThreshold,
                                       int normGray,
                                       boolean dottedBorderVisible)

Creates a new IltImagePortBaseRendererFactory.

Parameters:

sourceImage - The image that will be processed to create the different BaseStyle representations.

brightThreshold - The threshold (0..255) used for bright colors when computing the NoTraffic representation.

darkThreshold - The threshold (0..255) used for dark colors when computing the NoTraffic representation.

normGray - The gray level (0..255) used when computing the alarmed CarryingTraffic representation.

dottedBorderVisible - Indicates whether an additional dotted border should be drawn around the base.

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltPortImageBaseRendererFactory

public IltPortImageBaseRendererFactory(String sourceImageName,
                                       int brightThreshold,
                                       int darkThreshold,
                                       int normGray,
                                       boolean dottedBorderVisible)

Creates a new IltImagePortBaseRendererFactory.

Parameters:

sourceImageName - The image that will be processed to create the different BaseStyle representations.

brightThreshold - The threshold (0..255) used for bright colors when computing the NoTraffic representation.

darkThreshold - The threshold (0..255) used for dark colors when computing the NoTraffic representation.

normGray - The gray level (0..255) used when computing the alarmed CarryingTraffic representation.

dottedBorderVisible - Indicates whether an additional dotted border should be drawn around the base.

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltPortImageBaseRendererFactory

public IltPortImageBaseRendererFactory(Image sourceImage)

Creates a new IltImagePortBaseRendererFactory.

Using this constructor is equivalent to IltImagePortBaseRendererFactory(sourceImage, 200, 50, 128, false).

Parameters:

sourceImage - The image that will be processed to create the different BaseStyle representations.

IltPortImageBaseRendererFactory

public IltPortImageBaseRendererFactory()

Creates a new IltPortImageBaseRendererFactory.

The following default values are used:

• Bright color threshold: 200
• Dark color threshold: 50
• Normal gray: 128
• Dotted border visible: false

The source image must be specified using method IltAbstractImageBaseRendererFactory.setSourceImage(Image) or IltAbstractImageBaseRendererFactory.setSourceImageName(String) before using this renderer factory.

The renderer factory parameters shall be specified before using this renderer factory for the first time. Once the renderer factory is in use, modifying these parameters will have no effect on the object representation.

Since:

JViews 7.5

See Also:

IltAbstractImageBaseRendererFactory.setSourceImage(Image), IltAbstractImageBaseRendererFactory.setSourceImageName(String), IltAbstractImageBaseRendererFactory.setBrightThreshold(int), IltAbstractImageBaseRendererFactory.setDarkThreshold(int), IltAbstractImageBaseRendererFactory.setGrayLevel(int), IltAbstractImageBaseRendererFactory.setDottedBorderVisible(boolean)

Method Detail

createBaseRenderer

protected IltBaseRenderer createBaseRenderer()

Description copied from class: IltAbstractImageBaseRendererFactory

This method can be overridden to create the real base renderer that displays the image.

This method is called by IltAbstractImageBaseRendererFactory.createValue().

Specified by:

createBaseRenderer in class IltAbstractImageBaseRendererFactory