# Class ModelClip

java.lang.Object
javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.ModelClip

public class ModelClip extends Leaf
The ModelClip leaf node defines a set of 6 arbitrary clipping planes in the virtual universe. The planes are specified in the local coordinate system of this node, and may be individually enabled or disabled. This node also specifies a region of influence in which this set of planes is active.

A ModelClip node also contains a list of Group nodes that specifies the hierarchical scope of this ModelClip. If the scope list is empty, then the ModelClip node has universe scope: all nodes within the region of influence are affected by this ModelClip 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 ModelClip node (subject to the influencing bounds).

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

The individual planes specify a half-space defined by the equation:

Ax + By + Cz + D invalid input: '<'= 0

where A, B, C, D are the parameters that specify the plane. The parameters are passed in the x, y, z, and w fields, respectively, of a Vector4d object. The intersection of the set of half-spaces corresponding to the enabled planes in this ModelClip node defines a region in which points are accepted. Points in this acceptance region will be rendered (subject to view clipping and other attributes). Points that are not in the acceptance region will not be rendered.

Since:
  Java 3D 1.2

## Field Summary

Fields
Modifier and Type
Field
Description
`static final int`
`ALLOW_ENABLE_READ`
Specifies that the ModelClip node allows read access to its enable flags at runtime.
`static final int`
`ALLOW_ENABLE_WRITE`
Specifies that the ModelClip node allows write access to its enable flags at runtime.
`static final int`
`ALLOW_INFLUENCING_BOUNDS_READ`
Specifies that the ModelClip node allows read access to its influencing bounds and bounding leaf at runtime.
`static final int`
`ALLOW_INFLUENCING_BOUNDS_WRITE`
Specifies that the ModelClip node allows write access to its influencing bounds and bounding leaf at runtime.
`static final int`
`ALLOW_PLANE_READ`
Specifies that the ModelClip node allows read access to its planes at runtime.
`static final int`
`ALLOW_PLANE_WRITE`
Specifies that the ModelClip node allows write access to its planes at runtime.
`static final int`
`ALLOW_SCOPE_READ`
Specifies that this ModelClip node allows read access to its scope information at runtime.
`static final int`
`ALLOW_SCOPE_WRITE`
Specifies that this ModelClip node allows write access to its scope information at runtime.

### Fields inherited from class 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
Description
`ModelClip()`
Constructs a ModelClip node with default parameters.
`ModelClip(javax.vecmath.Vector4d[] planes)`
Constructs a ModelClip node using the specified planes.
`ModelClip(javax.vecmath.Vector4d[] planes, boolean[] enables)`
Constructs a ModelClip node using the specified planes and enable flags.

## Method Summary

Modifier and Type
Method
Description
`void`
`addScope(Group scope)`
Appends the specified Group node to this ModelClip node's list of scopes.
`Node`
`cloneNode(boolean forceDuplicate)`
Used to create a new instance of the node.
`Enumeration`
`getAllScopes()`
Returns an enumeration of this ModelClip node's list of scopes.
`boolean`
`getEnable(int planeNum)`
Retrieves the specified enable flag from this ModelClip node.
`void`
`getEnables(boolean[] enables)`
Retrieves the per-plane enable flags from this ModelClip node.
`BoundingLeaf`
`getInfluencingBoundingLeaf()`
Retrieves the ModelClip node's influencing bounding leaf.
`Bounds`
`getInfluencingBounds()`
Retrieves the ModelClip node's influencing bounds.
`void`
`getPlane(int planeNum, javax.vecmath.Vector4d plane)`
Retrieves the specified clipping plane from this ModelClip node.
`void`
`getPlanes(javax.vecmath.Vector4d[] planes)`
Retrieves the clipping planes from this ModelClip node.
`Group`
`getScope(int index)`
Retrieves the Group node at the specified index from this ModelClip node's list of scopes.
`int`
`indexOfScope(Group scope)`
Retrieves the index of the specified Group node in this ModelClip node's list of scopes.
`void`
`insertScope(Group scope, int index)`
Inserts the specified Group node into this ModelClip node's list of scopes at the specified index.
`int`
`numScopes()`
Returns the number of nodes in this ModelClip node's list of scopes.
`void`
`removeAllScopes()`
Removes all Group nodes from this ModelClip node's list of scopes.
`void`
`removeScope(int index)`
Removes the node at the specified index from this ModelClip node's list of scopes.
`void`
`removeScope(Group scope)`
Removes the specified Group node from this ModelClip node's list of scopes.
`void`
`setEnable(int planeNum, boolean enable)`
Sets the specified enable flag of this ModelClip node.
`void`
`setEnables(boolean[] enables)`
Sets the per-plane enable flags of this ModelClip node to the specified values.
`void`
`setInfluencingBoundingLeaf(BoundingLeaf region)`
Set the ModelClip node's influencing region to the specified bounding leaf.
`void`
`setInfluencingBounds(Bounds region)`
Set the ModelClip node's influencing region to the specified bounds.
`void`
`setPlane(int planeNum, javax.vecmath.Vector4d plane)`
Sets the specified clipping plane of this ModelClip node.
`void`
`setPlanes(javax.vecmath.Vector4d[] planes)`
Sets the clipping planes of this ModelClip node to the specified planes.
`void`
`setScope(Group scope, int index)`
Replaces the node at the specified index in this ModelClip node's list of scopes with the specified Group node.
`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`.

### Methods inherited from class Node

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

### Methods inherited from class SceneGraphObject

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

### Methods inherited from class Object

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

## Field Details

### ALLOW_INFLUENCING_BOUNDS_READ

public static final int ALLOW_INFLUENCING_BOUNDS_READ
Specifies that the ModelClip node allows read access to its influencing bounds and bounding leaf at runtime.

See Also:
  - Constant Field Values

### ALLOW_INFLUENCING_BOUNDS_WRITE

public static final int ALLOW_INFLUENCING_BOUNDS_WRITE
Specifies that the ModelClip node allows write access to its influencing bounds and bounding leaf at runtime.

See Also:
  - Constant Field Values

### ALLOW_PLANE_READ

public static final int ALLOW_PLANE_READ
Specifies that the ModelClip node allows read access to its planes at runtime.

See Also:
  - Constant Field Values

### ALLOW_PLANE_WRITE

public static final int ALLOW_PLANE_WRITE
Specifies that the ModelClip node allows write access to its planes at runtime.

See Also:
  - Constant Field Values

### ALLOW_ENABLE_READ

public static final int ALLOW_ENABLE_READ
Specifies that the ModelClip node allows read access to its enable flags at runtime.

See Also:
  - Constant Field Values

### ALLOW_ENABLE_WRITE

public static final int ALLOW_ENABLE_WRITE
Specifies that the ModelClip node allows write access to its enable flags at runtime.

See Also:
  - Constant Field Values

### ALLOW_SCOPE_READ

public static final int ALLOW_SCOPE_READ
Specifies that this ModelClip 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 ModelClip node allows write access to its scope information at runtime.

See Also:
  - Constant Field Values

## Constructor Details

### ModelClip

public ModelClip()
Constructs a ModelClip node with default parameters. The default values are as follows:

planes[0] : x invalid input: '<'= 1 (1,0,0,-1)
planes[1] : -x invalid input: '<'= 1 (-1,0,0,-1)
planes[2] : y invalid input: '<'= 1 (0,1,0,-1)
planes[3] : -y invalid input: '<'= 1 (0,-1,0,-1)
planes[4] : z invalid input: '<'= 1 (0,0,1,-1)
planes[5] : -z invalid input: '<'= 1 (0,0,-1,-1)
enables : all planes enabled
scope : empty (universe scope)
influencing bounds : null
influencing bounding leaf : null

### ModelClip

public ModelClip(javax.vecmath.Vector4d[] planes)
Constructs a ModelClip node using the specified planes. The individual planes are copied into this node. All planes are enabled.

Parameters:
  `planes` - an array of 6 model clipping planes

### ModelClip

public ModelClip(javax.vecmath.Vector4d[] planes, boolean[] enables)
Constructs a ModelClip node using the specified planes and enable flags. The individual planes and enable flags are copied into this node.

Parameters:
  `planes` - an array of 6 model clipping planes
  `enables` - an array of 6 enable flags

## Method Details

### setInfluencingBounds

public void setInfluencingBounds(Bounds region)
Set the ModelClip node'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 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 ModelClip node's influencing bounds.

Returns:
  this node'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)
Set the ModelClip node'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 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 ModelClip node's influencing bounding leaf.

Returns:
  this node'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 ModelClip node's list of scopes with the specified Group node. By default, ModelClip 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 ModelClip 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 ModelClip node's list of scopes at the specified index. By default, ModelClip 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 ModelClip node's list of scopes. If this operation causes the list of scopes to become empty, then this ModelClip will have universe scope: all nodes within the region of influence will be affected by this ModelClip 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 getAllScopes()
Returns an enumeration of this ModelClip node's list of scopes.

Returns:
  an Enumeration object containing all nodes in this ModelClip 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 ModelClip node's list of scopes. By default, ModelClip 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 ModelClip node's list of scopes. If this number is 0, then the list of scopes is empty and this ModelClip node has universe scope: all nodes within the region of influence are affected by this ModelClip node.

Returns:
  the number of nodes in this ModelClip 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 ModelClip 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 ModelClip 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 ModelClip will have universe scope: all nodes within the region of influence will be affected by this ModelClip 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 ModelClip node's list of scopes. The ModelClip node will then have universe scope: all nodes within the region of influence will be affected by this ModelClip 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

### setPlanes

public void setPlanes(javax.vecmath.Vector4d[] planes)
Sets the clipping planes of this ModelClip node to the specified planes. The individual planes are copied into this node.

Parameters:
  `planes` - an array of 6 model clipping planes

### getPlanes

public void getPlanes(javax.vecmath.Vector4d[] planes)
Retrieves the clipping planes from this ModelClip node. The individual planes are copied into the specified planes, which must be allocated by the caller. The array must be large enough to hold all of the vectors.

Parameters:
  `planes` - an array of 6 vectors that will receive the model clipping planes from this node

### setPlane

public void setPlane(int planeNum, javax.vecmath.Vector4d plane)
Sets the specified clipping plane of this ModelClip node. The specified plane is copied into this node.

Parameters:
  `planeNum` - specifies which model clipping plane (0-5) is replaced
  `plane` - new model clipping plane

### getPlane

public void getPlane(int planeNum, javax.vecmath.Vector4d plane)
Retrieves the specified clipping plane from this ModelClip node. The plane is copied into the specified plane, which must be allocated by the caller.

Parameters:
  `planeNum` - specifies which model clipping plane (0-5) is retrieved
  `plane` - a vector that will receive the specified model clipping plane from this node

### setEnables

public void setEnables(boolean[] enables)
Sets the per-plane enable flags of this ModelClip node to the specified values.

Parameters:
  `enables` - an array of 6 enable flags

### getEnables

public void getEnables(boolean[] enables)
Retrieves the per-plane enable flags from this ModelClip node. The enable flags are copied into the specified array. The array must be large enough to hold all of the enables.

Parameters:
  `enables` - an array of 6 booleans that will receive the enable flags from this node

### setEnable

public void setEnable(int planeNum, boolean enable)
Sets the specified enable flag of this ModelClip node.

Parameters:
  `planeNum` - specifies which enable flag (0-5) is set
  `enable` - new enable flag

### getEnable

public boolean getEnable(int planeNum)
Retrieves the specified enable flag from this ModelClip node.

Parameters:
  `planeNum` - specifies which enable flag (0-5) is retrieved
Returns:
  the specified enable flag

### 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(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`