vclip
Class Feature

java.lang.Object
  extended byvclip.Feature
Direct Known Subclasses:
Edge, Face, Vertex

public abstract class Feature
extends java.lang.Object

Base class for the features of a polyhedron.

Author:
Brian Mirtich (C++ version), Eddy Boxerman, John E. Lloyd (Java port)
See Also:
Copyright information

Field Summary
static int EDGE
          Identifier for an edge.
static int FACE
          Identifier for a face.
static int VERTEX
          Identifier for a vertex.
 
Constructor Summary
Feature()
           
 
Method Summary
 java.lang.String getName()
          Gets the specific name of this feature.
 int getType()
          Gets the type of this feature.
 boolean isHidden()
          Returns true if this feature is hidden.
 Feature promote(javax.vecmath.Vector3d nrm, double angtol)
           
 void setHidden(boolean hidden)
          Sets whether or not this feature is hidden.
 java.lang.String typeName()
          Gets the name of the type of this feature (either vertex, edge, face).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERTEX

public static final int VERTEX
Identifier for a vertex.

See Also:
Constant Field Values

EDGE

public static final int EDGE
Identifier for an edge.

See Also:
Constant Field Values

FACE

public static final int FACE
Identifier for a face.

See Also:
Constant Field Values
Constructor Detail

Feature

public Feature()
Method Detail

typeName

public java.lang.String typeName()
Gets the name of the type of this feature (either vertex, edge, face).

Returns:
type name of this feature

promote

public Feature promote(javax.vecmath.Vector3d nrm,
                       double angtol)

getName

public java.lang.String getName()
Gets the specific name of this feature.

Returns:
name of this feature

getType

public int getType()
Gets the type of this feature.

Returns:
type of this feature

setHidden

public void setHidden(boolean hidden)
Sets whether or not this feature is hidden. A hidden feature will not be added to distance reports.

Parameters:
hidden - true if the feature is to be hidden.
See Also:
isHidden()

isHidden

public boolean isHidden()
Returns true if this feature is hidden.

Returns:
true if the feature is hidden
See Also:
setHidden(boolean)