org.scijava.java3d

Class AlternateAppearance

java.lang.Object

org.scijava.java3d.SceneGraphObject

org.scijava.java3d.Node

org.scijava.java3d.Leaf

org.scijava.java3d.AlternateAppearance

public class AlternateAppearance
extends Leaf

The AlternateAppearance leaf node is used for overriding the Appearance component of selected nodes. It defines an Appearance component object and a region of influence in which this AlternateAppearance node is active. An AlternateAppearance node also contains a list of Group nodes that specifies the hierarchical scope of this AlternateAppearance. If the scope list is empty, then the AlternateAppearance node has universe scope: all nodes within the region of influence are affected by this AlternateAppearance node. If the scope list is non-empty, then only those Leaf nodes under the Group nodes in the scope list are affected by this AlternateAppearance node (subject to the influencing bounds).

An AlternateAppearance node affects Shape3D and Morph nodes by overriding their appearance component with the appearance component in this AlternateAppearance node. Only those Shape3D and Morph nodes that explicitly allow their appearance to be overridden are affected. The AlternateAppearance node has no effect on Shape3D and Morph nodes that do not allow their appearance to be overridden.

If the regions of influence of multiple AlternateAppearance nodes overlap, the Java 3D system will choose a single alternate appearance for those objects that lie in the intersection. This is done in an implementation-dependent manner, but in general, the AlternateAppearance node that is "closest" to the object is chosen.

Since:

Java 3D 1.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_APPEARANCE_READ Specifies that this AlternateAppearance node allows read access to its appearance information.
static int	ALLOW_APPEARANCE_WRITE Specifies that this AlternateAppearance node allows write access to its appearance information.
static int	ALLOW_INFLUENCING_BOUNDS_READ Specifies that this AlternateAppearance node allows read access to its influencing bounds and bounds leaf information.
static int	ALLOW_INFLUENCING_BOUNDS_WRITE Specifies that this AlternateAppearance node allows write access to its influencing bounds and bounds leaf information.
static int	ALLOW_SCOPE_READ Specifies that this AlternateAppearance node allows read access to its scope information at runtime.
static int	ALLOW_SCOPE_WRITE Specifies that this AlternateAppearance node allows write access to its scope information at runtime.

Fields inherited from class org.scijava.java3d.Node

ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

Constructors

Constructor and Description
AlternateAppearance() Constructs an AlternateAppearance node with default parameters.
AlternateAppearance(Appearance appearance) Constructs an AlternateAppearance node with the specified appearance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addScope(Group scope) Appends the specified Group node to this AlternateAppearance node's list of scopes.
Node	cloneNode(boolean forceDuplicate) Used to create a new instance of the node.
Enumeration<Group>	getAllScopes() Returns an enumeration of this AlternateAppearance node's list of scopes.
Appearance	getAppearance() Retrieves the appearance from this AlternateAppearance node.
BoundingLeaf	getInfluencingBoundingLeaf() Retrieves the AlternateAppearance node's influencing bounding leaf.
Bounds	getInfluencingBounds() Retrieves the AlternateAppearance node's influencing bounds.
Group	getScope(int index) Retrieves the Group node at the specified index from this AlternateAppearance node's list of scopes.
int	indexOfScope(Group scope) Retrieves the index of the specified Group node in this AlternateAppearance node's list of scopes.
void	insertScope(Group scope, int index) Inserts the specified Group node into this AlternateAppearance node's list of scopes at the specified index.
int	numScopes() Returns the number of nodes in this AlternateAppearance node's list of scopes.
void	removeAllScopes() Removes all Group nodes from this AlternateAppearance node's list of scopes.
void	removeScope(Group scope) Removes the specified Group node from this AlternateAppearance node's list of scopes.
void	removeScope(int index) Removes the node at the specified index from this AlternateAppearance node's list of scopes.
void	setAppearance(Appearance appearance) Sets the appearance of this AlternateAppearance node.
void	setInfluencingBoundingLeaf(BoundingLeaf region) Sets the AlternateAppearance's influencing region to the specified bounding leaf.
void	setInfluencingBounds(Bounds region) Sets the AlternateAppearance's influencing region to the specified bounds.
void	setScope(Group scope, int index) Replaces the node at the specified index in this AlternateAppearance node's list of scopes with the specified Group node.
void	updateNodeReferences(NodeReferenceTable referenceTable) Callback used to allow a node to check if any nodes referenced by that node have been duplicated via a call to cloneTree.

Methods inherited from class org.scijava.java3d.Node

cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class org.scijava.java3d.SceneGraphObject

clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALLOW_INFLUENCING_BOUNDS_READ

public static final int ALLOW_INFLUENCING_BOUNDS_READ

Specifies that this AlternateAppearance node allows read access to its influencing bounds and bounds leaf information.

See Also:

Constant Field Values

ALLOW_INFLUENCING_BOUNDS_WRITE

public static final int ALLOW_INFLUENCING_BOUNDS_WRITE

Specifies that this AlternateAppearance node allows write access to its influencing bounds and bounds leaf information.

See Also:

Constant Field Values

ALLOW_APPEARANCE_READ

public static final int ALLOW_APPEARANCE_READ

Specifies that this AlternateAppearance node allows read access to its appearance information.

See Also:

Constant Field Values

ALLOW_APPEARANCE_WRITE

public static final int ALLOW_APPEARANCE_WRITE

Specifies that this AlternateAppearance node allows write access to its appearance information. information.

See Also:

Constant Field Values

ALLOW_SCOPE_READ

public static final int ALLOW_SCOPE_READ

Specifies that this AlternateAppearance node allows read access to its scope information at runtime.

See Also:

Constant Field Values

ALLOW_SCOPE_WRITE

public static final int ALLOW_SCOPE_WRITE

Specifies that this AlternateAppearance node allows write access to its scope information at runtime.

See Also:

Constant Field Values

Constructor Detail

AlternateAppearance

public AlternateAppearance()

Constructs an AlternateAppearance node with default parameters. The default values are as follows:

appearance : null
scope : empty (universe scope)
influencing bounds : null
influencing bounding leaf : null

AlternateAppearance

public AlternateAppearance(Appearance appearance)

Constructs an AlternateAppearance node with the specified appearance.

Parameters:

appearance - the appearance that is used for those nodes affected by this AlternateAppearance node.

Method Detail

setAppearance

public void setAppearance(Appearance appearance)

Sets the appearance of this AlternateAppearance node. This appearance overrides the appearance in those Shape3D and Morph nodes affected by this AlternateAppearance node.

Parameters:

appearance - the new appearance.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getAppearance

public Appearance getAppearance()

Retrieves the appearance from this AlternateAppearance node.

Returns:

the current appearance.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setInfluencingBounds

public void setInfluencingBounds(Bounds region)

Sets the AlternateAppearance's influencing region to the specified bounds. This is used when the influencing bounding leaf is set to null.

Parameters:

region - the bounds that contains the AlternateAppearance's new influencing region.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getInfluencingBounds

public Bounds getInfluencingBounds()

Retrieves the AlternateAppearance node's influencing bounds.

Returns:

this AlternateAppearance's influencing bounds information

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setInfluencingBoundingLeaf

public void setInfluencingBoundingLeaf(BoundingLeaf region)

Sets the AlternateAppearance's influencing region to the specified bounding leaf. When set to a value other than null, this overrides the influencing bounds object.

Parameters:

region - the bounding leaf node used to specify the AlternateAppearance node's new influencing region.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

getInfluencingBoundingLeaf

public BoundingLeaf getInfluencingBoundingLeaf()

Retrieves the AlternateAppearance node's influencing bounding leaf.

Returns:

this AlternateAppearance's influencing bounding leaf information

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

setScope

public void setScope(Group scope,
            int index)

Replaces the node at the specified index in this AlternateAppearance node's list of scopes with the specified Group node. By default, AlternateAppearance nodes are scoped only by their influencing bounds. This allows them to be further scoped by a list of nodes in the hierarchy.

Parameters:

scope - the Group node to be stored at the specified index.

index - the index of the Group node to be replaced.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if the specified group node is part of a compiled scene graph

getScope

public Group getScope(int index)

Retrieves the Group node at the specified index from this AlternateAppearance node's list of scopes.

Parameters:

index - the index of the Group node to be returned.

Returns:

the Group node at the specified index.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

insertScope

public void insertScope(Group scope,
               int index)

Inserts the specified Group node into this AlternateAppearance node's list of scopes at the specified index. By default, AlternateAppearance nodes are scoped only by their influencing bounds. This allows them to be further scoped by a list of nodes in the hierarchy.

Parameters:

scope - the Group node to be inserted at the specified index.

index - the index at which the Group node is inserted.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if the specified group node is part of a compiled scene graph

removeScope

public void removeScope(int index)

Removes the node at the specified index from this AlternateAppearance node's list of scopes. If this operation causes the list of scopes to become empty, then this AlternateAppearance will have universe scope: all nodes within the region of influence will be affected by this AlternateAppearance node.

Parameters:

index - the index of the Group node to be removed.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if the group node at the specified index is part of a compiled scene graph

getAllScopes

public Enumeration<Group> getAllScopes()

Returns an enumeration of this AlternateAppearance node's list of scopes.

Returns:

an Enumeration object containing all nodes in this AlternateAppearance node's list of scopes.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

addScope

public void addScope(Group scope)

Appends the specified Group node to this AlternateAppearance node's list of scopes. By default, AlternateAppearance nodes are scoped only by their influencing bounds. This allows them to be further scoped by a list of nodes in the hierarchy.

Parameters:

scope - the Group node to be appended.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if the specified group node is part of a compiled scene graph

numScopes

public int numScopes()

Returns the number of nodes in this AlternateAppearance node's list of scopes. If this number is 0, then the list of scopes is empty and this AlternateAppearance node has universe scope: all nodes within the region of influence are affected by this AlternateAppearance node.

Returns:

the number of nodes in this AlternateAppearance node's list of scopes.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

indexOfScope

public int indexOfScope(Group scope)

Retrieves the index of the specified Group node in this AlternateAppearance node's list of scopes.

Parameters:

scope - the Group node to be looked up.

Returns:

the index of the specified Group node; returns -1 if the object is not in the list.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

Since:

Java 3D 1.3

removeScope

public void removeScope(Group scope)

Removes the specified Group node from this AlternateAppearance node's list of scopes. If the specified object is not in the list, the list is not modified. If this operation causes the list of scopes to become empty, then this AlternateAppearance will have universe scope: all nodes within the region of influence will be affected by this AlternateAppearance node.

Parameters:

scope - the Group node to be removed.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if the specified group node is part of a compiled scene graph

Since:

Java 3D 1.3

removeAllScopes

public void removeAllScopes()

Removes all Group nodes from this AlternateAppearance node's list of scopes. The AlternateAppearance node will then have universe scope: all nodes within the region of influence will be affected by this AlternateAppearance node.

Throws:

CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph

RestrictedAccessException - if any group node in this node's list of scopes is part of a compiled scene graph

Since:

Java 3D 1.3

updateNodeReferences

public void updateNodeReferences(NodeReferenceTable referenceTable)

Callback used to allow a node to check if any nodes referenced by that node have been duplicated via a call to cloneTree. This method is called by cloneTree after all nodes in the sub-graph have been duplicated. The cloned Leaf node's method will be called and the Leaf node can then look up any node references by using the getNewObjectReference method found in the NodeReferenceTable object. If a match is found, a reference to the corresponding Node in the newly cloned sub-graph is returned. If no corresponding reference is found, either a DanglingReferenceException is thrown or a reference to the original node is returned depending on the value of the allowDanglingReferences parameter passed in the cloneTree call.

NOTE: Applications should not call this method directly. It should only be called by the cloneTree method.

Overrides:

updateNodeReferences in class SceneGraphObject

Parameters:

referenceTable - a NodeReferenceTableObject that contains the getNewObjectReference method needed to search for new object instances.

See Also:

NodeReferenceTable, Node.cloneTree(), DanglingReferenceException

cloneNode

public Node cloneNode(boolean forceDuplicate)

Used to create a new instance of the node. This routine is called by cloneTree to duplicate the current node.

Overrides:

cloneNode in class Node

Parameters:

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(), Node.cloneNode(boolean), Node.duplicateNode(org.scijava.java3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)