Statics Methods Relevant to Path2Bvr Objects

arc Creates a Path2Bvr object representing a segment of an oval (in effect, an arc).

arcDegrees Creates a Path2Bvr object representing a segment of an oval (in effect, this is an arc).

concat Creates a path behavior that represents the concatenation of the given path behaviors.

concatArray Creates a path behavior that represents the concatenation of the Path2Bvr objects in the array.

cubicBSplinePath Creates a Path2Bvr behavior based on a cubic B-spline curve.

line Creates a path behavior that represents the line segment defined by the given point behaviors.

oval Creates a Path2Bvr object that represents an oval, centered about the origin, and whose width and height are described by the given NumberBvr arguments.

pie Creates a Path2Bvr object representing a closed path that traces a segment of an oval and connects it to the origin. The arc of the oval is specified in radians.

pieDegrees Creates a Path2Bvr object representing a closed path that traces a segment of an oval and connects it to the origin. The arc of the oval is specified in degrees.

polydrawPath Creates a Path2Bvr object by manipulating the array of points with the codes contained in the NumberBvr array.

polyline Creates a path behavior that consists of the given point behaviors.

ray Creates a path behavior that represents the line segment from the origin to the given point behavior.

rect Creates the Path2Bvr object representing a rectangle, centered at the origin.

roundRect Creates a Path2Bvr object that is a rectangle, centered about the origin, with rounded, rather than square, corners.

stringPath Creates a Path2Bvr object from the supplied StringBvr object.

arc

Statics Class

Creates a Path2Bvr object representing a segment of an oval (in effect, an arc). The oval is centered at the origin.

Syntax

public static Path2Bvr arc(
     NumberBvr startAngle,
     NumberBvr endAngle,
     NumberBvr arcWidth,
     NumberBvr arcHeight
);

Parameters

startAngle
NumberBvr object representing the starting angle of the arc, expressed in radians. This parameter can also be of type double.
endAngle
NumberBvr object representing the ending angle of the arc, expressed in radians. This parameter can also be of type double.
arcWidth
NumberBvr object representing the width of the arc, expressed in meters. This parameter can also be of type double.
arcHeight
NumberBvr object representing the height of the arc, expressed in meters. This parameter can also be of type double.

Return Value

Returns the Path2Bvr object.

arcDegrees

Statics Class

Creates a Path2Bvr object representing a segment of an oval (in effect, this is an arc). The oval is centered at the origin.

Syntax

public static Path2Bvr arcDegrees(
     double startAngle,
     double endAngle,
     double arcWidth,
     double arcHeight
);

Parameters

startAngle
The double value representing the starting angle of the oval segment, expressed in degrees.
endAngle
The double representing the ending angle of the oval segment, expressed in degrees.
arcWidth
The double representing the width of the arc, expressed in meters.
arcHeight
The double representing the height of the arc, expressed in meters.

Return Value

Returns the Path2Bvr object.

concat

Statics Class

Creates a path behavior that represents the concatenation of the given path behaviors. In the new path, the points of p1 occur first, followed by those of p2. Path p2 is transformed so that the first point of p2 aligns with the last point of p1.

Syntax

public static Path2Bvr concat( Path2Bvr p1, Path2Bvr p2 );

Parameters

p1 and p2
Path2Bvr objects.

Return Value

Returns the Path2Bvr object.

concatArray

Statics Class

Creates a path behavior that represents the concatenation of the Path2Bvr objects in the array. In the new path, the points of the first path in the array occur first, followed sequentially by the other paths in the array. The second path, for example, is transformed so that its first point aligns with the last point of the first path.

Syntax

public static Path2Bvr concatArray( Path2Bvr[] paths );

Parameters

paths
Array of Path2Bvr objects.

Return Value

Returns the Path2Bvr object.

cubicBSplinePath

Statics Class

Creates a Path2Bvr behavior based on a cubic B-spline curve.

Syntax

public static Path2Bvr cubicBSplinePath(
Point2Bvr[] points, NumberBvr[] knots );

Parameters

points
Array of Point2Bvr objects representing the points used to calculate the B-spline.
knots
Array of NumberBvr objects representing the knots used to calculate the B-spline.

Return Value

Returns the Path2Bvr object.

Remarks

The curve depends on the control points and the knot vector, and requires that:
numberofPoints = numberofKnots - 2
The control points define the approximate direction and shape of the function. The knots represent the junction values, in parameter space, between the connected polynomial parts. For a number of knots k, the function is valid in the range [3, knotk-2], and is otherwise undefined.

line

Statics Class

Creates a path behavior that represents the line segment defined by the given point behaviors.

Syntax

public static Path2Bvr line( Point2Bvr p1, Point2Bvr p2 );

Parameters

p1 and p2
Point2Bvr objects.

Return Value

Returns the Path2Bvrobject.

oval

Statics Class

Creates a Path2Bvr object that represents an oval, centered about the origin, and whose width and height are described by the given NumberBvr arguments.

Syntax

public static Path2Bvr oval( NumberBvr width, NumberBvr height );

Parameters

x-radius
NumberBvr object representing the oval's width. This parameter can also be of type double.
y-radius
NumberBvr object representing the oval's height. This parameter can also be of type double.

Return Value

Returns the Path2Bvr object.

pie

Statics Class

Creates a Path2Bvr object representing a closed path that traces a segment of an oval and connects it to the origin. (In effect, it is a pie-shaped wedge). The oval is centered at the origin. The arc of the oval is specified in radians.

Syntax

public static Path2Bvr pie(
     NumberBvr startAngle,
     NumberBvr endAngle,
     NumberBvr arcWidth, arcHeight
);

Parameters

startAngle
NumberBvr object representing the starting angle of the oval segment, expressed in radians. This parameter can also be of type double.
endAngle
NumberBvr object representing the ending angle of the oval segment, expressed in radians. This parameter can also be of type double.
arcWidth
NumberBvr object representing the width of the arc, expressed in meters. This parameter can also be of type double.
arcHeight
NumberBvr object representing the height of the arc, expressed in meters. This parameter can also be of type double.

Return Value

Returns the Path2Bvr object.

pieDegrees

Statics Class

Syntax

public static Path2Bvr pieDegrees(
     double startAngle,
     double endAngle,
     double arcWidth,
     double arcHeight
);

Parameters

startAngle
The double value representing the starting angle of the oval segment, expressed in degrees.
endAngle
The double representing the ending angle of the oval segment, expressed in degrees.
arcWidth
The double representing the width of the arc, expressed in meters.
arcHeight
The double representing the height of the arc, expressed in meters.

Return Value

Returns the Path2Bvr object.

polydrawPath

Statics Class

Creates a Path2Bvr object by manipulating the array of points with the codes contained in the NumberBvr array.

Syntax

public static Path2Bvr polydrawPath(
Point2Bvr[] points, NumberBvr[] codes );

Parameters

points
Array of Point2Bvr objects.
codes
Array of NumberBvr objects representing the instruction codes.

Return Value

Returns the Path2Bvr object.

Remarks

The codes represent the instructions that can be combined with a logical OR operation, where:

Code Name Meaning

01 PT_CLOSEFIGURE Connects points to create a closed figure.

02 PT_LINETO Connects points in a line.

04 PT_BEZIERTO Connects points in a Bezier curve. These must occur in multiples of 3.

06 PT_MOVETO Moves to a point. This is, implicitly, always the first instruction.

This function is equivalent to the Graphics Device Interface (GDI) polydraw function.

Code	Name	Meaning
01	PT_CLOSEFIGURE	Connects points to create a closed figure.
02	PT_LINETO	Connects points in a line.
04	PT_BEZIERTO	Connects points in a Bezier curve. These must occur in multiples of 3.
06	PT_MOVETO	Moves to a point. This is, implicitly, always the first instruction.

polyline

Statics Class

Creates a path behavior that consists of the given point behaviors. The path can be used either for drawing or animation. The default line style is the defaultLineStyle.

Syntax

public static Path2Bvr polyline( Point2Bvr[] points );

Parameters

points
Array of Point2Bvr objects.

Return Value

Returns the Path2Bvr object.

ray

Statics Class

Creates a path behavior that represents the line segment from the origin to the given point behavior.

Syntax

public static Path2Bvr ray( Point2Bvr p );

Parameters

p
Point2Bvr object.

Return Value

Returns the Path2Bvrobject.

rect

Statics Class

Creates the Path2Bvr object representing a rectangle, centered at the origin.

Syntax

public static Path2Bvr rect( NumberBvr width, NumberBvr height );

Parameters

width
NumberBvr object representing the width of the rectangle. This parameter can also be of type double.
height
NumberBvr object representing the height of the rectangle. This parameter can also be of type double.

Return Value

Returns the Path2Bvr object.

roundRect

Statics Class

Creates a Path2Bvr object that is a rectangle, centered about the origin, with rounded, rather than square, corners. The corners are considered to be segments of an oval (in effect, an arc), centered at the origin.

Syntax

public static Path2Bvr roundRect(
     NumberBvr width,
     NumberBvr height,
     NumberBvr arcWidth,
     NumberBvr arcHeight
);

Parameters

width
NumberBvr object representing the rectangle's width. This parameter can also be of type double.
height
NumberBvr object representing the rectangle's height. This parameter can also be of type double.
arcWidth
NumberBvr object representing the width of the arc, expressed in meters. This parameter can also be of type double.
arcHeight
NumberBvr object representing the height of the arc, expressed in meters. This parameter can also be of type double.

Return Value

Returns the Path2Bvr object.

stringPath

Statics Class

Creates a Path2Bvr object from the supplied StringBvr object. The appearance is specified by the FontStyleBvr object. The path behavior is useful for creating a matte to which an image behavior can be clipped.

Syntax

public static Path2Bvr stringPath( StringBvr string, FontStyleBvr fs );

Parameters

string
StringBvr object used to create the Path2Bvr object. This parameter can also be of type java.lang.String.
fs
FontStyleBvr object specifying the appearance of the string.

Return Value

Returns the Path2Bvr object.