com.esri.arcgis.analyst3d
Interface I3DProperties

All Superinterfaces:

Serializable

All Known Subinterfaces:

I3DProperties2, I3DProperties3

All Known Implementing Classes:

Basic3DProperties, Feature3DProperties, Raster3DProperties, Tin3DProperties

public interface I3DProperties
extends Serializable

Provides access to members that control three-dimensional properties.

Superseded By

I3DProperties3

Remarks

Use the properties and the method of this interface to manage the 3D properties of a data layer in scene.

Product Availability

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

Method Summary

void	apply3DProperties(Object owner) Applies 3D properties.
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.
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.
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	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	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.

Method Detail

getBaseOption

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

Returns:

A com.esri.arcgis.analyst3d.esriBaseOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseOption

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

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

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

Returns:

The pBaseExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseExpressionString

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

Parameters:

pBaseExpression - The pBaseExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseSurface

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

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

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

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

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

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

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

Returns:

The pZFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

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

Parameters:

pZFactor - The pZFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffsetExpressionString

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

Returns:

The pOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffsetExpressionString

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

Parameters:

pOffset - The pOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtrusionType

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

Returns:

A com.esri.arcgis.analyst3d.esriExtrusionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtrusionType

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

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

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

Returns:

The pExtrusion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtrusionExpressionString

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

Parameters:

pExtrusion - The pExtrusion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderVisibility

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

Returns:

A com.esri.arcgis.analyst3d.esriRenderVisibility constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderVisibility

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

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

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

Returns:

The pRefresh

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderRefreshRate

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

Parameters:

pRefresh - The pRefresh (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIlluminate

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

Returns:

The pIlluminate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIlluminate

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

Parameters:

pIlluminate - The pIlluminate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderMode

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

Returns:

A com.esri.arcgis.analyst3d.esriRenderMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderMode

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

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

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

Returns:

The pbSmoothShading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSmoothShading

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

Parameters:

pbSmoothShading - The pbSmoothShading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxTextureMemory

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

Returns:

The pMaxTextureMemory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxTextureMemory

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

Parameters:

pMaxTextureMemory - The pMaxTextureMemory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRasterColumns

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

Returns:

The pMaxRasterColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRasterColumns

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

Parameters:

pMaxRasterColumns - The pMaxRasterColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRasterRows

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

Returns:

The pMaxRasterRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRasterRows

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

Parameters:

pMaxRasterRows - The pMaxRasterRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepthPriorityValue

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

Parameters:

depthPriorityValue - The depthPriorityValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepthPriorityValue

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

Returns:

The depthPriorityValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFaceCulling

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

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

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

Returns:

A com.esri.arcgis.analyst3d.esri3DFaceCulling constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply3DProperties

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.