com.esri.arcgis.geometry

Class Ray

java.lang.Object

com.esri.arcgis.geometry.Ray

All Implemented Interfaces:

IGeometry, IRay, IRay2, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, java.io.Serializable

public class Ray
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRay, IRay2, IGeometry, IClone, ISupportErrorInfo

COM Class 'Ray'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description 'A 3D ray that begins at a point and extends infinitely along a line in one direction only.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geometry.IRay2

IID, IID0c968eea_5de9_45db_b885_531a04738122, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IRay

IID0cd38cba_1c89_11d4_9f5c_00c04f6bdf0d

Fields inherited from interface com.esri.arcgis.geometry.IGeometry

IID1b07790d_38c5_11d0_92d2_00805f7c28b0

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Constructors

Constructor and Description
Ray() Constructs a Ray using ArcGIS Engine.
Ray(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Ray theRay = (Ray) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	geoNormalize() Shifts longitudes, if need be, into a continuous range of 360 degrees.
void	geoNormalizeFromLongitude(double longitude) Normalizes longitudes into a continuous range containing the longitude.
static java.lang.String	getClsid() getClsid.
int	getDimension() The topological dimension of this geometry.
IEnumIntersection	getEnumIntersect(IGeometry targetGeometry) Not implemented at this release.
IEnvelope	getEnvelope() Creates a copy of this geometry's envelope and returns it.
int	getGeometryType() The type of this geometry.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IPoint	getOrigin() The origin point of the ray.
IPoint	getPointAtDistance(double distance) Constructs a point at a distance along the ray.
ISpatialReference	getSpatialReference() The spatial reference associated with this geometry.
IVector3D	getVector() The direction vector of the ray.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	intersect(IGeometry targetGeometry, IPointCollection intersectionPoints) Returns a point collection containing all points of intersection, in order along the ray.
boolean	intersects(IGeometry targetGeometry) Indicates if the ray intersects the target geometry.
boolean	isEmpty() Indicates whether this geometry contains any points.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	project(ISpatialReference newReferenceSystem) Projects this geometry into a new spatial reference.
void	queryEnvelope(IEnvelope outEnvelope) Copies this geometry's envelope properties into the specified envelope.
void	queryFirstIntersection(IGeometry targetGeometry, IPoint intersectionPoint) Returns the first point of intersection between the ray and the target geometry.
void	queryOrigin(IPoint vectorOrigin) Sets a point equal to the ray's origin.
void	queryPlaneIntersection(_WKSPointZ pPlaneNormal, double d, IPoint pPoint) Returns the point of intersection between the ray and the target plane.
void	queryPointAtDistance(double distance, IPoint point) Queries a point at a distance along the ray.
void	queryVector(IVector3D directionVector) Sets a vector equal to a unit vector with the same direction as the ray.
void	release() Release this COM object reference
void	setEmpty() Removes all points from this geometry.
void	setOrigin(IPoint vectorOrigin) The origin point of the ray.
void	setSpatialReferenceByRef(ISpatialReference spatialRef) The spatial reference associated with this geometry.
void	setVector(IVector3D directionVector) The direction vector of the ray.
void	snapToSpatialReference() Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ray

public Ray()
    throws java.io.IOException,
           java.net.UnknownHostException

Constructs a Ray using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Ray

public Ray(java.lang.Object obj)
    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Ray theRay = (Ray) obj;

Construct a Ray using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Ray.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

queryOrigin

public void queryOrigin(IPoint vectorOrigin)
                 throws java.io.IOException,
                        AutomationException

Sets a point equal to the ray's origin.

Specified by:

queryOrigin in interface IRay

Parameters:

vectorOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigin

public IPoint getOrigin()
                 throws java.io.IOException,
                        AutomationException

The origin point of the ray.

Specified by:

getOrigin in interface IRay

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrigin

public void setOrigin(IPoint vectorOrigin)
               throws java.io.IOException,
                      AutomationException

The origin point of the ray.

Specified by:

setOrigin in interface IRay

Parameters:

vectorOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryVector

public void queryVector(IVector3D directionVector)
                 throws java.io.IOException,
                        AutomationException

Sets a vector equal to a unit vector with the same direction as the ray.

Specified by:

queryVector in interface IRay

Parameters:

directionVector - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVector

public IVector3D getVector()
                    throws java.io.IOException,
                           AutomationException

The direction vector of the ray.

Specified by:

getVector in interface IRay

Returns:

A reference to a com.esri.arcgis.geometry.IVector3D

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVector

public void setVector(IVector3D directionVector)
               throws java.io.IOException,
                      AutomationException

The direction vector of the ray.

Specified by:

setVector in interface IRay

Parameters:

directionVector - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPointAtDistance

public void queryPointAtDistance(double distance,
                                 IPoint point)
                          throws java.io.IOException,
                                 AutomationException

Queries a point at a distance along the ray.

Specified by:

queryPointAtDistance in interface IRay

Parameters:

distance - The distance (in)

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointAtDistance

public IPoint getPointAtDistance(double distance)
                          throws java.io.IOException,
                                 AutomationException

Constructs a point at a distance along the ray.

Specified by:

getPointAtDistance in interface IRay

Parameters:

distance - The distance (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersects

public boolean intersects(IGeometry targetGeometry)
                   throws java.io.IOException,
                          AutomationException

Indicates if the ray intersects the target geometry.

Specified by:

intersects in interface IRay

Parameters:

targetGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The intersectsTarget

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryFirstIntersection

public void queryFirstIntersection(IGeometry targetGeometry,
                                   IPoint intersectionPoint)
                            throws java.io.IOException,
                                   AutomationException

Returns the first point of intersection between the ray and the target geometry. The point is set empty if there is no intersection.

Specified by:

queryFirstIntersection in interface IRay

Parameters:

targetGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

intersectionPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

public void intersect(IGeometry targetGeometry,
                      IPointCollection intersectionPoints)
               throws java.io.IOException,
                      AutomationException

Returns a point collection containing all points of intersection, in order along the ray.

Specified by:

intersect in interface IRay

Parameters:

targetGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

intersectionPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnumIntersect

public IEnumIntersection getEnumIntersect(IGeometry targetGeometry)
                                   throws java.io.IOException,
                                          AutomationException

Not implemented at this release.

Specified by:

getEnumIntersect in interface IRay

Parameters:

targetGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnumIntersection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws java.io.IOException,
                           AutomationException

The type of this geometry.

Specified by:

getGeometryType in interface IGeometry

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimension

public int getDimension()
                 throws java.io.IOException,
                        AutomationException

The topological dimension of this geometry.

Specified by:

getDimension in interface IGeometry

Returns:

A com.esri.arcgis.geometry.esriGeometryDimension constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference associated with this geometry.

Specified by:

getSpatialReference in interface IGeometry

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference associated with this geometry.

Specified by:

setSpatialReferenceByRef in interface IGeometry

Parameters:

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates whether this geometry contains any points.

Specified by:

isEmpty in interface IGeometry

Returns:

The isEmpty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

public void setEmpty()
              throws java.io.IOException,
                     AutomationException

Removes all points from this geometry.

Specified by:

setEmpty in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryEnvelope

public void queryEnvelope(IEnvelope outEnvelope)
                   throws java.io.IOException,
                          AutomationException

Copies this geometry's envelope properties into the specified envelope.

Specified by:

queryEnvelope in interface IGeometry

Parameters:

outEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvelope

public IEnvelope getEnvelope()
                      throws java.io.IOException,
                             AutomationException

Creates a copy of this geometry's envelope and returns it.

Specified by:

getEnvelope in interface IGeometry

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

project

public void project(ISpatialReference newReferenceSystem)
             throws java.io.IOException,
                    AutomationException

Projects this geometry into a new spatial reference.

Specified by:

project in interface IGeometry

Parameters:

newReferenceSystem - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snapToSpatialReference

public void snapToSpatialReference()
                            throws java.io.IOException,
                                   AutomationException

Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.

Specified by:

snapToSpatialReference in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geoNormalize

public void geoNormalize()
                  throws java.io.IOException,
                         AutomationException

Shifts longitudes, if need be, into a continuous range of 360 degrees.

Specified by:

geoNormalize in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geoNormalizeFromLongitude

public void geoNormalizeFromLongitude(double longitude)
                               throws java.io.IOException,
                                      AutomationException

Normalizes longitudes into a continuous range containing the longitude. This method is obsolete.

Specified by:

geoNormalizeFromLongitude in interface IGeometry

Parameters:

longitude - The longitude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPlaneIntersection

public void queryPlaneIntersection(_WKSPointZ pPlaneNormal,
                                   double d,
                                   IPoint pPoint)
                            throws java.io.IOException,
                                   AutomationException

Returns the point of intersection between the ray and the target plane. The point is set empty if there is no intersection.

Specified by:

queryPlaneIntersection in interface IRay2

Parameters:

pPlaneNormal - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)

d - The d (in)

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.