| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.NodeComponent
javax.media.j3d.LineAttributes
| LineAttributes | | public class LineAttributes extends NodeComponent (Code) | | The LineAttributes object defines all rendering state that can be set
as a component object of a Shape3D node.
The line attributes that can be defined are:
- Pattern - specifies the pattern used to draw the line:
- PATTERN_SOLID - draws a solid line with no pattern. This is
the default.
- PATTERN_DASH - draws dashed lines. Ideally, these will be drawn with
a repeating pattern of 8 pixels on and 8 pixels off.
- PATTERN_DOT - draws dotted lines. Ideally, these will be drawn with
a repeating pattern of 1 pixel on and 7 pixels off.
- PATTERN_DASH_DOT - draws dashed-dotted lines. Ideally, these will be
drawn with a repeating pattern of 7 pixels on, 4 pixels off, 1 pixel on,
and 4 pixels off.
- PATTERN_USER_DEFINED - draws lines with a user-defined line pattern.
See "User-defined Line Patterns," below.
- Antialiasing (enabled or disabled). By default, antialiasing
is disabled.
If antialiasing is enabled, the lines are considered transparent
for rendering purposes. They are rendered with all the other transparent
objects and adhere to the other transparency settings such as the
View transparency sorting policy and the View depth buffer freeze
transparent enable.
- Width (in pixels). The default is a line width of one pixel.
User-defined Line Patterns
A user-defined line pattern is specified with a pattern mask and
an optional scale factor.
The Pattern Mask
The pattern is specified
using a 16-bit mask that specifies on and off segments. Bit 0 in
the pattern mask corresponds to the first pixel of the line or line
strip primitive. A value of 1 for a bit in the pattern mask indicates
that the corresponding pixel is drawn, while a value of 0
indicates that the corresponding pixel is not drawn. After all 16 bits
in the pattern are used, the pattern is repeated.
For example, a mask of 0x00ff defines a dashed line with a repeating
pattern of 8 pixels on followed by 8 pixels off. A value of 0x0101
defines a a dotted line with a repeating pattern of 1 pixel on and 7
pixels off.
The pattern continues around individual line segments of a line strip
primitive. It is restarted at the beginning of each new line strip.
For line array primitives, the pattern is restarted at the beginning
of each line.
The Scale Factor
The pattern is multiplied by the scale factor such that each bit in
the pattern mask corresponds to that many consecutive pixels.
For example, a scale factor of 3 applied to a pattern mask of 0x001f
would produce a repeating pattern of 15 pixels on followed by 33
pixels off. The valid range for this attribute is [1,15]. Values
outside this range are clamped.
See Also: Appearance
See Also: View |
| Field Summary | |
| final public static int | ALLOW_ANTIALIASING_READ
Specifies that this LineAttributes object allows reading its
line antialiasing flag. | | final public static int | ALLOW_ANTIALIASING_WRITE
Specifies that this LineAttributes object allows writing its
line antialiasing flag. | | final public static int | ALLOW_PATTERN_READ
Specifies that this LineAttributes object allows reading its
line pattern information. | | final public static int | ALLOW_PATTERN_WRITE
Specifies that this LineAttributes object allows writing its
line pattern information. | | final public static int | ALLOW_WIDTH_READ
Specifies that this LineAttributes object allows reading its
line width information. | | final public static int | ALLOW_WIDTH_WRITE
Specifies that this LineAttributes object allows writing its
line width information. | | final public static int | PATTERN_DASH
Draw dashed lines. | | final public static int | PATTERN_DASH_DOT
Draw dashed-dotted lines. | | final public static int | PATTERN_DOT
Draw dotted lines. | | final public static int | PATTERN_SOLID
Draw solid lines with no pattern. | | final public static int | PATTERN_USER_DEFINED
Draw lines with a user-defined line pattern. |
| Constructor Summary | |
| public | LineAttributes()
Constructs a LineAttributes object with default parameters. | | public | LineAttributes(float lineWidth, int linePattern, boolean lineAntialiasing)
Constructs a LineAttributes object with specified values. |
| Method Summary | |
| public NodeComponent | cloneNodeComponent()
| | void | createRetained()
Creates a retained mode LineAttributesRetained object that this
LineAttributes component object will point to. | | void | duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
Copies all node information from originalNodeComponent into
the current node. | | public boolean | getLineAntialiasingEnable()
Retrieves the state of the line antialiasing flag. | | public int | getLinePattern()
Gets the line pattern for this LineAttributes component object. | | public float | getLineWidth()
Gets the line width for this LineAttributes component object. | | public int | getPatternMask()
Retrieves the line pattern mask. | | public int | getPatternScaleFactor()
Retrieves the line pattern scale factor. | | public void | setLineAntialiasingEnable(boolean state)
Enables or disables line antialiasing
for this LineAttributes component object.
If antialiasing is enabled, the lines are considered transparent
for rendering purposes. | | public void | setLinePattern(int linePattern)
Sets the line pattern for this LineAttributes component object. | | public void | setLineWidth(float lineWidth)
Sets the line width for this LineAttributes component object. | | public void | setPatternMask(int mask)
Sets the line pattern mask to the specified value. | | public void | setPatternScaleFactor(int scaleFactor)
Sets the line pattern scale factor to the specified value.
This is used in conjunction with the patternMask when the
linePattern attribute is set to PATTERN_USER_DEFINED. |
| ALLOW_ANTIALIASING_READ | | final public static int ALLOW_ANTIALIASING_READ(Code) | | Specifies that this LineAttributes object allows reading its
line antialiasing flag.
|
| ALLOW_ANTIALIASING_WRITE | | final public static int ALLOW_ANTIALIASING_WRITE(Code) | | Specifies that this LineAttributes object allows writing its
line antialiasing flag.
|
| ALLOW_PATTERN_READ | | final public static int ALLOW_PATTERN_READ(Code) | | Specifies that this LineAttributes object allows reading its
line pattern information.
|
| ALLOW_PATTERN_WRITE | | final public static int ALLOW_PATTERN_WRITE(Code) | | Specifies that this LineAttributes object allows writing its
line pattern information.
|
| ALLOW_WIDTH_READ | | final public static int ALLOW_WIDTH_READ(Code) | | Specifies that this LineAttributes object allows reading its
line width information.
|
| ALLOW_WIDTH_WRITE | | final public static int ALLOW_WIDTH_WRITE(Code) | | Specifies that this LineAttributes object allows writing its
line width information.
|
| PATTERN_DASH | | final public static int PATTERN_DASH(Code) | | Draw dashed lines. Ideally, these will be drawn with
a repeating pattern of 8 pixels on and 8 pixels off.
See Also: LineAttributes.setLinePattern |
| PATTERN_DASH_DOT | | final public static int PATTERN_DASH_DOT(Code) | | Draw dashed-dotted lines. Ideally, these will be drawn with
a repeating pattern of 7 pixels on, 4 pixels off, 1 pixel on,
and 4 pixels off.
See Also: LineAttributes.setLinePattern |
| PATTERN_DOT | | final public static int PATTERN_DOT(Code) | | Draw dotted lines. Ideally, these will be drawn with
a repeating pattern of 1 pixel on and 7 pixels off.
See Also: LineAttributes.setLinePattern |
| LineAttributes | | public LineAttributes()(Code) | | Constructs a LineAttributes object with default parameters.
The default values are as follows:
line width : 1
line pattern : PATTERN_SOLID
pattern mask : 0xffff
pattern scale factor : 1
line antialiasing : false
|
| LineAttributes | | public LineAttributes(float lineWidth, int linePattern, boolean lineAntialiasing)(Code) | | Constructs a LineAttributes object with specified values.
Parameters:
lineWidth - the width of lines in pixels
Parameters:
linePattern - the line pattern, one of PATTERN_SOLID,PATTERN_DASH, PATTERN_DOT, or PATTERN_DASH_DOT
Parameters:
lineAntialiasing - flag to set line antialising ON or OFF |
| createRetained | | void createRetained()(Code) | | Creates a retained mode LineAttributesRetained object that this
LineAttributes component object will point to.
|
| duplicateAttributes | | void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code) | | Copies all node information from originalNodeComponent into
the current node. This method is called from the
duplicateNode method. This routine does
the actual duplication of all "local data" (any data defined in
this object).
Parameters:
originalNodeComponent - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getLineAntialiasingEnable | | public boolean getLineAntialiasingEnable()(Code) | | Retrieves the state of the line antialiasing flag.
true if line antialiasing is enabled,false if line antialiasing is disabled
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getLinePattern | | public int getLinePattern()(Code) | | Gets the line pattern for this LineAttributes component object.
the line pattern
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getLineWidth | | public float getLineWidth()(Code) | | Gets the line width for this LineAttributes component object.
the width, in pixels, of line primitives
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPatternMask | | public int getPatternMask()(Code) | | Retrieves the line pattern mask.
the line pattern mask
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
since:
Java 3D 1.2 |
| getPatternScaleFactor | | public int getPatternScaleFactor()(Code) | | Retrieves the line pattern scale factor.
the line pattern scale factor
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
since:
Java 3D 1.2 |
| setLineAntialiasingEnable | | public void setLineAntialiasingEnable(boolean state)(Code) | | Enables or disables line antialiasing
for this LineAttributes component object.
If antialiasing is enabled, the lines are considered transparent
for rendering purposes. They are rendered with all the other
transparent objects and adhere to the other transparency settings
such as the View transparency sorting policy and the View depth buffer
freeze transparent enable.
Parameters:
state - true or false to enable or disable line antialiasing
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: View |
| setLinePattern | | public void setLinePattern(int linePattern)(Code) | | Sets the line pattern for this LineAttributes component object.
Parameters:
linePattern - the line pattern to be used, one of:PATTERN_SOLID, PATTERN_DASH, PATTERN_DOT, PATTERN_DASH_DOT, orPATTERN_USER_DEFINED.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setLineWidth | | public void setLineWidth(float lineWidth)(Code) | | Sets the line width for this LineAttributes component object.
Parameters:
lineWidth - the width, in pixels, of line primitives
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPatternMask | | public void setPatternMask(int mask)(Code) | | Sets the line pattern mask to the specified value. This is
used when the linePattern attribute is set to
PATTERN_USER_DEFINED. In this mode, the pattern is specified
using a 16-bit mask that specifies on and off segments. Bit 0
in the pattern mask corresponds to the first pixel of the line
or line strip primitive. A value of 1 for a bit in the pattern
mask indicates that the corresponding pixel is drawn, while a
value of 0 indicates that the corresponding pixel is not drawn.
After all 16 bits in the pattern are used, the pattern is
repeated. For example, a mask of 0x00ff defines a dashed line
with a repeating pattern of 8 pixels on followed by 8 pixels
off. A value of 0x0101 defines a a dotted line with a
repeating pattern of 1 pixel on and 7 pixels off
The pattern continues around individual line segments of a line
strip primitive. It is restarted at the beginning of each new
line strip. For line array primitives, the pattern is
restarted at the beginning of each line.
Parameters:
mask - the new line pattern mask
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: LineAttributes.setPatternScaleFactor
since:
Java 3D 1.2 |
| setPatternScaleFactor | | public void setPatternScaleFactor(int scaleFactor)(Code) | | Sets the line pattern scale factor to the specified value.
This is used in conjunction with the patternMask when the
linePattern attribute is set to PATTERN_USER_DEFINED. The
pattern is multiplied by the scale factor such that each bit in
the pattern mask corresponds to that many consecutive pixels.
For example, a scale factor of 3 applied to a pattern mask of
0x001f would produce a repeating pattern of 15 pixels on
followed by 33 pixels off. The valid range for this attribute
is [1,15]. Values outside this range are clamped.
Parameters:
scaleFactor - the new line pattern scale factor
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: LineAttributes.setPatternMask
since:
Java 3D 1.2 |
| Fields inherited from javax.media.j3d.NodeComponent | boolean forceDuplicate(Code)(Java Doc)
|
|
|