com.esri.arcgis.geometry
Interface IGeneralMultiPatchInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
MultiPatch

public interface IGeneralMultiPatchInfo
extends Serializable

Interface to get infomation of a GeneralMultiPatch.

Remarks

Use this interface to obtain a multipatch's geometry information, including those of its geometry material, if any.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getIdCount()
          Get Id Count.
 int getMaterialColor(int index)
          Get material color.
 int getMaterialCount()
          Get Material Count.
 int getMaterialTextureBytesPerPixel(int index)
          Get Material texture bytes per pixel.
 int getMaterialTextureColumnCount(int index)
          Get Material texture column count.
 int getMaterialTexturePixelColor(int index, int row, int column)
          Get Material texture pixel color.
 int getMaterialTextureRowCount(int index)
          Get Material texture row count.
 int getMaterialTransparencyPercent(int index)
          Get transparency %, in range of 0 - 100
 int getMCount()
          Get M Count.
 int getNormalCount()
          Get Normal Count.
 int getPatchCount()
          Get Patch Count.
 double getPatchM(int patch, int index)
          Get M for patch at vertex index.
 int getPatchMaterialIndex(int patch)
          Get patch material index.
 int getPatchPriority(int patch)
          Get patch priority.
 _WKSPoint getPatchTextureVertex(int patch, int index)
          Get Texture WKSPoint for a patch at vertex index.
 int getPatchTextureVertexCount(int patch)
          Get texture vertex count for a patch.
 int getPatchType(int patch)
          Get patch type.
 _WKSPointZ getPatchVertex(int patch, int index)
          Get Point for patch at vertex index.
 int getPatchVertexCount(int patch)
          Get count of vertices in patch.
 int getPatchVertexID(int patch, int index)
          Get vertex Id for a patch at vertex index.
 int getTextureVertexCount()
          Get Texture Vertex Count.
 int getVertexCount()
          Get Vertex Count.
 boolean isMaterialCullBackface(int index)
          Get backface culling enabled,
 boolean isMaterialTextured(int index)
          Get Is Material textured.
 void queryPatchNormal(int patch, int index, IVector3D pNormal)
          Copies the Normal for patch at specified vertex index into the input vector.
 

Method Detail

getVertexCount

int getVertexCount()
                   throws IOException,
                          AutomationException
Get Vertex Count.

Description

Returns the total number of geometry vertices in the MultiPatch. This value is identical with the pointCount parameter passed to IGeneralMultiPatchCreator.Init() when constructing the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchCount

int getPatchCount()
                  throws IOException,
                         AutomationException
Get Patch Count.

Description

Returns the total number of Patches (TriangleStrip, TriangleFan, Triangles, Ring) in the MultiPatch. This value is identical with the partCount parameter passed to IGeneralMultiPatchCreator.Init() when constructing the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMCount

int getMCount()
              throws IOException,
                     AutomationException
Get M Count.

Description

Returns the total number of Ms defined in the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalCount

int getNormalCount()
                   throws IOException,
                          AutomationException
Get Normal Count.

Description

Returns the total number of Normals defined in the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextureVertexCount

int getTextureVertexCount()
                          throws IOException,
                                 AutomationException
Get Texture Vertex Count.

Description

Returns the total number of texture vertices defined in the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIdCount

int getIdCount()
               throws IOException,
                      AutomationException
Get Id Count.

Description

Returns the total number of IDs defined in the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialCount

int getMaterialCount()
                     throws IOException,
                            AutomationException
Get Material Count.

Description

Returns the total number of Geometry Materials in the MultiPatch. This value is identical with the IGeometryMaterialList.Count property of the list passed to IGeneralMultiPatchCreator.Init() when constructing the MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchVertexCount

int getPatchVertexCount(int patch)
                        throws IOException,
                               AutomationException
Get count of vertices in patch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchType

int getPatchType(int patch)
                 throws IOException,
                        AutomationException
Get patch type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
Returns:
A com.esri.arcgis.geometry.esriPatchType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchPriority

int getPatchPriority(int patch)
                     throws IOException,
                            AutomationException
Get patch priority.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
Returns:
The pPriority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchMaterialIndex

int getPatchMaterialIndex(int patch)
                          throws IOException,
                                 AutomationException
Get patch material index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
Returns:
The pIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchVertex

_WKSPointZ getPatchVertex(int patch,
                          int index)
                          throws IOException,
                                 AutomationException
Get Point for patch at vertex index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
index - The index (in)
Returns:
A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchM

double getPatchM(int patch,
                 int index)
                 throws IOException,
                        AutomationException
Get M for patch at vertex index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
index - The index (in)
Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryPatchNormal

void queryPatchNormal(int patch,
                      int index,
                      IVector3D pNormal)
                      throws IOException,
                             AutomationException
Copies the Normal for patch at specified vertex index into the input vector.

Description

Queries the Normal vector at the specified geometry vertex associated with the Patch located at the specified index.

Remarks

A Vector3D object must be instantiated before being passed as the normal parameter to this method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
index - The index (in)
pNormal - A reference to a com.esri.arcgis.geometry.IVector3D (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchTextureVertexCount

int getPatchTextureVertexCount(int patch)
                               throws IOException,
                                      AutomationException
Get texture vertex count for a patch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchTextureVertex

_WKSPoint getPatchTextureVertex(int patch,
                                int index)
                                throws IOException,
                                       AutomationException
Get Texture WKSPoint for a patch at vertex index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
index - The index (in)
Returns:
A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchVertexID

int getPatchVertexID(int patch,
                     int index)
                     throws IOException,
                            AutomationException
Get vertex Id for a patch at vertex index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
patch - The patch (in)
index - The index (in)
Returns:
The pId
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialColor

int getMaterialColor(int index)
                     throws IOException,
                            AutomationException
Get material color.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pColor (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialTransparencyPercent

int getMaterialTransparencyPercent(int index)
                                   throws IOException,
                                          AutomationException
Get transparency %, in range of 0 - 100

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pTransparency
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMaterialCullBackface

boolean isMaterialCullBackface(int index)
                               throws IOException,
                                      AutomationException
Get backface culling enabled,

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pCull
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMaterialTextured

boolean isMaterialTextured(int index)
                           throws IOException,
                                  AutomationException
Get Is Material textured.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pIsTextured
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialTextureRowCount

int getMaterialTextureRowCount(int index)
                               throws IOException,
                                      AutomationException
Get Material texture row count.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialTextureColumnCount

int getMaterialTextureColumnCount(int index)
                                  throws IOException,
                                         AutomationException
Get Material texture column count.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialTextureBytesPerPixel

int getMaterialTextureBytesPerPixel(int index)
                                    throws IOException,
                                           AutomationException
Get Material texture bytes per pixel.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
The pBytesPerPixel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaterialTexturePixelColor

int getMaterialTexturePixelColor(int index,
                                 int row,
                                 int column)
                                 throws IOException,
                                        AutomationException
Get Material texture pixel color.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
row - The row (in)
column - The column (in)
Returns:
The pColor (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.