com.hedgehog.geo
Class ProjectionType

java.lang.Object
  com.hedgehog.HObject
      com.hedgehog.geo.ProjectionType

All Implemented Interfaces:

java.lang.Comparable, java.util.Comparator

public class ProjectionType
extends HObject

Title: ProjectionType - indicates the type of projection.

Description: Indicates the type of projection.

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

Company: Hedgehog Software.

Since:

1.0

Version:

1.1

Field Summary

protected int	mProjectionType The projection type.
static int	OBLIQUE Indicates an oblique projection.
static int	ORTHOGRAPHIC Indicates a orthographic projection.
static int	ORTHOGRAPHIC_XY_PLANE Indicates an orthographic projection onto xy-plane.
static int	ORTHOGRAPHIC_XZ_PLANE Indicates an orthographic projection onto xz-plane.
static int	ORTHOGRAPHIC_YZ_PLANE Indicates an orthographic projection onto yz-plane.
static int	PERSPECTIVE Indicates a perspective projection.
static int	STEREOGRAPHIC Indicates a Stereographic projection.

Fields inherited from class com.hedgehog.HObject

mID, mName

Constructor Summary

ProjectionType()
Default constructor.

ProjectionType(int projectionType)
Constructor.

ProjectionType(ProjectionType object)
Copy constructor.

Method Summary

int	getProjectionType() Returns the projection type.
boolean	isObliqueProjection() Tests whether or not the projection type is OBLIQUE.
boolean	isOrthographicProjection() Tests whether or not the projection type is ORTHOGRAPHIC.
boolean	isOrthographicXYPlaneProjection() Tests whether or not the projection type is ORTHOGRAPHIC_XY_PLANE.
boolean	isOrthographicXZPlaneProjection() Tests whether or not the projection type is ORTHOGRAPHIC_XZ_PLANE.
boolean	isOrthographicYZPlaneProjection() Tests whether or not the projection type is ORTHOGRAPHIC_YZ_PLANE.
boolean	isPersectiveProjection() Tests whether or not the projection type is PERSPECTIVE.
boolean	isStereographicProjection() Tests whether or not the projection type is STEREOGRAPHIC.
static boolean	isValid(int projectionType) Tests whether or not the specified projection type is valid.
static java.lang.String	projectionTypeToString(int projectionType) Returns a string equivalent of the specifed projection type.
void	setProjectionType(int projectionType) Sets the projection type.
java.lang.String	toString() Returns a String representation of a ProjectionType object.

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, wait, wait, wait

Field Detail

mProjectionType

protected int mProjectionType

The projection type.

PERSPECTIVE

public static int PERSPECTIVE

Indicates a perspective projection.

OBLIQUE

public static int OBLIQUE

Indicates an oblique projection.

ORTHOGRAPHIC

public static int ORTHOGRAPHIC

Indicates a orthographic projection.

ORTHOGRAPHIC_XY_PLANE

public static int ORTHOGRAPHIC_XY_PLANE

Indicates an orthographic projection onto xy-plane.

ORTHOGRAPHIC_YZ_PLANE

public static int ORTHOGRAPHIC_YZ_PLANE

Indicates an orthographic projection onto yz-plane.

ORTHOGRAPHIC_XZ_PLANE

public static int ORTHOGRAPHIC_XZ_PLANE

Indicates an orthographic projection onto xz-plane.

STEREOGRAPHIC

public static int STEREOGRAPHIC

Indicates a Stereographic projection.

Constructor Detail

ProjectionType

public ProjectionType()

Default constructor. Sets the projection type to PERSPECTIVE.

ProjectionType

public ProjectionType(int projectionType)

Constructor.

Parameters:

projectionType - The projection type.

ProjectionType

public ProjectionType(ProjectionType object)

Copy constructor.

Parameters:

object - Object to copy.

Method Detail

getProjectionType

public int getProjectionType()

Returns the projection type.

Returns:

The projection type.

setProjectionType

public void setProjectionType(int projectionType)
                       throws java.lang.IllegalArgumentException

Sets the projection type.

Parameters:

projectionType - New projection type.

Throws:

java.lang.IllegalArgumentException - Thrown if the specified projection type is invalid.

isPersectiveProjection

public boolean isPersectiveProjection()

Tests whether or not the projection type is PERSPECTIVE.

Returns:

Logical-true if the projection type is PERSPECTIVE, else logical-false.

isObliqueProjection

public boolean isObliqueProjection()

Tests whether or not the projection type is OBLIQUE.

Returns:

Logical-true if the projection type is OBLIQUE, else logical-false.

isOrthographicProjection

public boolean isOrthographicProjection()

Tests whether or not the projection type is ORTHOGRAPHIC.

Returns:

Logical-true if the projection type is ORTHOGRAPHIC, else logical-false.

isOrthographicXYPlaneProjection

public boolean isOrthographicXYPlaneProjection()

Tests whether or not the projection type is ORTHOGRAPHIC_XY_PLANE.

Returns:

Logical-true if the projection type is ORTHOGRAPHIC_XY_PLANE, else logical-false.

isOrthographicYZPlaneProjection

public boolean isOrthographicYZPlaneProjection()

Tests whether or not the projection type is ORTHOGRAPHIC_YZ_PLANE.

Returns:

Logical-true if the projection type is ORTHOGRAPHIC_YZ_PLANE, else logical-false.

isOrthographicXZPlaneProjection

public boolean isOrthographicXZPlaneProjection()

Tests whether or not the projection type is ORTHOGRAPHIC_XZ_PLANE.

Returns:

Logical-true if the projection type is ORTHOGRAPHIC_XZ_PLANE, else logical-false.

isStereographicProjection

public boolean isStereographicProjection()

Tests whether or not the projection type is STEREOGRAPHIC.

Returns:

Logical-true if the projection type is STEREOGRAPHIC, else logical-false.

toString

public java.lang.String toString()

Returns a String representation of a ProjectionType object.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of a ProjectionType object.

isValid

public static boolean isValid(int projectionType)

Tests whether or not the specified projection type is valid.

Parameters:

projectionType - Projection type.

Returns:

Logical-true if the specified projection type is valid, else logical-false.

projectionTypeToString

public static java.lang.String projectionTypeToString(int projectionType)

Returns a string equivalent of the specifed projection type.

Parameters:

projectionType - Projection type.

Returns:

A string equivalent of the specifed projection type.