com.esri.arcgis.analyst3d
Class Feature3DProperties

java.lang.Object
  com.esri.arcgis.analyst3d.Feature3DProperties

All Implemented Interfaces:

I3DProperties, I3DProperties2, I3DProperties3, IFeature3DProperties, IFeature3DProperties2, IDataLayerExtension, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class Feature3DProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataLayerExtension, IFeature3DProperties, IFeature3DProperties2, I3DProperties, I3DProperties2, I3DProperties3, IPersistStream, Externalizable

Three-dimensional scene filter for features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

Feature3DProperties()
Constructs a Feature3DProperties using ArcGIS Engine.

Feature3DProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Feature3DProperties theFeature3DProperties = (Feature3DProperties) obj;

Method Summary

void	apply3DProperties(Object owner) Applies 3D properties.
void	applyFeatureProperties(IFeature feature, IGeometry[] newGeometry, boolean ignoreOffsetAndScale) Applies feature properties resulting in a new geometry.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
boolean	equals(Object o) Compare this object with another
double	getAlphaThreshold() Alpha threshold for transparency.
String	getBaseExpressionString() The base expression string.
IName	getBaseName() The name of the base surface.
int	getBaseOption() The base option.
IFunctionalSurface	getBaseSurface() The base surface.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
short	getDepthPriorityValue() The drawing priority to be applied to a layer when in the same location than others.
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.
String	getOffsetExpressionString() The offset expression string.
String	getRelativeBase() Base path used when storing relative path names.
int	getRenderMode() The rendering mode.
double	getRenderRefreshRate() The rendering refresh rate.
int	getRenderVisibility() The render visibility option.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getTextureCompressionType() The current texture compression type.
int	getTextureDisplayType() The current texture display type.
double	getTextureDownsamplingFactor() The texture downsampling factor.
double	getZFactor() The z factor.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isIlluminate() Indicates if areal features are illuminated.
boolean	isSmoothShading() Indicates if smooth shading is enabled.
void	load(IStream pstm) load
void	locate(int hint, IRay pQueryRay, IFeature[] ppFeat, IPoint[] ppPoint) Locates an object.
void	locateSymbolized(int hint, IRay pQueryRay, IFeatureLayer pLayer, IFeature[] ppFeat, IPoint[] ppPoint) Locates an object honoring symbolization.
void	prepareQueryFilter(IFeatureClass pFc, IQueryFilter pQueryFilter) Prepares query filter to support calculated properties.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAlphaThreshold(double threshold) Alpha threshold for transparency.
void	setBaseExpressionString(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(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(String pOffset) The offset expression string.
void	setRelativeBase(String basePath) Base path used when storing relative path names.
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	setTextureCompressionType(int type) The current texture compression type.
void	setTextureDisplayType(int type) The current texture display type.
void	setTextureDownsamplingFactor(double texResamplingFactor) The texture downsampling factor.
void	setZFactor(double pZFactor) The z factor.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

Feature3DProperties

public Feature3DProperties()
                    throws IOException,
                           UnknownHostException

Constructs a Feature3DProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Feature3DProperties

public Feature3DProperties(Object obj)
                    throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRelativeBase in interface IDataLayerExtension

Returns:

The basePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException

Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRelativeBase in interface IDataLayerExtension

Parameters:

basePath - The basePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IDataLayerExtension

Parameters:

pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locate

public void locate(int hint,
                   IRay pQueryRay,
                   IFeature[] ppFeat,
                   IPoint[] ppPoint)
            throws IOException,
                   AutomationException

Locates an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

locate in interface IFeature3DProperties

Parameters:

hint - The hint (in)

pQueryRay - A reference to a com.esri.arcgis.geometry.IRay (in)

ppFeat - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyFeatureProperties

public void applyFeatureProperties(IFeature feature,
                                   IGeometry[] newGeometry,
                                   boolean ignoreOffsetAndScale)
                            throws IOException,
                                   AutomationException

Applies feature properties resulting in a new geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

applyFeatureProperties in interface IFeature3DProperties

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

ignoreOffsetAndScale - The ignoreOffsetAndScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareQueryFilter

public void prepareQueryFilter(IFeatureClass pFc,
                               IQueryFilter pQueryFilter)
                        throws IOException,
                               AutomationException

Prepares query filter to support calculated properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareQueryFilter in interface IFeature3DProperties

Parameters:

pFc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateSymbolized

public void locateSymbolized(int hint,
                             IRay pQueryRay,
                             IFeatureLayer pLayer,
                             IFeature[] ppFeat,
                             IPoint[] ppPoint)
                      throws IOException,
                             AutomationException

Locates an object honoring symbolization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

locateSymbolized in interface IFeature3DProperties2

Parameters:

hint - The hint (in)

pQueryRay - A reference to a com.esri.arcgis.geometry.IRay (in)

pLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

ppFeat - A reference to a com.esri.arcgis.geodatabase.IFeature (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseOption

public int getBaseOption()
                  throws IOException,
                         AutomationException

The base option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseOption in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriBaseOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseOption

public void setBaseOption(int pBaseOption)
                   throws IOException,
                          AutomationException

The base option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseOption in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseExpressionString

public String getBaseExpressionString()
                               throws IOException,
                                      AutomationException

The base expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseExpressionString in interface I3DProperties

Returns:

The pBaseExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseExpressionString

public void setBaseExpressionString(String pBaseExpression)
                             throws IOException,
                                    AutomationException

The base expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseExpressionString in interface I3DProperties

Parameters:

pBaseExpression - The pBaseExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseSurface

public IFunctionalSurface getBaseSurface()
                                  throws IOException,
                                         AutomationException

The base surface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseSurface in interface I3DProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseSurfaceByRef

public void setBaseSurfaceByRef(IFunctionalSurface ppBase)
                         throws IOException,
                                AutomationException

The base surface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseSurfaceByRef in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public IName getBaseName()
                  throws IOException,
                         AutomationException

The name of the base surface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseName in interface I3DProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFactor

public double getZFactor()
                  throws IOException,
                         AutomationException

The z factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZFactor in interface I3DProperties

Returns:

The pZFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double pZFactor)
                throws IOException,
                       AutomationException

The z factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZFactor in interface I3DProperties

Parameters:

pZFactor - The pZFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffsetExpressionString

public String getOffsetExpressionString()
                                 throws IOException,
                                        AutomationException

The offset expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffsetExpressionString in interface I3DProperties

Returns:

The pOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffsetExpressionString

public void setOffsetExpressionString(String pOffset)
                               throws IOException,
                                      AutomationException

The offset expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffsetExpressionString in interface I3DProperties

Parameters:

pOffset - The pOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtrusionType

public int getExtrusionType()
                     throws IOException,
                            AutomationException

The extrusion type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionType in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriExtrusionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtrusionType

public void setExtrusionType(int pType)
                      throws IOException,
                             AutomationException

The extrusion type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionType in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtrusionExpressionString

public String getExtrusionExpressionString()
                                    throws IOException,
                                           AutomationException

The extrusion expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionExpressionString in interface I3DProperties

Returns:

The pExtrusion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtrusionExpressionString

public void setExtrusionExpressionString(String pExtrusion)
                                  throws IOException,
                                         AutomationException

The extrusion expression string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionExpressionString in interface I3DProperties

Parameters:

pExtrusion - The pExtrusion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderVisibility

public int getRenderVisibility()
                        throws IOException,
                               AutomationException

The render visibility option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderVisibility in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriRenderVisibility constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderVisibility

public void setRenderVisibility(int pRenderOption)
                         throws IOException,
                                AutomationException

The render visibility option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderVisibility in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderRefreshRate

public double getRenderRefreshRate()
                            throws IOException,
                                   AutomationException

The rendering refresh rate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderRefreshRate in interface I3DProperties

Returns:

The pRefresh

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderRefreshRate

public void setRenderRefreshRate(double pRefresh)
                          throws IOException,
                                 AutomationException

The rendering refresh rate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderRefreshRate in interface I3DProperties

Parameters:

pRefresh - The pRefresh (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIlluminate

public boolean isIlluminate()
                     throws IOException,
                            AutomationException

Indicates if areal features are illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIlluminate in interface I3DProperties

Returns:

The pIlluminate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIlluminate

public void setIlluminate(boolean pIlluminate)
                   throws IOException,
                          AutomationException

Indicates if areal features are illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIlluminate in interface I3DProperties

Parameters:

pIlluminate - The pIlluminate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderMode

public int getRenderMode()
                  throws IOException,
                         AutomationException

The rendering mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderMode in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esriRenderMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderMode

public void setRenderMode(int pRenderMode)
                   throws IOException,
                          AutomationException

The rendering mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRenderMode in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSmoothShading

public boolean isSmoothShading()
                        throws IOException,
                               AutomationException

Indicates if smooth shading is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSmoothShading in interface I3DProperties

Returns:

The pbSmoothShading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSmoothShading

public void setSmoothShading(boolean pbSmoothShading)
                      throws IOException,
                             AutomationException

Indicates if smooth shading is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSmoothShading in interface I3DProperties

Parameters:

pbSmoothShading - The pbSmoothShading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxTextureMemory

public int getMaxTextureMemory()
                        throws IOException,
                               AutomationException

The maximum texture memory a layer can use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxTextureMemory in interface I3DProperties

Returns:

The pMaxTextureMemory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxTextureMemory

public void setMaxTextureMemory(int pMaxTextureMemory)
                         throws IOException,
                                AutomationException

The maximum texture memory a layer can use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxTextureMemory in interface I3DProperties

Parameters:

pMaxTextureMemory - The pMaxTextureMemory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRasterColumns

public int getMaxRasterColumns()
                        throws IOException,
                               AutomationException

The maximum number of columns for a raster elevation grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRasterColumns in interface I3DProperties

Returns:

The pMaxRasterColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRasterColumns

public void setMaxRasterColumns(int pMaxRasterColumns)
                         throws IOException,
                                AutomationException

The maximum number of columns for a raster elevation grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRasterColumns in interface I3DProperties

Parameters:

pMaxRasterColumns - The pMaxRasterColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRasterRows

public int getMaxRasterRows()
                     throws IOException,
                            AutomationException

The maximum number of rows for a raster elevation grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRasterRows in interface I3DProperties

Returns:

The pMaxRasterRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRasterRows

public void setMaxRasterRows(int pMaxRasterRows)
                      throws IOException,
                             AutomationException

The maximum number of rows for a raster elevation grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRasterRows in interface I3DProperties

Parameters:

pMaxRasterRows - The pMaxRasterRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepthPriorityValue

public void setDepthPriorityValue(short depthPriorityValue)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDepthPriorityValue in interface I3DProperties

Parameters:

depthPriorityValue - The depthPriorityValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepthPriorityValue

public short getDepthPriorityValue()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDepthPriorityValue in interface I3DProperties

Returns:

The depthPriorityValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFaceCulling

public void setFaceCulling(int pCullingMode)
                    throws IOException,
                           AutomationException

The face culling mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFaceCulling in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFaceCulling

public int getFaceCulling()
                   throws IOException,
                          AutomationException

The face culling mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFaceCulling in interface I3DProperties

Returns:

A com.esri.arcgis.analyst3d.esri3DFaceCulling constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply3DProperties

public void apply3DProperties(Object owner)
                       throws IOException,
                              AutomationException

Applies 3D properties.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply3DProperties in interface I3DProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextureDownsamplingFactor

public double getTextureDownsamplingFactor()
                                    throws IOException,
                                           AutomationException

The texture downsampling factor.

Product Availability

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

Specified by:

getTextureDownsamplingFactor in interface I3DProperties2

Returns:

The texResamplingFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextureDownsamplingFactor

public void setTextureDownsamplingFactor(double texResamplingFactor)
                                  throws IOException,
                                         AutomationException

The texture downsampling factor.

Product Availability

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

Specified by:

setTextureDownsamplingFactor in interface I3DProperties2

Parameters:

texResamplingFactor - The texResamplingFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextureCompressionType

public void setTextureCompressionType(int type)
                               throws IOException,
                                      AutomationException

The current texture compression type.

Product Availability

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

Specified by:

setTextureCompressionType in interface I3DProperties2

Parameters:

type - A com.esri.arcgis.analyst3d.esriTextureFormatType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextureCompressionType

public int getTextureCompressionType()
                              throws IOException,
                                     AutomationException

The current texture compression type.

Product Availability

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

Specified by:

getTextureCompressionType in interface I3DProperties2

Returns:

A com.esri.arcgis.analyst3d.esriTextureFormatType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextureDisplayType

public void setTextureDisplayType(int type)
                           throws IOException,
                                  AutomationException

The current texture display type.

Product Availability

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

Specified by:

setTextureDisplayType in interface I3DProperties2

Parameters:

type - A com.esri.arcgis.analyst3d.esriTextureFormatType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextureDisplayType

public int getTextureDisplayType()
                          throws IOException,
                                 AutomationException

The current texture display type.

Product Availability

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

Specified by:

getTextureDisplayType in interface I3DProperties2

Returns:

A com.esri.arcgis.analyst3d.esriTextureFormatType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlphaThreshold

public void setAlphaThreshold(double threshold)
                       throws IOException,
                              AutomationException

Alpha threshold for transparency.

Product Availability

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

Specified by:

setAlphaThreshold in interface I3DProperties3

Parameters:

threshold - The threshold (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlphaThreshold

public double getAlphaThreshold()
                         throws IOException,
                                AutomationException

Alpha threshold for transparency.

Product Availability

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

Specified by:

getAlphaThreshold in interface I3DProperties3

Returns:

The threshold

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException