com.esri.arcgis.analyst3d
Class I3DPropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.analyst3d.I3DPropertiesProxy

All Implemented Interfaces:

java.io.Externalizable, I3DProperties, java.io.Serializable

Direct Known Subclasses:

I3DProperties2Proxy

public class I3DPropertiesProxy

extends Dispatch

implements I3DProperties, java.io.Serializable

Provides access to members that control three-dimensional properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	I3DPropertiesProxy() For internal use only
	I3DPropertiesProxy(java.lang.Object obj)
protected	I3DPropertiesProxy(java.lang.Object obj, java.lang.String iid)
	I3DPropertiesProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	I3DPropertiesProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
void	apply3DProperties(java.lang.Object owner) Applies 3D properties.
java.lang.String	getBaseExpressionString() The base expression string.
IName	getBaseName() The name of the base surface.
int	getBaseOption() The base option.
IFunctionalSurface	getBaseSurface() The base surface.
short	getDepthPriorityValue() The drawing priority to be applied to a layer when in the same location than others.
java.lang.String	getExtrusionExpressionString() The extrusion expression string.
int	getExtrusionType() The extrusion type.
int	getFaceCulling() The face culling mode.
int	getMaxRasterColumns() The maximum number of columns for a raster elevation grid.
int	getMaxRasterRows() The maximum number of rows for a raster elevation grid.
int	getMaxTextureMemory() The maximum texture memory a layer can use.
java.lang.String	getOffsetExpressionString() The offset expression string.
int	getRenderMode() The rendering mode.
double	getRenderRefreshRate() The rendering refresh rate.
int	getRenderVisibility() The render visibility option.
double	getZFactor() The z factor.
boolean	isIlluminate() Indicates if areal features are illuminated.
boolean	isSmoothShading() Indicates if smooth shading is enabled.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setBaseExpressionString(java.lang.String pBaseExpression) The base expression string.
void	setBaseOption(int pBaseOption) The base option.
void	setBaseSurfaceByRef(IFunctionalSurface ppBase) The base surface.
void	setDepthPriorityValue(short depthPriorityValue) The drawing priority to be applied to a layer when in the same location than others.
void	setExtrusionExpressionString(java.lang.String pExtrusion) The extrusion expression string.
void	setExtrusionType(int pType) The extrusion type.
void	setFaceCulling(int pCullingMode) The face culling mode.
void	setIlluminate(boolean pIlluminate) Indicates if areal features are illuminated.
void	setMaxRasterColumns(int pMaxRasterColumns) The maximum number of columns for a raster elevation grid.
void	setMaxRasterRows(int pMaxRasterRows) The maximum number of rows for a raster elevation grid.
void	setMaxTextureMemory(int pMaxTextureMemory) The maximum texture memory a layer can use.
void	setOffsetExpressionString(java.lang.String pOffset) The offset expression string.
void	setRenderMode(int pRenderMode) The rendering mode.
void	setRenderRefreshRate(double pRefresh) The rendering refresh rate.
void	setRenderVisibility(int pRenderOption) The render visibility option.
void	setSmoothShading(boolean pbSmoothShading) Indicates if smooth shading is enabled.
void	setZFactor(double pZFactor) The z factor.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

I3DPropertiesProxy

public I3DPropertiesProxy(java.lang.String CLSID,
                          java.lang.String host,
                          AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException

I3DPropertiesProxy

public I3DPropertiesProxy()

For internal use only

I3DPropertiesProxy

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

I3DPropertiesProxy

protected I3DPropertiesProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException

I3DPropertiesProxy

protected I3DPropertiesProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             AuthInfo authInfo)
                      throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getBaseOption

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

Description copied from interface: I3DProperties

The base option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseOption in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriBaseOption constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBaseOption

public void setBaseOption(int pBaseOption)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: I3DProperties

The base option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseOption in interface I3DProperties

Parameters:

pBaseOption - A com.esri.arcgis.analyst3d.esriBaseOption constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseExpressionString

public java.lang.String getBaseExpressionString()
                                         throws java.io.IOException,
                                                AutomationException

Description copied from interface: I3DProperties

The base expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseExpressionString in interface I3DProperties

Returns:

The pBaseExpression

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBaseExpressionString

public void setBaseExpressionString(java.lang.String pBaseExpression)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: I3DProperties

The base expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseExpressionString in interface I3DProperties

Parameters:

pBaseExpression - The pBaseExpression (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBaseSurface

public IFunctionalSurface getBaseSurface()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: I3DProperties

The base surface.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseSurface in interface I3DProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBaseSurfaceByRef

public void setBaseSurfaceByRef(IFunctionalSurface ppBase)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: I3DProperties

The base surface.

Specified by:

setBaseSurfaceByRef in interface I3DProperties

Parameters:

ppBase - A reference to a com.esri.arcgis.geometry.IFunctionalSurface (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBaseName

public IName getBaseName()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: I3DProperties

The name of the base surface.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseName in interface I3DProperties

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getZFactor

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

Description copied from interface: I3DProperties

The z factor.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZFactor in interface I3DProperties

Returns:

The pZFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double pZFactor)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: I3DProperties

The z factor.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZFactor in interface I3DProperties

Parameters:

pZFactor - The pZFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOffsetExpressionString

public java.lang.String getOffsetExpressionString()
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: I3DProperties

The offset expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffsetExpressionString in interface I3DProperties

Returns:

The pOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOffsetExpressionString

public void setOffsetExpressionString(java.lang.String pOffset)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: I3DProperties

The offset expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffsetExpressionString in interface I3DProperties

Parameters:

pOffset - The pOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtrusionType

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

Description copied from interface: I3DProperties

The extrusion type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionType in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriExtrusionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtrusionType

public void setExtrusionType(int pType)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: I3DProperties

The extrusion type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionType in interface I3DProperties

Parameters:

pType - A com.esri.arcgis.analyst3d.esriExtrusionType constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExtrusionExpressionString

public java.lang.String getExtrusionExpressionString()
                                              throws java.io.IOException,
                                                     AutomationException

Description copied from interface: I3DProperties

The extrusion expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionExpressionString in interface I3DProperties

Returns:

The pExtrusion

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setExtrusionExpressionString

public void setExtrusionExpressionString(java.lang.String pExtrusion)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: I3DProperties

The extrusion expression string.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionExpressionString in interface I3DProperties

Parameters:

pExtrusion - The pExtrusion (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderVisibility

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

Description copied from interface: I3DProperties

The render visibility option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderVisibility in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriRenderVisibility constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setRenderVisibility

public void setRenderVisibility(int pRenderOption)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: I3DProperties

The render visibility option.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderVisibility in interface I3DProperties

Parameters:

pRenderOption - A com.esri.arcgis.analyst3d.esriRenderVisibility constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderRefreshRate

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

Description copied from interface: I3DProperties

The rendering refresh rate.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderRefreshRate in interface I3DProperties

Returns:

The pRefresh

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRenderRefreshRate

public void setRenderRefreshRate(double pRefresh)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: I3DProperties

The rendering refresh rate.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderRefreshRate in interface I3DProperties

Parameters:

pRefresh - The pRefresh (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIlluminate

public boolean isIlluminate()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: I3DProperties

Indicates if areal features are illuminated.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIlluminate in interface I3DProperties

Returns:

The pIlluminate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIlluminate

public void setIlluminate(boolean pIlluminate)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: I3DProperties

Indicates if areal features are illuminated.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIlluminate in interface I3DProperties

Parameters:

pIlluminate - The pIlluminate (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRenderMode

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

Description copied from interface: I3DProperties

The rendering mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderMode in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriRenderMode constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setRenderMode

public void setRenderMode(int pRenderMode)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: I3DProperties

The rendering mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderMode in interface I3DProperties

Parameters:

pRenderMode - A com.esri.arcgis.analyst3d.esriRenderMode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSmoothShading

public boolean isSmoothShading()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: I3DProperties

Indicates if smooth shading is enabled.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSmoothShading in interface I3DProperties

Returns:

The pbSmoothShading

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSmoothShading

public void setSmoothShading(boolean pbSmoothShading)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: I3DProperties

Indicates if smooth shading is enabled.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSmoothShading in interface I3DProperties

Parameters:

pbSmoothShading - The pbSmoothShading (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMaxTextureMemory

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

Description copied from interface: I3DProperties

The maximum texture memory a layer can use.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxTextureMemory in interface I3DProperties

Returns:

The pMaxTextureMemory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxTextureMemory

public void setMaxTextureMemory(int pMaxTextureMemory)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: I3DProperties

The maximum texture memory a layer can use.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxTextureMemory in interface I3DProperties

Parameters:

pMaxTextureMemory - The pMaxTextureMemory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxRasterColumns

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

Description copied from interface: I3DProperties

The maximum number of columns for a raster elevation grid.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRasterColumns in interface I3DProperties

Returns:

The pMaxRasterColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxRasterColumns

public void setMaxRasterColumns(int pMaxRasterColumns)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: I3DProperties

The maximum number of columns for a raster elevation grid.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRasterColumns in interface I3DProperties

Parameters:

pMaxRasterColumns - The pMaxRasterColumns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxRasterRows

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

Description copied from interface: I3DProperties

The maximum number of rows for a raster elevation grid.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRasterRows in interface I3DProperties

Returns:

The pMaxRasterRows

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMaxRasterRows

public void setMaxRasterRows(int pMaxRasterRows)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: I3DProperties

The maximum number of rows for a raster elevation grid.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRasterRows in interface I3DProperties

Parameters:

pMaxRasterRows - The pMaxRasterRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDepthPriorityValue

public void setDepthPriorityValue(short depthPriorityValue)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: I3DProperties

The drawing priority to be applied to a layer when in the same location than others.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDepthPriorityValue in interface I3DProperties

Parameters:

depthPriorityValue - The depthPriorityValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDepthPriorityValue

public short getDepthPriorityValue()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: I3DProperties

The drawing priority to be applied to a layer when in the same location than others.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDepthPriorityValue in interface I3DProperties

Returns:

The depthPriorityValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFaceCulling

public void setFaceCulling(int pCullingMode)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: I3DProperties

The face culling mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFaceCulling in interface I3DProperties

Parameters:

pCullingMode - A com.esri.arcgis.analyst3d.esri3DFaceCulling constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFaceCulling

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

Description copied from interface: I3DProperties

The face culling mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFaceCulling in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esri3DFaceCulling constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply3DProperties

public void apply3DProperties(java.lang.Object owner)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: I3DProperties

Applies 3D properties.

Supported Platforms

Windows, Solaris, Linux

Remarks

The only method in I3DProperties interface, Apply3DProperties, requires one argument and the 'owner', which specifies which layer the 3D properties should be applied to. It has to be a concrete layer type, e.g. a feature layer, a TIN layer, or a raster layer. Please refer to the VBA sample code for the interface.

Specified by:

apply3DProperties in interface I3DProperties

Parameters:

owner - A reference to another Object (IUnknown) (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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