edu.ucdavis.cstars.client.tasks

Class OffsetParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.OffsetParameters

public class OffsetParameters
extends com.google.gwt.core.client.JavaScriptObject

Sets the offset distance, type and other parameters for the

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OffsetParameters.OffsetType

Method Summary

Methods

Modifier and Type	Method and Description
static OffsetParameters	create() Creates a new OffsetParameters object.
double	getBevelRatio() The bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is bevelled.
com.google.gwt.core.client.JsArray<Geometry>	getGeometries() The array of geomtries to be offset.
float	getOffsetDistance() Specifies the distance for constructing an offset based on the input geometries.
OffsetParameters.OffsetType	getOffsetHow() Get the offset how parameter.
GeometryService.UnitType	getOffsetUnit() The offset distance unit.
void	setBevelRatio(double bevelRatio) set the bevel ratio parameter.
void	setGeometries(Geometry[] geometries) Set the geometries parameter.
void	setOffsetDistance(float offsetDistance) Set the offset distance parameter.
void	setOffsetHow(OffsetParameters.OffsetType offsetHow) Set the offset how parameter.
void	setOffsetUnit(GeometryService.UnitType offsetUnit) Set the offset unit.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static OffsetParameters create()

Creates a new OffsetParameters object.

Returns:

OffsetParameters

getBevelRatio

public final double getBevelRatio()

The bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is bevelled. When mitered is specified, the value set for bevelRatio is ignored and 10 is sed internally. If bevelled is specified 1.1 will be used if no value is set for bevelRatio. The bevelRatio is ignored when rounded is specified.

Returns:

double

setBevelRatio

public final void setBevelRatio(double bevelRatio)

set the bevel ratio parameter.

Parameters:

bevelRatio - - The bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is bevelled. When mitered is specified, the value set for bevelRatio is ignored and 10 is sed internally. If bevelled is specified 1.1 will be used if no value is set for bevelRatio. The bevelRatio is ignored when rounded is specified.

getGeometries

public final com.google.gwt.core.client.JsArray<Geometry> getGeometries()

The array of geomtries to be offset.

Returns:

JsArray

setGeometries

public final void setGeometries(Geometry[] geometries)

Set the geometries parameter.

Parameters:

geometries - - The array of geomtries to be offset.

getOffsetDistance

public final float getOffsetDistance()

Specifies the distance for constructing an offset based on the input geometries. If the offsetDistance parameter is positive the constructed offset will be on the right side of the curve. Left side offsets are constructed with negative values.

Returns:

float

setOffsetDistance

public final void setOffsetDistance(float offsetDistance)

Set the offset distance parameter.

Parameters:

offsetDistance - - Specifies the distance for constructing an offset based on the input geometries. If the offsetDistance parameter is positive the constructed offset will be on the right side of the curve. Left side offsets are constructed with negative values.

getOffsetHow

public final OffsetParameters.OffsetType getOffsetHow()

Get the offset how parameter.

Returns:

OffsetType

setOffsetHow

public final void setOffsetHow(OffsetParameters.OffsetType offsetHow)

Set the offset how parameter.

Parameters:

offsetHow -

getOffsetUnit

public final GeometryService.UnitType getOffsetUnit()

The offset distance unit.

Returns:

UnitType

setOffsetUnit

public final void setOffsetUnit(GeometryService.UnitType offsetUnit)

Set the offset unit.

Parameters:

offsetUnit - - The offset distance unit.