javax.media.j3d
Class PointAttributes

java.lang.Object
  extended by javax.media.j3d.SceneGraphObject
      extended by javax.media.j3d.NodeComponent
          extended by javax.media.j3d.PointAttributes

public class PointAttributes
extends NodeComponent

The PointAttributes object defines all attributes that apply to point primitives. The point attributes that can be defined are:

If antialiasing is disabled (the default), fractional point sizes are rounded to integer sizes, and a screen-aligned square region of pixels is drawn.

If antialiasing is enabled, the points 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.

See Also:
Appearance, View

Field Summary
static int ALLOW_ANTIALIASING_READ
          Specifies that this PointAttributes object allows reading its point antialiasing flag.
static int ALLOW_ANTIALIASING_WRITE
          Specifies that this PointAttributes object allows writing its point antialiasing flag.
static int ALLOW_SIZE_READ
          Specifies that this PointAttributes object allows reading its point size information.
static int ALLOW_SIZE_WRITE
          Specifies that this PointAttributes object allows writing its point size information.
private static int[] readCapabilities
           
 
Fields inherited from class javax.media.j3d.NodeComponent
forceDuplicate
 
Fields inherited from class javax.media.j3d.SceneGraphObject
nodeHashtable, retained
 
Constructor Summary
PointAttributes()
          Constructs a PointAttributes object with default parameters.
PointAttributes(float pointSize, boolean pointAntialiasing)
          Constructs a PointAttributes object with specified values.
 
Method Summary
 NodeComponent cloneNodeComponent()
          Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate)
(package private)  void createRetained()
          Creates a retained mode PointAttributesRetained object that this PointAttributes component object will point to.
(package private)  void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
          Copies all node information from originalNodeComponent into the current node.
 boolean getPointAntialiasingEnable()
          Retrieves the state of the point antialiasing flag.
 float getPointSize()
          Gets the point size for this appearance component object.
 void setPointAntialiasingEnable(boolean state)
          Enables or disables point antialiasing for this appearance component object.
 void setPointSize(float pointSize)
          Sets the point size for this appearance component object.
 
Methods inherited from class javax.media.j3d.NodeComponent
checkDuplicateNodeComponent, cloneNodeComponent, duplicateChild, duplicateNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree, validateImageIllegalSharing
 
Methods inherited from class javax.media.j3d.SceneGraphObject
capabilityBitsEmpty, checkForLiveOrCompiled, clearCapability, clearCapabilityIsFrequent, clearLive, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getNamePrefix, getNodeComponent, getUserData, isCompiled, isLive, isLiveOrCompiled, setCapability, setCapabilityIsFrequent, setCompiled, setDefaultReadCapabilities, setLive, setName, setUserData, toString, updateNodeReferences
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALLOW_SIZE_READ

public static final int ALLOW_SIZE_READ
Specifies that this PointAttributes object allows reading its point size information.

See Also:
Constant Field Values

ALLOW_SIZE_WRITE

public static final int ALLOW_SIZE_WRITE
Specifies that this PointAttributes object allows writing its point size information.

See Also:
Constant Field Values

ALLOW_ANTIALIASING_READ

public static final int ALLOW_ANTIALIASING_READ
Specifies that this PointAttributes object allows reading its point antialiasing flag.

See Also:
Constant Field Values

ALLOW_ANTIALIASING_WRITE

public static final int ALLOW_ANTIALIASING_WRITE
Specifies that this PointAttributes object allows writing its point antialiasing flag.

See Also:
Constant Field Values

readCapabilities

private static final int[] readCapabilities
Constructor Detail

PointAttributes

public PointAttributes()
Constructs a PointAttributes object with default parameters. The default values are as follows:


PointAttributes

public PointAttributes(float pointSize,
                       boolean pointAntialiasing)
Constructs a PointAttributes object with specified values.

Parameters:
pointSize - the size of points, in pixels
pointAntialiasing - flag to set point antialising ON or OFF
Method Detail

setPointSize

public void setPointSize(float pointSize)
Sets the point size for this appearance component object.

Parameters:
pointSize - the size, in pixels, of point primitives
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getPointSize

public float getPointSize()
Gets the point size for this appearance component object.

Returns:
the size, in pixels, of point primitives
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setPointAntialiasingEnable

public void setPointAntialiasingEnable(boolean state)
Enables or disables point antialiasing for this appearance component object.

If antialiasing is enabled, the points 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 point antialiasing
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
See Also:
View

getPointAntialiasingEnable

public boolean getPointAntialiasingEnable()
Retrieves the state of the point antialiasing flag.

Returns:
true if point antialiasing is enabled, false if point antialiasing is disabled
Throws:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

createRetained

void createRetained()
Creates a retained mode PointAttributesRetained object that this PointAttributes component object will point to.

Overrides:
createRetained in class NodeComponent

cloneNodeComponent

public NodeComponent cloneNodeComponent()
Deprecated. replaced with cloneNodeComponent(boolean forceDuplicate)

Overrides:
cloneNodeComponent in class NodeComponent

duplicateAttributes

void duplicateAttributes(NodeComponent originalNodeComponent,
                         boolean forceDuplicate)
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).

Overrides:
duplicateAttributes in class NodeComponent
Parameters:
originalNodeComponent - the original node to duplicate.
forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.
See Also:
Node.cloneTree(), NodeComponent.setDuplicateOnCloneTree(boolean)


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