javax.media.j3d
Class LineAttributesRetained

java.lang.Object
  extended by javax.media.j3d.IndexedObject
      extended by javax.media.j3d.SceneGraphObjectRetained
          extended by javax.media.j3d.NodeComponentRetained
              extended by javax.media.j3d.LineAttributesRetained
All Implemented Interfaces:
java.lang.Cloneable

 class LineAttributesRetained
extends NodeComponentRetained

The LineAttributesRetained object defines all rendering state that can be set as a component object of a Shape3D node.


Field Summary
(package private) static int LINE_AA_CHANGED
           
(package private) static int LINE_PATTERN_CHANGED
           
(package private) static int LINE_PATTERN_MASK_CHANGED
           
(package private) static int LINE_PATTERN_SCALEFACTOR_CHANGED
           
(package private) static int LINE_WIDTH_CHANGED
           
(package private)  boolean lineAntialiasing
           
(package private)  int linePattern
           
(package private)  int linePatternMask
           
(package private)  int linePatternScaleFactor
           
(package private)  float lineWidth
           
 
Fields inherited from class javax.media.j3d.NodeComponentRetained
changedFrequent, compChanged, duplicateOnCloneTree, mirror, refCnt, refCount, users
 
Fields inherited from class javax.media.j3d.SceneGraphObjectRetained
DONT_MERGE, inBackgroundGroup, inSetLive, MERGE, MERGE_DONE, mergeFlag, onUpdateList, source
 
Fields inherited from class javax.media.j3d.IndexedObject
listIdx
 
Constructor Summary
LineAttributesRetained()
           
 
Method Summary
(package private)  void createMirrorObject()
          Creates and initializes a mirror object, point the mirror object to the retained object if the object is not editable
(package private)  boolean equivalent(LineAttributesRetained lr)
           
(package private)  boolean getLineAntialiasingEnable()
          Retrieves the state of the line antialiasing flag.
(package private)  int getLinePattern()
          Gets the line pattern for this lineAttributes component object.
(package private)  float getLineWidth()
          Gets the line width for this lineAttributes component object.
(package private)  int getPatternMask()
          Retrieves the pattern mask for this LineAttributes component object.
(package private)  int getPatternScaleFactor()
          Retrieves the pattern scale factor for this LineAttributes component object.
(package private)  void handleFrequencyChange(int bit)
           
(package private)  void initLineAntialiasingEnable(boolean state)
          Enables or disables line antialiasing for this lineAttributes component object and sends a message notifying the interested structures of the change.
(package private)  void initLinePattern(int linePattern)
          Sets the line pattern for this lineAttributes component object
(package private)  void initLineWidth(float lineWidth)
          Sets the line width for this lineAttributes component object.
(package private)  void initMirrorObject()
          Initializes a mirror object, point the mirror object to the retained object if the object is not editable
(package private)  void initPatternMask(int mask)
          Sets the pattern mask for this LineAttributes component object.
(package private)  void initPatternScaleFactor(int scaleFactor)
          Sets the pattern mask scale factor for this LineAttributes component object.
(package private)  void sendMessage(int attrMask, java.lang.Object attr)
           
protected  void set(LineAttributesRetained lr)
           
(package private)  void setLineAntialiasingEnable(boolean state)
          Enables or disables line antialiasing for this lineAttributes component object and sends a message notifying the interested structures of the change.
(package private)  void setLinePattern(int linePattern)
          Sets the line pattern for this lineAttributes component object and sends a message notifying the interested structures of the change.
(package private)  void setLineWidth(float lineWidth)
          Sets the line width for this lineAttributes component object and sends a message notifying the interested structures of the change.
(package private)  void setPatternMask(int mask)
          Sets the pattern mask for this LineAttributes component object and sends a message notifying the interested structures of change.
(package private)  void setPatternScaleFactor(int scaleFactor)
          Sets the pattern mask scale factor for this LineAttributes component object and sends a message notifying the interested structures of change.
(package private)  void updateMirrorObject(int component, java.lang.Object value)
          Update the "component" field of the mirror object with the given "value"
(package private)  void updateNative(Context ctx)
          This method updates the native context.
 
Methods inherited from class javax.media.j3d.NodeComponentRetained
addAMirrorUser, addUser, clearLive, clone, copyMirrorUsers, decRefCnt, doSetLive, getDuplicateOnCloneTree, getInImmCtx, incRefCnt, notifyUsers, removeAMirrorUser, removeMirrorUsers, removeUser, set, setDuplicateOnCloneTree, setFrequencyChangeMask, setInImmCtx, setLive
 
Methods inherited from class javax.media.j3d.SceneGraphObjectRetained
clearLive, clearLive, compile, doSetLive, doSetLive, getSource, getVirtualUniverse, isInSetLive, isStatic, markAsLive, merge, mergeTransform, setCompiled, setLive, setLive, setSource, traverse
 
Methods inherited from class javax.media.j3d.IndexedObject
getIdxUsed, incIdxUsed
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LINE_WIDTH_CHANGED

static final int LINE_WIDTH_CHANGED
See Also:
Constant Field Values

LINE_PATTERN_CHANGED

static final int LINE_PATTERN_CHANGED
See Also:
Constant Field Values

LINE_AA_CHANGED

static final int LINE_AA_CHANGED
See Also:
Constant Field Values

LINE_PATTERN_MASK_CHANGED

static final int LINE_PATTERN_MASK_CHANGED
See Also:
Constant Field Values

LINE_PATTERN_SCALEFACTOR_CHANGED

static final int LINE_PATTERN_SCALEFACTOR_CHANGED
See Also:
Constant Field Values

lineWidth

float lineWidth

linePattern

int linePattern

lineAntialiasing

boolean lineAntialiasing

linePatternMask

int linePatternMask

linePatternScaleFactor

int linePatternScaleFactor
Constructor Detail

LineAttributesRetained

LineAttributesRetained()
Method Detail

initLineWidth

final void initLineWidth(float lineWidth)
Sets the line width for this lineAttributes component object.

Parameters:
lineWidth - the width, in pixels, of line primitives

setLineWidth

final void setLineWidth(float lineWidth)
Sets the line width for this lineAttributes component object and sends a message notifying the interested structures of the change.

Parameters:
lineWidth - the width, in pixels, of line primitives

getLineWidth

final float getLineWidth()
Gets the line width for this lineAttributes component object.

Returns:
the width, in pixels, of line primitives

initLinePattern

final void initLinePattern(int linePattern)
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, or PATTERN_DASH_DOT

setLinePattern

final void setLinePattern(int linePattern)
Sets the line pattern for this lineAttributes component object and sends a message notifying the interested structures of the change.

Parameters:
linePattern - the line pattern to be used, one of: PATTERN_SOLID, PATTERN_DASH, PATTERN_DOT, or PATTERN_DASH_DOT

getLinePattern

final int getLinePattern()
Gets the line pattern for this lineAttributes component object.

Returns:
the line pattern

initLineAntialiasingEnable

final void initLineAntialiasingEnable(boolean state)
Enables or disables line antialiasing for this lineAttributes component object and sends a message notifying the interested structures of the change.

Parameters:
state - true or false to enable or disable line antialiasing

setLineAntialiasingEnable

final void setLineAntialiasingEnable(boolean state)
Enables or disables line antialiasing for this lineAttributes component object and sends a message notifying the interested structures of the change.

Parameters:
state - true or false to enable or disable line antialiasing

getLineAntialiasingEnable

final boolean getLineAntialiasingEnable()
Retrieves the state of the line antialiasing flag.

Returns:
true if line antialiasing is enabled, false if line antialiasing is disabled

initPatternMask

final void initPatternMask(int mask)
Sets the pattern mask for this LineAttributes component object. This is used when the linePattern attribute is set to PATTERN_USER_DEFINED.

Parameters:
mask - the line pattern mask to be used.

setPatternMask

final void setPatternMask(int mask)
Sets the pattern mask for this LineAttributes component object and sends a message notifying the interested structures of change. This is used when the linePattern attribute is set to PATTERN_USER_DEFINED.

Parameters:
mask - the line pattern mask to be used.

getPatternMask

final int getPatternMask()
Retrieves the pattern mask for this LineAttributes component object.

Returns:
the user-defined pattern mask

initPatternScaleFactor

final void initPatternScaleFactor(int scaleFactor)
Sets the pattern mask scale factor for this LineAttributes component object. This is used when the linePattern attribute is set to PATTERN_USER_DEFINED.

Parameters:
scaleFactor - the scale factor of mask, clamp to [1, 15]

setPatternScaleFactor

final void setPatternScaleFactor(int scaleFactor)
Sets the pattern mask scale factor for this LineAttributes component object and sends a message notifying the interested structures of change. This is used when the linePattern attribute is set to PATTERN_USER_DEFINED.

Parameters:
scaleFactor - the scale factor of mask, clamp to [1, 15]

getPatternScaleFactor

final int getPatternScaleFactor()
Retrieves the pattern scale factor for this LineAttributes component object.

Returns:
the pattern mask scale factor

createMirrorObject

void createMirrorObject()
Creates and initializes a mirror object, point the mirror object to the retained object if the object is not editable

Overrides:
createMirrorObject in class NodeComponentRetained

updateNative

void updateNative(Context ctx)
This method updates the native context.


initMirrorObject

void initMirrorObject()
Initializes a mirror object, point the mirror object to the retained object if the object is not editable

Overrides:
initMirrorObject in class NodeComponentRetained

updateMirrorObject

void updateMirrorObject(int component,
                        java.lang.Object value)
Update the "component" field of the mirror object with the given "value"

Overrides:
updateMirrorObject in class NodeComponentRetained

equivalent

boolean equivalent(LineAttributesRetained lr)

set

protected void set(LineAttributesRetained lr)

sendMessage

final void sendMessage(int attrMask,
                       java.lang.Object attr)

handleFrequencyChange

void handleFrequencyChange(int bit)
Overrides:
handleFrequencyChange in class SceneGraphObjectRetained


Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.