org.xith3d.scenegraph.traversal
Interface DetailedTraversalCallback

All Known Implementing Classes:
TreeCloner

public interface DetailedTraversalCallback

An implementation of this interface is passed to the traverse method of a Node to implement the traversal operation.


Method Summary
 boolean traversalCheckGroup(BranchGroup bg)
          This method is called for each group in the traversal.
 boolean traversalCheckGroup(Group group)
          This method is called for each group in the traversal.
 boolean traversalCheckGroup(OrderedGroup og)
          This method is called for each group in the traversal.
 boolean traversalCheckGroup(Switch sw)
          This method is called for each group in the traversal.
 boolean traversalCheckGroup(TransformGroup tg)
          This method is called for each group in the traversal.
 boolean traversalCheckGroupCommon(GroupNode group)
          This method is (certainly) called for each group in the traversal.
 boolean traversalOperation(BranchGroup bg)
          This method is called for each BranchGroup in the traversed Group.
 boolean traversalOperation(Fog fog)
          This method is called for each Light node in the traversed Group.
 boolean traversalOperation(Group group)
          This method is called for each Group in the traversed Group.
 boolean traversalOperation(Light light)
          This method is called for each Light node in the traversed Group.
 boolean traversalOperation(Node node)
          This method is called for each Node in the traversed Group.
 boolean traversalOperation(OrderedGroup og)
          This method is called for each OrderedGroup in the traversed Group.
 boolean traversalOperation(Shape3D shape)
          This method is called for each Node in the traversed Group.
 boolean traversalOperation(Sound sound)
          This method is called for each Sound node in the traversed Group.
 boolean traversalOperation(Switch sw)
          This method is called for each Node in the traversed Group.
 boolean traversalOperation(TransformGroup tg)
          This method is called for each TransformGroup in the traversed Group.
 boolean traversalOperationAfter(BranchGroup bg)
          This method is called for each BranchGroup in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Fog fog)
          This method is called for each Light node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Group group)
          This method is called for each Group in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Light light)
          This method is called for each Light node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Node node)
          This method is called for each Node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(OrderedGroup og)
          This method is called for each OrderedGroup in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Shape3D shape)
          This method is called for each Node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Sound sound)
          This method is called for each Sound node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(Switch sw)
          This method is called for each Node in the traversed Group after the Node has been worked on.
 boolean traversalOperationAfter(TransformGroup tg)
          This method is called for each TransformGroup in the traversed Group after the Node has been worked on.
 boolean traversalOperationCommon(GroupNode node)
          This method is (certainly) called for each Node in the traversed Group, which is a group itself.
 boolean traversalOperationCommon(Node node)
          This method is (certainly) called for each Node in the traversed Group, which is not a group itself.
 boolean traversalOperationCommonAfter(GroupNode group)
          This method is (certainly) called for each Group in the traversed Node, which is a Group itself after the Node has been worked on.
 boolean traversalOperationCommonAfter(Node node)
          This method is (certainly) called for each Node in the traversed Node, which is not a Group itself after the Node has been worked on.
 

Method Detail

traversalOperationCommon

boolean traversalOperationCommon(Node node)
This method is (certainly) called for each Node in the traversed Group, which is not a group itself. It implements the operation to be done for the Nodes.

Parameters:
node - the current Node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationCommon

boolean traversalOperationCommon(GroupNode node)
This method is (certainly) called for each Node in the traversed Group, which is a group itself. It implements the operation to be done for the Nodes.

Parameters:
node - the current Node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalCheckGroupCommon

boolean traversalCheckGroupCommon(GroupNode group)
This method is (certainly) called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
group - the Group to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalCheckGroup

boolean traversalCheckGroup(BranchGroup bg)
This method is called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
bg - the BranchGroup to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalCheckGroup

boolean traversalCheckGroup(Group group)
This method is called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
group - the Group to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalCheckGroup

boolean traversalCheckGroup(Switch sw)
This method is called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
sw - the Switch group to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalCheckGroup

boolean traversalCheckGroup(TransformGroup tg)
This method is called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
tg - the TransformGroup to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalCheckGroup

boolean traversalCheckGroup(OrderedGroup og)
This method is called for each group in the traversal. It must return true to be further traversed (and its children)

Parameters:
og - the OrderedGroup to be checked
Returns:
if false the traversal is not stopped, but the children are not further traversed

traversalOperation

boolean traversalOperation(Node node)
This method is called for each Node in the traversed Group. It implements the operation to be done for the Nodes.

Parameters:
node - the current Node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(BranchGroup bg)
This method is called for each BranchGroup in the traversed Group. It implements the operation to be done for the BranchGroups.

Parameters:
bg - the current BranchGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Group group)
This method is called for each Group in the traversed Group. It implements the operation to be done for the Groups.

Parameters:
group - the current Group in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(TransformGroup tg)
This method is called for each TransformGroup in the traversed Group. It implements the operation to be done for the TransformGroups.

Parameters:
tg - the current TransformGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(OrderedGroup og)
This method is called for each OrderedGroup in the traversed Group. It implements the operation to be done for the OrderedGroups.

Parameters:
og - the current OrderedGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Switch sw)
This method is called for each Node in the traversed Group. It implements the operation to be done for the Nodes.

Parameters:
sw - the current Switch node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Shape3D shape)
This method is called for each Node in the traversed Group. It implements the operation to be done for the Nodes.

Parameters:
shape - the current Shape3D in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Light light)
This method is called for each Light node in the traversed Group. It implements the operation to be done for the Lights.

Parameters:
light - the current Light in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Fog fog)
This method is called for each Light node in the traversed Group. It implements the operation to be done for the Lights.

Parameters:
fog - the current Fog in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperation

boolean traversalOperation(Sound sound)
This method is called for each Sound node in the traversed Group. It implements the operation to be done for the Sound node.

Parameters:
sound - the current Sound node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationCommonAfter

boolean traversalOperationCommonAfter(Node node)
This method is (certainly) called for each Node in the traversed Node, which is not a Group itself after the Node has been worked on. It implements the operation to be done for the Groups.

Parameters:
node - the current node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationCommonAfter

boolean traversalOperationCommonAfter(GroupNode group)
This method is (certainly) called for each Group in the traversed Node, which is a Group itself after the Node has been worked on. It implements the operation to be done for the Groups.

Parameters:
group - the current GroupNode in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(BranchGroup bg)
This method is called for each BranchGroup in the traversed Group after the Node has been worked on. It implements the operation to be done for the BranchGroups.

Parameters:
bg - the current BranchGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Group group)
This method is called for each Group in the traversed Group after the Node has been worked on. It implements the operation to be done for the Groups.

Parameters:
group - the current Group in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(TransformGroup tg)
This method is called for each TransformGroup in the traversed Group after the Node has been worked on. It implements the operation to be done for the TransformGroups.

Parameters:
tg - the current TransformGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(OrderedGroup og)
This method is called for each OrderedGroup in the traversed Group after the Node has been worked on. It implements the operation to be done for the OrderedGroups.

Parameters:
og - the current OrderedGroup in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Node node)
This method is called for each Node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Nodes.

Parameters:
node - the current Node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Switch sw)
This method is called for each Node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Nodes.

Parameters:
sw - the current Switch node in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Shape3D shape)
This method is called for each Node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Nodes.

Parameters:
shape - the current Shape3D in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Light light)
This method is called for each Light node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Lights.

Parameters:
light - the current Light in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Fog fog)
This method is called for each Light node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Lights.

Parameters:
fog - the current Fog in the traversal
Returns:
if false, the traversal is stopped after this node

traversalOperationAfter

boolean traversalOperationAfter(Sound sound)
This method is called for each Sound node in the traversed Group after the Node has been worked on. It implements the operation to be done for the Sound node.

Parameters:
sound - the current Sound node in the traversal
Returns:
if false, the traversal is stopped after this node