com.hedgehog.geo
Class GeometricObjectsType

java.lang.Object
  extended by com.hedgehog.HObject
      extended by com.hedgehog.geo.GeometricObjectsType
All Implemented Interfaces:
java.lang.Comparable, java.util.Comparator

public class GeometricObjectsType
extends HObject

Title: GeometricObjectsType - indicates a type of geometric object or objects.

Description: Indicates a type of geometric object or objects. It is extensively used by object-object intersection methods in indicating the type of intersection.

Copyright: Copyright (c) Hedgehog Software 2007-2009.

Company: Hedgehog Software

Since:
1.0
Version:
1.1

Field Summary
static int CIRCLE
          Indicates a circle object.
static int CIRCLES
          Indicates multiple circle objects.
static int CURVE
          Indicates a general curve object.
static int CURVES
          Indicates multiple general curve objects.
static int INFINITE_STRAIGHT_LINE
          Indicates an infinite straight-line object.
static int INFINITE_STRAIGHT_LINES
          Indicates multiple infinite straight-line objects.
static int NONE
          Indicates no geometric object(s).
static int PLANE
          Indicates a plane object.
static int POINT
          Indicates a point object.
static int POINTS
          Indicates multiple point objects.
static int POLYGON
          Indicates a polygon object.
static int POLYGONS
          Indicates multiple polygon objects.
static int POLYHEDRA
          Indicates multiple polyhedron objects.
static int POLYHEDRON
          Indicates a polyhedron object.
static int RAY
          Indicates a ray object.
static int RAYS
          Indicates multiple ray objects.
static int STRAIGHT_LINE_SEGMENT
          Indicates a straight-line segment object.
static int STRAIGHT_LINE_SEGMENTS
          Indicates multiple straight-line segment objects.
 
Fields inherited from class com.hedgehog.HObject
mID, mName
 
Method Summary
static java.lang.String geometricObjectsTypeToString(int objectsType)
          Returns a string equivalent of the specified geometric objects type.
static boolean isValid(int objectsType)
          Tests the validity of the specified objects type.
 
Methods inherited from class com.hedgehog.HObject
clone, compare, compareTo, copy, equals, getID, getName, hashCode, hasID, hasName, setID, setName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NONE

public static final int NONE
Indicates no geometric object(s).

See Also:
Constant Field Values

POINT

public static final int POINT
Indicates a point object.

See Also:
Constant Field Values

POINTS

public static final int POINTS
Indicates multiple point objects.

See Also:
Constant Field Values

CURVE

public static final int CURVE
Indicates a general curve object.

See Also:
Constant Field Values

CURVES

public static final int CURVES
Indicates multiple general curve objects.

See Also:
Constant Field Values

STRAIGHT_LINE_SEGMENT

public static final int STRAIGHT_LINE_SEGMENT
Indicates a straight-line segment object.

See Also:
Constant Field Values

STRAIGHT_LINE_SEGMENTS

public static final int STRAIGHT_LINE_SEGMENTS
Indicates multiple straight-line segment objects.

See Also:
Constant Field Values

INFINITE_STRAIGHT_LINE

public static final int INFINITE_STRAIGHT_LINE
Indicates an infinite straight-line object.

See Also:
Constant Field Values

INFINITE_STRAIGHT_LINES

public static final int INFINITE_STRAIGHT_LINES
Indicates multiple infinite straight-line objects.

See Also:
Constant Field Values

PLANE

public static final int PLANE
Indicates a plane object.

See Also:
Constant Field Values

POLYGON

public static final int POLYGON
Indicates a polygon object.

See Also:
Constant Field Values

POLYGONS

public static final int POLYGONS
Indicates multiple polygon objects.

See Also:
Constant Field Values

POLYHEDRON

public static final int POLYHEDRON
Indicates a polyhedron object.

See Also:
Constant Field Values

POLYHEDRA

public static final int POLYHEDRA
Indicates multiple polyhedron objects.

See Also:
Constant Field Values

CIRCLE

public static final int CIRCLE
Indicates a circle object.

See Also:
Constant Field Values

CIRCLES

public static final int CIRCLES
Indicates multiple circle objects.

See Also:
Constant Field Values

RAY

public static final int RAY
Indicates a ray object.

See Also:
Constant Field Values

RAYS

public static final int RAYS
Indicates multiple ray objects.

See Also:
Constant Field Values
Method Detail

isValid

public static boolean isValid(int objectsType)
Tests the validity of the specified objects type.

Parameters:
objectsType - Objects type.
Returns:
Logical-true if the specified objects type is valid, else logical-false.

geometricObjectsTypeToString

public static java.lang.String geometricObjectsTypeToString(int objectsType)
Returns a string equivalent of the specified geometric objects type.

Parameters:
objectsType - Intersection type.
Returns:
String equivalent of the specified geometric objects type.