ilog.tgo.graphic.renderer

Class IltCardImageBaseRendererFactory

java.lang.Object

ilog.tgo.graphic.renderer.IltAbstractImageBaseRendererFactory

ilog.tgo.graphic.renderer.IltCardImageBaseRendererFactory

All Implemented Interfaces:

IltBaseRendererFactory

public class IltCardImageBaseRendererFactory
extends IltAbstractImageBaseRendererFactory

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

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

You can easily create a new card type with the following code:

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

Note: YOUR_NEW_TYPE_NAME should be replaced with the String of your choice.

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

Note: YOUR_IMAGE_PARAMETERS is optional.

Note: To obtain YOUR_IMAGE_PARAMETERS, follow these steps:

• Run the Image Color Tuner application located in the samples/framework/imagecolortuner/ directory of JTGO.
• Load the image file you want to use for your new object type by clicking the "Load Image..." button.
• Customize the image rendering using the provided sliders for the different base styles and alarm colors.
• Display the Java source code corresponding to your new type with the "View Source..." button. The constructor of the base renderer factory contains the parameters of the current display.

Since:

JTGO 4.0

See Also:

IltSettings, IltCard.Type

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

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

IltCardImageBaseRendererFactory

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

Creates a new IltImageCardBaseRendererFactory.

Parameters:

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

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

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

normGray - The gray level (0..255) applied when computing the alarm CarryingTraffic representation.

IltCardImageBaseRendererFactory

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

Creates a new IltImageCardBaseRendererFactory.

Parameters:

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

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

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

normGray - The gray level (0..255) applied when computing the alarm CarryingTraffic representation.

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

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltCardImageBaseRendererFactory

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

Creates a new IltImageCardBaseRendererFactory.

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 if an additional dotted border should be drawn around the base.

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltCardImageBaseRendererFactory

public IltCardImageBaseRendererFactory(Image sourceImage)

Creates a new IltImageCardBaseRendererFactory.

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

IltCardImageBaseRendererFactory

public IltCardImageBaseRendererFactory()

Creates a new IltCardImageBaseRendererFactory.

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