ilog.tgo.grprim

Class IltContains

java.lang.Object

ilog.tgo.grprim.IltContains

public class IltContains
extends Object

This class contains some primitive utility functions for determining whether a given pixel will be covered by the drawing primitives.

See Also:

IltGraphicUtil

Method Summary

Modifier and Type	Method and Description
static boolean	_FillRect(int x, int y, int x1, int y1, int x2, int y2) Test for containment in a rectangle of thickness 1.
static boolean	DrawDiamond(int x, int y, int x1, int y1, int x2, int y2, int thickness) Tests for containment in a diamond.
static boolean	DrawLine(int x, int y, int x1, int y1, int x2, int y2) Tests for containment in a line of thickness 1.
static boolean	DrawPoint(int x, int y, int x1, int y1) Test for containment in a single pixel.
static boolean	DrawPolygon(int x, int y, IltPolygon p, double apart, double thickness, int join) Tests for containment in a polygon.
static boolean	DrawPolyline(int x, int y, IltPolyline p, double thickness, int cap, int join) Tests for containment in a polyline.
static boolean	DrawRect(int x, int y, int x1, int y1, int x2, int y2) Test for containment in a rectangle boundary of thickness 1.
static boolean	DrawRect(int x, int y, int x1, int y1, int x2, int y2, double thickness, int cap) Test for containment in a rectangle boundary of a given thickness.
static boolean	DrawRoundRect(int x, int y, int x1, int y1, int x2, int y2, int xradius, int yradius) Tests for containment in a rounded rectangle boundary.
static boolean	FillDiamond(int x, int y, int x1, int y1, int x2, int y2) Tests for containment in a filled diamond.
static boolean	FillPolygon(int x, int y, IltPolygon p) Tests for containment in a filled polygon.
static boolean	FillRect(int x, int y, int x1, int y1, int x2, int y2) Test for containment in a rectangle of thickness 1.
static boolean	FillRect(int x, int y, int x1, int y1, int x2, int y2, double thickness, int cap) Test for containment in a rectangle of a given thickness.
static boolean	FillRoundRect(int x, int y, int x1, int y1, int x2, int y2, int xradius, int yradius) Tests for containment in a rounded rectangle, including its border.

Methods inherited from class java.lang.Object

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

Method Detail

DrawPoint

public static boolean DrawPoint(int x,
                                int y,
                                int x1,
                                int y1)

Test for containment in a single pixel.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - coordinate of the source point.

y1 - coordinate of the source point.

DrawRect

public static boolean DrawRect(int x,
                               int y,
                               int x1,
                               int y1,
                               int x2,
                               int y2)

Test for containment in a rectangle boundary of thickness 1.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - X coordinate of the top left corner.

y1 - Y coordinate of the top left corner.

x2 - X coordinate of the bottom right corner.

y2 - Y coordinate of the bottom right corner.

DrawRect

public static boolean DrawRect(int x,
                               int y,
                               int x1,
                               int y1,
                               int x2,
                               int y2,
                               double thickness,
                               int cap)

Test for containment in a rectangle boundary of a given thickness.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - X coordinate of the top left corner.

y1 - Y coordinate of the top left corner.

x2 - X coordinate of the bottom right corner.

y2 - Y coordinate of the bottom right corner.

thickness - Border thickness.

cap - Rectangle border end cap configuration.

FillRect

public static boolean FillRect(int x,
                               int y,
                               int x1,
                               int y1,
                               int x2,
                               int y2)

Test for containment in a rectangle of thickness 1.

Parameters:

x - coordinate of point being tested

y - coordinate of point being tested

x1 - X coordinate of the top left corner.

y1 - Y coordinate of the top left corner.

x2 - X coordinate of the bottom right corner.

y2 - Y coordinate of the bottom right corner.

_FillRect

public static boolean _FillRect(int x,
                                int y,
                                int x1,
                                int y1,
                                int x2,
                                int y2)

Test for containment in a rectangle of thickness 1.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - X coordinate of the top left corner.

y1 - Y coordinate of the top left corner.

x2 - X coordinate of the bottom right corner.

y2 - Y coordinate of the bottom right corner.

FillRect

public static boolean FillRect(int x,
                               int y,
                               int x1,
                               int y1,
                               int x2,
                               int y2,
                               double thickness,
                               int cap)

Test for containment in a rectangle of a given thickness.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - X coordinate of the top left corner.

y1 - Y coordinate of the top left corner.

x2 - X coordinate of the bottom right corner.

y2 - Y coordinate of the bottom right corner.

thickness - Border thickness.

cap - End cap configuration.

FillPolygon

public static boolean FillPolygon(int x,
                                  int y,
                                  IltPolygon p)

Tests for containment in a filled polygon.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

p - the source polygon.

DrawLine

public static boolean DrawLine(int x,
                               int y,
                               int x1,
                               int y1,
                               int x2,
                               int y2)

Tests for containment in a line of thickness 1.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - x coordinate of the from end point.

y1 - y coordinate of the from end point.

x2 - x coordinate of the to end point.

y2 - y coordinate of the to end point.

DrawRoundRect

public static boolean DrawRoundRect(int x,
                                    int y,
                                    int x1,
                                    int y1,
                                    int x2,
                                    int y2,
                                    int xradius,
                                    int yradius)

Tests for containment in a rounded rectangle boundary.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - x coordinate of the top left corner.

y1 - y coordinate of the top left corner.

x2 - x coordinate of the bottom right corner.

y2 - y coordinate of the bottom right corner.

xradius - radius of the round rectangle corner.

yradius - radius of the round rectangle corner.

FillRoundRect

public static boolean FillRoundRect(int x,
                                    int y,
                                    int x1,
                                    int y1,
                                    int x2,
                                    int y2,
                                    int xradius,
                                    int yradius)

Tests for containment in a rounded rectangle, including its border.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - x coordinate of the top left corner.

y1 - y coordinate of the top left corner.

x2 - x coordinate of the bottom right corner.

y2 - y coordinate of the bottom right corner.

xradius - radius of the round rectangle corner.

yradius - radius of the round rectangle corner.

DrawPolyline

public static boolean DrawPolyline(int x,
                                   int y,
                                   IltPolyline p,
                                   double thickness,
                                   int cap,
                                   int join)

Tests for containment in a polyline.

Parameters:

x - coordinate of point being tested

y - coordinate of point being tested

p - source polyline.

thickness - polyline thickness.

cap - end cap configuration.

join - line join configuration.

DrawPolygon

public static boolean DrawPolygon(int x,
                                  int y,
                                  IltPolygon p,
                                  double apart,
                                  double thickness,
                                  int join)

Tests for containment in a polygon.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

p - source polygon.

apart - distance (positive for a parallel to the right of the polygon, negative for a parallel to the left of the polygon).

thickness - polygon thickness.

join - line join configuration.

FillDiamond

public static boolean FillDiamond(int x,
                                  int y,
                                  int x1,
                                  int y1,
                                  int x2,
                                  int y2)

Tests for containment in a filled diamond.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - x coordinate of the top left corner.

y1 - y coordinate of the top left corner.

x2 - x coordinate of the bottom right corner.

y2 - y coordinate of the bottom right corner.

DrawDiamond

public static boolean DrawDiamond(int x,
                                  int y,
                                  int x1,
                                  int y1,
                                  int x2,
                                  int y2,
                                  int thickness)

Tests for containment in a diamond.

Parameters:

x - coordinate of point being tested.

y - coordinate of point being tested.

x1 - x coordinate of the top left corner.

y1 - y coordinate of the top left corner.

x2 - x coordinate of the bottom right corner.

y2 - y coordinate of the bottom right corner.

thickness - border thickness.