com.esri.arcgis.geometry

Class Vector3D

java.lang.Object

com.esri.arcgis.geometry.Vector3D

All Implemented Interfaces:

IVector, IVector3D, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, java.io.Serializable

public class Vector3D
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IVector, IVector3D, IClone, ISupportErrorInfo

COM Class 'Vector3D'. Generated 4/9/2024 11:09:17 AM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description 'A 3D vector containing dx, dy, and dz components.' 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.IVector3D

IID, IIDb3fa5971_ada3_11d2_9fae_00c04f8ece3d, xxDummy

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

IID40d717c9_10c2_11d4_9f59_00c04f6bdf0d

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
Vector3D() Constructs a Vector3D using ArcGIS Engine.
Vector3D(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Vector3D theVector3D = (Vector3D) obj;

Method Summary

Modifier and Type	Method and Description
IVector	addVector(IVector otherVector) Construct a new vector by adding a different vector to this vector.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	constructAddVector(IVector vector1, IVector vector2) Set this vector by adding two input vectors.
void	constructCrossProduct(IVector vector1, IVector vector2) Set this vector equal to the cross product of the two input vectors.
void	constructDifference(IPoint point1, IPoint point2) Set the vector by taking the difference of point1 and point2 (so the vector would go from point2 to point1).
void	constructSubtractVector(IVector vector1, IVector vector2) Set this vector by subtracting the second input vector from the first one.
IVector	crossProduct(IVector otherVector) Returns the cross product of this vector and another vector.
double	dotProduct(IVector otherVector) Returns the dot product of this vector and another vector.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
double	getAzimuth() The vector's azimuth angle in radians.
static java.lang.String	getClsid() getClsid.
double	getComponentByIndex(int componentIndex) The component corresponding to a given index.
int	getDimension() The dimension of this vector.
double	getInclination() The vector's inclination in radians.
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.
double	getMagnitude() The length of the vector.
double	getXComponent() The vector's X component.
double	getYComponent() The vector's Y component.
double	getZComponent() The vector's Z component.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEmpty() Indicates if the vector is empty (unset).
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	move(double dx, double dy, double dz) Move the vector by adding a shift value to each component.
void	normalize() Normalize the vector (scale it to magnitude = 1).
void	polarMove(double dAzimuth, double dInclination, double dRadius) Modify the vector by adding to its polar components.
void	polarQuery(double[] azimuth, double[] inclination, double[] radiusLength) Get the vector's polar components.
void	polarSet(double azimuth, double inclination, double radiusLength) Set the vector using polar components.
void	queryComponents(double[] dx, double[] dy, double[] dz) Get the values of the vector's components.
void	release() Release this COM object reference
void	rotate(double angle, IVector3D axis) Rotate the vector around an axis defined by another vector.
void	scale(double scaleFactor) Scale the vector by the given factor.
void	setAzimuth(double azimuth) The vector's azimuth angle in radians.
void	setComponentByIndex(int componentIndex, double componentValue) The component corresponding to a given index.
void	setComponents(double dx, double dy, double dz) Set the values of the vector's components.
void	setEmpty() Makes the vector empty (unset).
void	setInclination(double inclination) The vector's inclination in radians.
void	setMagnitude(double magnitude) The length of the vector.
void	setXComponent(double dx) The vector's X component.
void	setYComponent(double dy) The vector's Y component.
void	setZComponent(double dz) The vector's Z component.
IVector	subtractVector(IVector otherVector) Construct a new vector by subtracting a different vector from this vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

Vector3D

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

Constructs a Vector3D using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Vector3D

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

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

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

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

getDimension

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

The dimension of this vector.

Specified by:

getDimension in interface IVector

Returns:

The dimension

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 if the vector is empty (unset).

Specified by:

isEmpty in interface IVector

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

Makes the vector empty (unset).

Specified by:

setEmpty in interface IVector

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getComponentByIndex

public double getComponentByIndex(int componentIndex)
                           throws java.io.IOException,
                                  AutomationException

The component corresponding to a given index.

Specified by:

getComponentByIndex in interface IVector

Parameters:

componentIndex - The componentIndex (in)

Returns:

The componentValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComponentByIndex

public void setComponentByIndex(int componentIndex,
                                double componentValue)
                         throws java.io.IOException,
                                AutomationException

The component corresponding to a given index.

Specified by:

setComponentByIndex in interface IVector

Parameters:

componentIndex - The componentIndex (in)

componentValue - The componentValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMagnitude

public double getMagnitude()
                    throws java.io.IOException,
                           AutomationException

The length of the vector.

Specified by:

getMagnitude in interface IVector

Returns:

The magnitude

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMagnitude

public void setMagnitude(double magnitude)
                  throws java.io.IOException,
                         AutomationException

The length of the vector.

Specified by:

setMagnitude in interface IVector

Parameters:

magnitude - The magnitude (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

normalize

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

Normalize the vector (scale it to magnitude = 1).

Specified by:

normalize in interface IVector

Throws:

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

AutomationException - If the ArcObject component throws an exception.

scale

public void scale(double scaleFactor)
           throws java.io.IOException,
                  AutomationException

Scale the vector by the given factor.

Specified by:

scale in interface IVector

Parameters:

scaleFactor - The scaleFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addVector

public IVector addVector(IVector otherVector)
                  throws java.io.IOException,
                         AutomationException

Construct a new vector by adding a different vector to this vector.

Specified by:

addVector in interface IVector

Parameters:

otherVector - A reference to a com.esri.arcgis.geometry.IVector (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

subtractVector

public IVector subtractVector(IVector otherVector)
                       throws java.io.IOException,
                              AutomationException

Construct a new vector by subtracting a different vector from this vector.

Specified by:

subtractVector in interface IVector

Parameters:

otherVector - A reference to a com.esri.arcgis.geometry.IVector (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

constructAddVector

public void constructAddVector(IVector vector1,
                               IVector vector2)
                        throws java.io.IOException,
                               AutomationException

Set this vector by adding two input vectors.

Specified by:

constructAddVector in interface IVector

Parameters:

vector1 - A reference to a com.esri.arcgis.geometry.IVector (in)

vector2 - A reference to a com.esri.arcgis.geometry.IVector (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

constructSubtractVector

public void constructSubtractVector(IVector vector1,
                                    IVector vector2)
                             throws java.io.IOException,
                                    AutomationException

Set this vector by subtracting the second input vector from the first one.

Specified by:

constructSubtractVector in interface IVector

Parameters:

vector1 - A reference to a com.esri.arcgis.geometry.IVector (in)

vector2 - A reference to a com.esri.arcgis.geometry.IVector (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dotProduct

public double dotProduct(IVector otherVector)
                  throws java.io.IOException,
                         AutomationException

Returns the dot product of this vector and another vector.

Specified by:

dotProduct in interface IVector

Parameters:

otherVector - A reference to a com.esri.arcgis.geometry.IVector (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXComponent

public double getXComponent()
                     throws java.io.IOException,
                            AutomationException

The vector's X component.

Specified by:

getXComponent in interface IVector3D

Returns:

The dx

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXComponent

public void setXComponent(double dx)
                   throws java.io.IOException,
                          AutomationException

The vector's X component.

Specified by:

setXComponent in interface IVector3D

Parameters:

dx - The dx (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYComponent

public double getYComponent()
                     throws java.io.IOException,
                            AutomationException

The vector's Y component.

Specified by:

getYComponent in interface IVector3D

Returns:

The dy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYComponent

public void setYComponent(double dy)
                   throws java.io.IOException,
                          AutomationException

The vector's Y component.

Specified by:

setYComponent in interface IVector3D

Parameters:

dy - The dy (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZComponent

public double getZComponent()
                     throws java.io.IOException,
                            AutomationException

The vector's Z component.

Specified by:

getZComponent in interface IVector3D

Returns:

The dz

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZComponent

public void setZComponent(double dz)
                   throws java.io.IOException,
                          AutomationException

The vector's Z component.

Specified by:

setZComponent in interface IVector3D

Parameters:

dz - The dz (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInclination

public double getInclination()
                      throws java.io.IOException,
                             AutomationException

The vector's inclination in radians.

Specified by:

getInclination in interface IVector3D

Returns:

The inclination

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInclination

public void setInclination(double inclination)
                    throws java.io.IOException,
                           AutomationException

The vector's inclination in radians.

Specified by:

setInclination in interface IVector3D

Parameters:

inclination - The inclination (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAzimuth

public double getAzimuth()
                  throws java.io.IOException,
                         AutomationException

The vector's azimuth angle in radians.

Specified by:

getAzimuth in interface IVector3D

Returns:

The azimuth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAzimuth

public void setAzimuth(double azimuth)
                throws java.io.IOException,
                       AutomationException

The vector's azimuth angle in radians.

Specified by:

setAzimuth in interface IVector3D

Parameters:

azimuth - The azimuth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

move

public void move(double dx,
                 double dy,
                 double dz)
          throws java.io.IOException,
                 AutomationException

Move the vector by adding a shift value to each component.

Specified by:

move in interface IVector3D

Parameters:

dx - The dx (in)

dy - The dy (in)

dz - The dz (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryComponents

public void queryComponents(double[] dx,
                            double[] dy,
                            double[] dz)
                     throws java.io.IOException,
                            AutomationException

Get the values of the vector's components.

Specified by:

queryComponents in interface IVector3D

Parameters:

dx - The dx (out: use single element array)

dy - The dy (out: use single element array)

dz - The dz (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComponents

public void setComponents(double dx,
                          double dy,
                          double dz)
                   throws java.io.IOException,
                          AutomationException

Set the values of the vector's components.

Specified by:

setComponents in interface IVector3D

Parameters:

dx - The dx (in)

dy - The dy (in)

dz - The dz (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

constructDifference

public void constructDifference(IPoint point1,
                                IPoint point2)
                         throws java.io.IOException,
                                AutomationException

Set the vector by taking the difference of point1 and point2 (so the vector would go from point2 to point1).

Specified by:

constructDifference in interface IVector3D

Parameters:

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

point2 - 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.

rotate

public void rotate(double angle,
                   IVector3D axis)
            throws java.io.IOException,
                   AutomationException

Rotate the vector around an axis defined by another vector. The angle is in radians.

Specified by:

rotate in interface IVector3D

Parameters:

angle - The angle (in)

axis - 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.

polarSet

public void polarSet(double azimuth,
                     double inclination,
                     double radiusLength)
              throws java.io.IOException,
                     AutomationException

Set the vector using polar components. Angles are in radians.

Specified by:

polarSet in interface IVector3D

Parameters:

azimuth - The azimuth (in)

inclination - The inclination (in)

radiusLength - The radiusLength (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

polarQuery

public void polarQuery(double[] azimuth,
                       double[] inclination,
                       double[] radiusLength)
                throws java.io.IOException,
                       AutomationException

Get the vector's polar components. Angles are in radians.

Specified by:

polarQuery in interface IVector3D

Parameters:

azimuth - The azimuth (out: use single element array)

inclination - The inclination (out: use single element array)

radiusLength - The radiusLength (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

polarMove

public void polarMove(double dAzimuth,
                      double dInclination,
                      double dRadius)
               throws java.io.IOException,
                      AutomationException

Modify the vector by adding to its polar components. Angles are in radians.

Specified by:

polarMove in interface IVector3D

Parameters:

dAzimuth - The dAzimuth (in)

dInclination - The dInclination (in)

dRadius - The dRadius (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

crossProduct

public IVector crossProduct(IVector otherVector)
                     throws java.io.IOException,
                            AutomationException

Returns the cross product of this vector and another vector.

Specified by:

crossProduct in interface IVector3D

Parameters:

otherVector - A reference to a com.esri.arcgis.geometry.IVector (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

constructCrossProduct

public void constructCrossProduct(IVector vector1,
                                  IVector vector2)
                           throws java.io.IOException,
                                  AutomationException

Set this vector equal to the cross product of the two input vectors.

Specified by:

constructCrossProduct in interface IVector3D

Parameters:

vector1 - A reference to a com.esri.arcgis.geometry.IVector (in)

vector2 - A reference to a com.esri.arcgis.geometry.IVector (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.