netcharts.pro.common
Class NFSpotlight

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFGradient
          netcharts.pro.common.NFSpotlight

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFSpotlight
extends NFGradient
implements NFCDLGenerator

A class representing a spotlight gradient.

Field Summary

static int	BOTTOM Bottom center location
static int	BOTTOMLEFT Bottom left center location
static int	BOTTOMRIGHT Bottom right center location
static int	CENTER Center center location
static int	DEFAULT_CENTER
static double	DEFAULT_CENTER_OFFSET_X
static double	DEFAULT_CENTER_OFFSET_Y
static double	DEFAULT_FOCUS_OFFSET_X
static double	DEFAULT_FOCUS_OFFSET_Y
static double	DEFAULT_RADIUS
static int	LEFT Left center location
static int	RIGHT Right center location
static int	TOP Top center location
static int	TOPLEFT Top left center location
static int	TOPRIGHT Top right center location

Constructor Summary

NFSpotlight()

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this spotlight
int	getCenter() Gets the center location.
double	getCenterOffsetX() Get the offset of the x coordinate of the center point of the spotlight.
double	getCenterOffsetY() Get the offset of the y coordinate of the center point of the spotlight.
double	getFocusOffsetX() Get the offset of the x coordinate of the focus point of the spotlight.
double	getFocusOffsetY() Get the offset of the y coordinate of the focus point of the spotlight.
double	getRadius() Get the radius of the spotlight.
void	setCDL(java.lang.Object cdlObject) Configures this object from a CDL parameter object.
void	setCDL(java.lang.String cdl) Configures this object from a CDL parameter representation.
void	setCenter(int center) Sets the center location.
void	setCenterOffsetX(double centerOffsetX) Set the offset of the x coordinate of the center point of the spotlight.
void	setCenterOffsetY(double centerOffsetY) Set the offset of the y coordinate of the center point of the spotlight.
void	setFocusOffsetX(double focusOffsetX) Set the offset of the x coordinate of the focus point of the spotlight.
void	setFocusOffsetY(double focusOffsetY) Set the offset of the y coordinate of the focus point of the spotlight.
void	setRadius(double radius) Set the radius of the spotlight.

Methods inherited from class netcharts.pro.common.NFGradient

getStart, getStop, setStart, setStop

Methods inherited from class netcharts.pro.common.NFBaseClass

clone, getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface netcharts.pro.common.NFCDLGenerator

toString

Field Detail

TOPLEFT

public static final int TOPLEFT

Top left center location

TOP

public static final int TOP

Top center location

TOPRIGHT

public static final int TOPRIGHT

Top right center location

LEFT

public static final int LEFT

Left center location

CENTER

public static final int CENTER

Center center location

RIGHT

public static final int RIGHT

Right center location

BOTTOMLEFT

public static final int BOTTOMLEFT

Bottom left center location

BOTTOM

public static final int BOTTOM

Bottom center location

BOTTOMRIGHT

public static final int BOTTOMRIGHT

Bottom right center location

DEFAULT_CENTER_OFFSET_X

public static final double DEFAULT_CENTER_OFFSET_X

DEFAULT_CENTER_OFFSET_Y

public static final double DEFAULT_CENTER_OFFSET_Y

DEFAULT_FOCUS_OFFSET_X

public static final double DEFAULT_FOCUS_OFFSET_X

DEFAULT_FOCUS_OFFSET_Y

public static final double DEFAULT_FOCUS_OFFSET_Y

DEFAULT_RADIUS

public static final double DEFAULT_RADIUS

DEFAULT_CENTER

public static final int DEFAULT_CENTER

Constructor Detail

NFSpotlight

public NFSpotlight()

Method Detail

getCenterOffsetX

public double getCenterOffsetX()

Get the offset of the x coordinate of the center point of the spotlight. A fractional value between 0 and 1 represents the percentage of the width of the spotlighted object to use as the center x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the center x offset.

Returns:

The center x offset as a percentage or number of pixels.

setCenterOffsetX

public void setCenterOffsetX(double centerOffsetX)

Set the offset of the x coordinate of the center point of the spotlight. A fractional value between 0 and 1 represents the percentage of the width of the spotlighted object to use as the center x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the center x offset.

Parameters:

centerOffsetX - The center x offset as a percentage or number of pixels.

getCenterOffsetY

public double getCenterOffsetY()

Get the offset of the y coordinate of the center point of the spotlight. A fractional value between 0 and 1 represents the percentage of the height of the spotlighted object to use as the center y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the center y offset.

Returns:

The center y offset as a percentage or number of pixels.

setCenterOffsetY

public void setCenterOffsetY(double centerOffsetY)

Set the offset of the y coordinate of the center point of the spotlight. A fractional value between 0 and 1 represents the percentage of the height of the spotlighted object to use as the center y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the center y offset.

Parameters:

centerOffsetY - The center y offset as a percentage or number of pixels.

getFocusOffsetX

public double getFocusOffsetX()

Get the offset of the x coordinate of the focus point of the spotlight. A fractional value between 0 and 1 represents the percentage of the width of the spotlighted object to use as the focus x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the focus x offset.

Returns:

The focus x offset as a percentage or number of pixels.

setFocusOffsetX

public void setFocusOffsetX(double focusOffsetX)

Set the offset of the x coordinate of the focus point of the spotlight. A fractional value between 0 and 1 represents the percentage of the width of the spotlighted object to use as the focus x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the focus x offset.

Parameters:

focusOffsetX - The focus x offset as a percentage or number of pixels.

getFocusOffsetY

public double getFocusOffsetY()

Get the offset of the y coordinate of the focus point of the spotlight. A fractional value between 0 and 1 represents the percentage of the height of the spotlighted object to use as the focus y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the focus y offset.

Returns:

The focus y offset as a percentage or number of pixels.

setFocusOffsetY

public void setFocusOffsetY(double focusOffsetY)

Set the offset of the y coordinate of the focus point of the spotlight. A fractional value between 0 and 1 represents the percentage of the height of the spotlighted object to use as the focus y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the focus y offset.

Parameters:

focusOffsetY - The focus y offset as a percentage or number of pixels.

getRadius

public double getRadius()

Get the radius of the spotlight. A fractional value between 0 and 1 represents the percentage of the minimum of the width and height of the spotlighted object to use as the radius. A non fractional value greater than or equal to 1 represents the number of pixels to use for the radius.

Returns:

The radius as a percentage or number of pixels.

setRadius

public void setRadius(double radius)

Set the radius of the spotlight. A fractional value between 0 and 1 represents the percentage of the minimum of the width and height of the spotlighted object to use as the radius. A non fractional value greater than or equal to 1 represents the number of pixels to use for the radius.

Parameters:

radius - The radius as a percentage or number of pixels.

getCenter

public int getCenter()

Gets the center location.

Returns:

The center location

setCenter

public void setCenter(int center)

Sets the center location. If the value passed is not a valid center location an IllegalArgumentException will be thrown.

Parameters:

center - The center location

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this spotlight

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (start, stop, center, centerOffsetX, centerOffsetY, focusOffsetX, focusOffsetY, radius)

setCDL

public void setCDL(java.lang.Object cdlObject)

Configures this object from a CDL parameter object.

Parameters:

cdlObject - CDL in a String form or in a user object.

setCDL

public void setCDL(java.lang.String cdl)

Configures this object from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in the form: (start, stop, center, centerOffsetX, centerOffsetY, focusOffsetX, focusOffsetY, radius)