Field Detail

• ALLOW_APPLICATION_BOUNDS_READ

  public static final int ALLOW_APPLICATION_BOUNDS_READ

  Specifies that the Clip allows read access to its application bounds and bounding leaf at runtime.

  See Also:

  Constant Field Values

• ALLOW_APPLICATION_BOUNDS_WRITE

  public static final int ALLOW_APPLICATION_BOUNDS_WRITE

  Specifies that the Clip allows write access to its application bounds and bounding leaf at runtime.

  See Also:

  Constant Field Values

• ALLOW_BACK_DISTANCE_READ

  public static final int ALLOW_BACK_DISTANCE_READ

  Specifies that the Clip allows read access to its back distance at runtime.

  See Also:

  Constant Field Values

• ALLOW_BACK_DISTANCE_WRITE

  public static final int ALLOW_BACK_DISTANCE_WRITE

  Specifies that the Clip allows write access to its back distance at runtime.

  See Also:

  Constant Field Values

Constructor Detail

• Clip

  public Clip()

  Constructs a Clip node with default parameters. The default values are as follows:

  back clip distance : 100 meters application bounds : null
  application bounding leaf : null
  

• Clip

  public Clip(double backDistance)

  Constructs a Clip node with the specified back clip distance.

Method Detail

• setBackDistance

  public void setBackDistance(double backDistance)

  Sets the back clip distance to the specified value. There are several considerations that need to be taken into account when choosing values for the front and back clip distances. These are enumerated in the description of View.setFrontClipDistance.

  Parameters:

  backDistance - the new back clip distance in meters

  See Also:

  View.setFrontClipDistance(double), View.setBackClipDistance(double)

• getBackDistance

  public double getBackDistance()

  Retrieves the back clip distance.

  Returns:

  the current back clip distance, in meters

• setApplicationBounds

  public void setApplicationBounds(Bounds region)

  Set the Clip's application region to the specified bounds. This is used when the application bounding leaf is set to null.

  Parameters:

  region - the bounds that contains the Clip's new application region.

  Throws:

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

• getApplicationBounds

  public Bounds getApplicationBounds()

  Retrieves the Clip node's application bounds.

  Returns:

  this Clip's application bounds information

  Throws:

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

• setApplicationBoundingLeaf

  public void setApplicationBoundingLeaf(BoundingLeaf region)

  Set the Clip's application region to the specified bounding leaf. When set to a value other than null, this overrides the application bounds object.

  Parameters:

  region - the bounding leaf node used to specify the Clip node's new application region.

  Throws:

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

• getApplicationBoundingLeaf

  public BoundingLeaf getApplicationBoundingLeaf()

  Retrieves the Clip node's application bounding leaf.

  Returns:

  this Clip's application bounding leaf information

  Throws:

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

• 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)

• updateNodeReferences

  public void updateNodeReferences(NodeReferenceTable referenceTable)

  Callback used to allow a node to check if any scene graph objects 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 object references by using the getNewObjectReference method found in the NodeReferenceTable object. If a match is found, a reference to the corresponding object 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 object 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