DirectX Media for Animation Java Reference

Previous

Classes

Index

Next

LinestyleBvr Class

public class LinestyleBvr extends Behavior {
    // Fields
    public static LinestyleBvr defaultLineStyle;

    //Methods
    public LinestyleBvr lineClosedStyle(BooleanBvr bool);
    public LinestyleBvr lineDetailStyle();
    public LinestyleBvr lineDashStyle(DashstyleBvr ds);
    public LinestyleBvr lineEndStyle(EndstyleBvr es);
    public LinestyleBvr lineJoinStyle(JoinstyleBvr js);
    public LinestyleBvr lineWidthStyle(NumberBvr width);
       
    public static LinestyleBvr newUninitBvr();

}

Creates an object that represents a linestyle behavior. The behavior defines the various line styles to use when drawing lines. These styles includes the shape of the end of a line, the shape of joints between intersecting lines, the width of the line, and whether the line is drawn with a continuous stroke or as a sequence of dashes.

You use linestyle behaviors with the strokeImage method of the ImageBvr class.

Methods

lineClosedStyle

public LinestyleBvr lineClosedStyle(BooleanBvr bool);

Creates a linestyle behavior from an existing linestyle by setting the closure attribute. If the attribute is true, the last and first endpoints in a path are automatically connected with a line segment. Otherwise, the points are left unconnected. By default, the closure attribute is false.

Return Value:

Returns the LinestyleBvr object.

Parameter	Description
bool	The BooleanBvr object that represents the closure attribute.

lineDashStyle

public LinestyleBvr lineDashStyle(DashstyleBvr ds);

Creates a linestyle behavior that is the result of applying the given dashstyle behavior to the existing linestyle. By default, the dashstyle is solid.

Return Value:

Returns the LinestyleBvr object.

Parameter	Description
ds	The DashstyleBvr object that represents the dashstyle behavior to apply.

lineDetailStyle

public LinestyleBvr lineDetailStyle();

Creates a detail linestyle behavior from an existing linestyle. A detail linestyle is not changed by image scaling operations; the lines drawn with this style are always one pixel wide. By default, the detailstyle is off.

Return Value:

Returns the LinestyleBvr object.

Remarks:

Any width or any endstyle or joinstyle behavior associated with the existing linestyle is discarded when creating the new line style. This attribute overrides lineWidthStyle.

lineEndStyle

public LinestyleBvr lineEndStyle(EndstyleBvr es);

Creates a linestyle behavior that is the result of applying the given endstyle to the existing linestyle. By default, the endstyle is flat.

Return Value:

Returns the LinestyleBvr object.

Parameter	Description
es	The EndstyleBvr object that represents the endstyle behavior to apply.

lineJoinStyle

public LinestyleBvr lineJoinStyle(JoinstyleBvr js);

Creates a linestyle behavior that is the result of applying the given joinstyle behavior to the existing linestyle. By default, the joinstyle is beveled.

Return Value:

Returns the LinestyleBvr object.

Parameter	Description
js	The JoinstyleBvr object that represents the joinstyle behavior to apply.

lineWidthStyle

public LinestyleBvr lineWidthStyle(NumberBvr width);

Creates a linestyle behavior from an existing linestyle by setting the width of line to the given amount. By default, the line width is 2 points (2/72 inch).

Return Value:

Returns the LinestyleBvr object.

Parameter	Description
width	The NumberBvr object that represents the width of the line in points (1/72 inch).

Remarks:

This attribute overrides lineDetailStyle.

newUninitBvr

public static LinestyleBvr newUninitBvr();

This method allows you to refer to an LinestyleBvr behavior before that behavior has been defined. With this method you can create the behavior and use it in the definition of other behaviors, but not actually define its contents until some later point. (This is accomplished with the init method, which is available on all behaviors.) The system generates a run-time error if you initialize a non-uninitialized behavior, initialize an uninitialized behavior that has already been initialized, or run an initialized behavior that has not yet been initialized.

Return Value:

Returns the LinestyleBvr object.

Fields

defaultLineStyle

A linestyle behavior (LinestyleBvr object) that draws solid lines having a width of two printer's points (0.00706 meters or 2/72 inch) with flat ends and beveled joints. This linestyle does not automatically close paths.