com.esri.arcgis.geometry

Interface IVector

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IVector3D

All Known Implementing Classes:

IVector3DProxy, IVectorProxy, Vector3D

public interface IVector
extends java.io.Serializable

COM Interface 'IVector'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description: 'Provides access to vector properties and operations.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID40d717c9_10c2_11d4_9f59_00c04f6bdf0d
static int	xxDummy Deprecated. Internal use only

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	constructAddVector(IVector vector1, IVector vector2) Set this vector by adding two input vectors.
void	constructSubtractVector(IVector vector1, IVector vector2) Set this vector by subtracting the second input vector from the first one.
double	dotProduct(IVector otherVector) Returns the dot product of this vector and another vector.
double	getComponentByIndex(int componentIndex) The component corresponding to a given index.
int	getDimension() The dimension of this vector.
double	getMagnitude() The length of the vector.
boolean	isEmpty() Indicates if the vector is empty (unset).
void	normalize() Normalize the vector (scale it to magnitude = 1).
void	scale(double scaleFactor) Scale the vector by the given factor.
void	setComponentByIndex(int componentIndex, double componentValue) The component corresponding to a given index.
void	setEmpty() Makes the vector empty (unset).
void	setMagnitude(double magnitude) The length of the vector.
IVector	subtractVector(IVector otherVector) Construct a new vector by subtracting a different vector from this vector.

Field Detail

IID40d717c9_10c2_11d4_9f59_00c04f6bdf0d

static final int IID40d717c9_10c2_11d4_9f59_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

getDimension

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

The dimension of this vector.

Returns:

The dimension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

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

Indicates if the vector is empty (unset).

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEmpty

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

Makes the vector empty (unset).

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getComponentByIndex

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

The component corresponding to a given index.

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

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

The component corresponding to a given index.

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

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

The length of the vector.

Returns:

The magnitude

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMagnitude

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

The length of the vector.

Parameters:

magnitude - The magnitude (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

normalize

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

scale

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

Scale the vector by the given factor.

Parameters:

scaleFactor - The scaleFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addVector

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

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

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

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

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

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

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

Set this vector by adding two input vectors.

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

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

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

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

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

Returns the dot product of this vector and another vector.

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.