com.esri.arcgis.geometry

Interface IMultiPatch

All Superinterfaces:

IGeometry, java.io.Serializable

All Known Subinterfaces:

IMultiPatch2

All Known Implementing Classes:

IMultiPatch2Proxy, IMultiPatchProxy, MultiPatch

public interface IMultiPatch
extends IGeometry, java.io.Serializable

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

Description: 'Provides access to members that identify a MultiPatch and permit controlled access to its parts.' 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	IIDf3c041c8_ae4d_11d2_9c93_00c04fb17838
static int	xxDummy Deprecated. Internal use only

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

IID1b07790d_38c5_11d0_92d2_00805f7c28b0

Method Summary

Modifier and Type	Method and Description
IRing	findBeginningRing(IRing followingRing) Returns the beginning ring of the ring group containing the specified following ring.
int	getBeginningRingCount(int ringTypesDesired) The number of beginning rings, counting only those of the desired types.
int	getFollowingRingCount(IRing beginningRing) The number of following rings in the ring group that starts with the specified beginning ring.
int	getRingType(IRing queryRing, boolean[] isBeginningRing) Gets the esriMultiPatchRingType of the input Ring and returns a boolean indicating if that ring is a beginning ring.
IGeometry	getXYFootprint() A reference to a cached copy of the multipatch's footprint in the x-y plane.
void	invalXYFootprint() Notifies the multipatch that its cached footprint has been modified by an outside agent.
void	putRingType(IRing queryRing, int ringType) Defines the type of the input Ring.
void	queryBeginningRings(int ringTypesDesired, int numBeginningRingsRequested, IRing[] beginningRings) Populates an array with references to all beginning rings of the specified types.
void	queryFollowingRings(IRing beginningRing, int numFollowingRingsRequested, IRing[] followingRings) Populates an array with references to following rings that are in the ring group that starts with the specified beginning ring.

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

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Field Detail

IIDf3c041c8_ae4d_11d2_9c93_00c04fb17838

static final int IIDf3c041c8_ae4d_11d2_9c93_00c04fb17838

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

findBeginningRing

IRing findBeginningRing(IRing followingRing)
                 throws java.io.IOException,
                        AutomationException

Returns the beginning ring of the ring group containing the specified following ring.

Parameters:

followingRing - A reference to a com.esri.arcgis.geometry.IRing (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBeginningRingCount

int getBeginningRingCount(int ringTypesDesired)
                   throws java.io.IOException,
                          AutomationException

The number of beginning rings, counting only those of the desired types.

Parameters:

ringTypesDesired - The ringTypesDesired (in)

Returns:

The beginningRingCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBeginningRings

void queryBeginningRings(int ringTypesDesired,
                         int numBeginningRingsRequested,
                         IRing[] beginningRings)
                  throws java.io.IOException,
                         AutomationException

Populates an array with references to all beginning rings of the specified types. This method is intended for internal use only.

Parameters:

ringTypesDesired - The ringTypesDesired (in)

numBeginningRingsRequested - The numBeginningRingsRequested (in)

beginningRings - A reference to a com.esri.arcgis.geometry.IRing (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowingRingCount

int getFollowingRingCount(IRing beginningRing)
                   throws java.io.IOException,
                          AutomationException

The number of following rings in the ring group that starts with the specified beginning ring.

Parameters:

beginningRing - A reference to a com.esri.arcgis.geometry.IRing (in)

Returns:

The followingRingCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFollowingRings

void queryFollowingRings(IRing beginningRing,
                         int numFollowingRingsRequested,
                         IRing[] followingRings)
                  throws java.io.IOException,
                         AutomationException

Populates an array with references to following rings that are in the ring group that starts with the specified beginning ring. This method is intended for internal use only.

Parameters:

beginningRing - A reference to a com.esri.arcgis.geometry.IRing (in)

numFollowingRingsRequested - The numFollowingRingsRequested (in)

followingRings - A reference to a com.esri.arcgis.geometry.IRing (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRingType

int getRingType(IRing queryRing,
                boolean[] isBeginningRing)
         throws java.io.IOException,
                AutomationException

Gets the esriMultiPatchRingType of the input Ring and returns a boolean indicating if that ring is a beginning ring.

Parameters:

queryRing - A reference to a com.esri.arcgis.geometry.IRing (in)

isBeginningRing - The isBeginningRing (in/out: use single element array)

Returns:

A com.esri.arcgis.geometry.esriMultiPatchRingType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putRingType

void putRingType(IRing queryRing,
                 int ringType)
          throws java.io.IOException,
                 AutomationException

Defines the type of the input Ring.

Parameters:

queryRing - A reference to a com.esri.arcgis.geometry.IRing (in)

ringType - A com.esri.arcgis.geometry.esriMultiPatchRingType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXYFootprint

IGeometry getXYFootprint()
                  throws java.io.IOException,
                         AutomationException

A reference to a cached copy of the multipatch's footprint in the x-y plane. If the footprint is modified, InvalXYFootprint should be called.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

invalXYFootprint

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

Notifies the multipatch that its cached footprint has been modified by an outside agent. The footprint will be recalculated the next time it is requested.

Throws:

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

AutomationException - If the ArcObject component throws an exception.