com.esri.arcgis.globecore
Interface IGlobeHeightProperties

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGlobeHeightProperties2
All Known Implementing Classes:
GlobeHeightProperties

public interface IGlobeHeightProperties
extends Serializable

Provides access to members that manipulate the height properties of a globe layer.

Superseded By

IGlobeHeightProperties2

Description

The IGlobeHeightProperties interface can be used to manage the height properties of a data layer in globe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void apply(IGlobe pGlobe, ILayer pLayer)
          Apply to the corresponding layer.
 void applyFeatureProperties(IGlobeDisplay pDisplay, IFeature pFeature, IGeometry[] ppNewGeometry, boolean bIgnoreOffsetAndScale)
          Obtain feature geometry with the correct properties.
 ILayer getBaseLayer()
          The base layer.
 int getBaseOption()
          The base option.
 IExpression getElevationExpression()
          The elevation expression for features, in globe units.
 String getElevationExpressionString()
          The elevation expression string for features, in globe units.
 IExpression getExtrusionExpression()
          The extrusion expression object.
 String getExtrusionExpressionString()
          The extrusion expression string.
 int getExtrusionType()
          The extrusion type.
 double getOffset()
          The constant elevation offset in meters.
 double getZFactor()
          The z factor.
 boolean isHasElevationValues()
          Indicates whether the feature layer has elevation values.
 boolean isUseElevationValues()
          Indicates whether elevation values in the feature layer are used.
 void setBaseLayerByRef(ILayer ppBase)
          The base layer.
 void setBaseOption(int pBaseOption)
          The base option.
 void setElevationExpressionByRef(IExpression ppExpression)
          The elevation expression for features, in globe units.
 void setElevationExpressionString(String pExpressionString)
          The elevation expression string for features, in globe units.
 void setExtrusionExpressionByRef(IExpression ppExtrusion)
          The extrusion expression object.
 void setExtrusionExpressionString(String pExtrusion)
          The extrusion expression string.
 void setExtrusionType(int pType)
          The extrusion type.
 void setHasElevationValues(boolean pbHasElevation)
          Indicates whether the feature layer has elevation values.
 void setOffset(double pOffset)
          The constant elevation offset in meters.
 void setUseElevationValues(boolean pbUseElevation)
          Indicates whether elevation values in the feature layer are used.
 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.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.globecore.esriGlobeLayerBaseOption 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pBaseOption - A com.esri.arcgis.globecore.esriGlobeLayerBaseOption constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevationExpressionString

String getElevationExpressionString()
                                    throws IOException,
                                           AutomationException
The elevation expression string for features, in globe units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setElevationExpressionString

void setElevationExpressionString(String pExpressionString)
                                  throws IOException,
                                         AutomationException
The elevation expression string for features, in globe units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getElevationExpression

IExpression getElevationExpression()
                                   throws IOException,
                                          AutomationException
The elevation expression for features, in globe units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.analyst3d.IExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevationExpressionByRef

void setElevationExpressionByRef(IExpression ppExpression)
                                 throws IOException,
                                        AutomationException
The elevation expression for features, in globe units.

Product Availability

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

Parameters:
ppExpression - A reference to a com.esri.arcgis.analyst3d.IExpression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException
The constant elevation offset in meters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOffset

void setOffset(double pOffset)
               throws IOException,
                      AutomationException
The constant elevation offset in meters.

Product Availability

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

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.

getBaseLayer

ILayer getBaseLayer()
                    throws IOException,
                           AutomationException
The base layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaseLayerByRef

void setBaseLayerByRef(ILayer ppBase)
                       throws IOException,
                              AutomationException
The base layer.

Product Availability

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

Parameters:
ppBase - A reference to a com.esri.arcgis.carto.ILayer (in)
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.

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.

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.

apply

void apply(IGlobe pGlobe,
           ILayer pLayer)
           throws IOException,
                  AutomationException
Apply to the corresponding layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasElevationValues

void setHasElevationValues(boolean pbHasElevation)
                           throws IOException,
                                  AutomationException
Indicates whether the feature layer has elevation values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isHasElevationValues

boolean isHasElevationValues()
                             throws IOException,
                                    AutomationException
Indicates whether the feature layer has elevation values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseElevationValues

void setUseElevationValues(boolean pbUseElevation)
                           throws IOException,
                                  AutomationException
Indicates whether elevation values in the feature layer are used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isUseElevationValues

boolean isUseElevationValues()
                             throws IOException,
                                    AutomationException
Indicates whether elevation values in the feature layer are used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pbUseElevation
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.

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.

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.

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.

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.

getExtrusionExpression

IExpression getExtrusionExpression()
                                   throws IOException,
                                          AutomationException
The extrusion expression object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.analyst3d.IExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtrusionExpressionByRef

void setExtrusionExpressionByRef(IExpression ppExtrusion)
                                 throws IOException,
                                        AutomationException
The extrusion expression object.

Product Availability

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

Parameters:
ppExtrusion - A reference to a com.esri.arcgis.analyst3d.IExpression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applyFeatureProperties

void applyFeatureProperties(IGlobeDisplay pDisplay,
                            IFeature pFeature,
                            IGeometry[] ppNewGeometry,
                            boolean bIgnoreOffsetAndScale)
                            throws IOException,
                                   AutomationException
Obtain feature geometry with the correct properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pDisplay - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)
pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
ppNewGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
bIgnoreOffsetAndScale - The bIgnoreOffsetAndScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.