com.esri.arcgis.geometry
Interface IRay

All Superinterfaces:
IGeometry, java.io.Serializable
All Known Subinterfaces:
IRay2
All Known Implementing Classes:
IRay2Proxy, IRayProxy, Ray

public interface IRay
extends IGeometry, java.io.Serializable

COM Interface 'IRay'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriGeometry.olb'

Description: 'Provides access to 3D Ray properties and methods. A ray has one endpoint (its origin) and continues infinitely in one direction.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID0cd38cba_1c89_11d4_9f5c_00c04f6bdf0d
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.geometry.IGeometry
IID1b07790d_38c5_11d0_92d2_00805f7c28b0
 
Method Summary
 IEnumIntersection getEnumIntersect(IGeometry targetGeometry)
          Not implemented at this release.
 IPoint getOrigin()
          The origin point of the ray.
 IPoint getPointAtDistance(double distance)
          Constructs a point at a distance along the ray.
 IVector3D getVector()
          The direction vector of the ray.
 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.
 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 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 setOrigin(IPoint vectorOrigin)
          The origin point of the ray.
 void setVector(IVector3D directionVector)
          The direction vector of the ray.
 
Methods inherited from interface com.esri.arcgis.geometry.IGeometry
geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference
 

Field Detail

IID0cd38cba_1c89_11d4_9f5c_00c04f6bdf0d

static final int IID0cd38cba_1c89_11d4_9f5c_00c04f6bdf0d
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

queryOrigin

void queryOrigin(IPoint vectorOrigin)
                 throws java.io.IOException,
                        AutomationException
Sets a point equal to the ray's origin.

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

IPoint getOrigin()
                 throws java.io.IOException,
                        AutomationException
The origin point of the ray.

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

void setOrigin(IPoint vectorOrigin)
               throws java.io.IOException,
                      AutomationException
The origin point of the ray.

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

void queryVector(IVector3D directionVector)
                 throws java.io.IOException,
                        AutomationException
Sets a vector equal to a unit vector with the same direction as the ray.

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

IVector3D getVector()
                    throws java.io.IOException,
                           AutomationException
The direction vector of the ray.

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

void setVector(IVector3D directionVector)
               throws java.io.IOException,
                      AutomationException
The direction vector of the ray.

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

void queryPointAtDistance(double distance,
                          IPoint point)
                          throws java.io.IOException,
                                 AutomationException
Queries a point at a distance along the ray.

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

IPoint getPointAtDistance(double distance)
                          throws java.io.IOException,
                                 AutomationException
Constructs a point at a distance along the ray.

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

boolean intersects(IGeometry targetGeometry)
                   throws java.io.IOException,
                          AutomationException
Indicates if the ray intersects the target geometry.

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

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.

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

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.

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

IEnumIntersection getEnumIntersect(IGeometry targetGeometry)
                                   throws java.io.IOException,
                                          AutomationException
Not implemented at this release.

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.