com.esri.arcgis.globecore
Class GlobeHeightProperties

java.lang.Object
  com.esri.arcgis.globecore.GlobeHeightProperties

All Implemented Interfaces:

IGlobeHeightProperties, IGlobeHeightProperties2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class GlobeHeightProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeHeightProperties2, IPersistStream, IPersist, Externalizable

The globe layer height properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GlobeHeightProperties()
Constructs a GlobeHeightProperties using ArcGIS Engine.

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

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.
boolean	equals(Object o) Compare this object with another
ILayer	getBaseLayer() The base layer.
int	getBaseOption() The base option.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getZFactor() The z factor.
int	hashCode() the hashcode for this object
boolean	isBottomlessExtrusions() Indicates whether the feature layer has elevation values.
void	isDirty() isDirty
boolean	isHasElevationValues() Indicates whether the feature layer has elevation values.
boolean	isUseElevationValues() Indicates whether elevation values in the feature layer are used.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setBaseLayerByRef(ILayer ppBase) The base layer.
void	setBaseOption(int pBaseOption) The base option.
void	setBottomlessExtrusions(boolean bottomless) Indicates whether the feature layer has elevation values.
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.
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

GlobeHeightProperties

public GlobeHeightProperties()
                      throws IOException,
                             UnknownHostException

Constructs a GlobeHeightProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeHeightProperties

public GlobeHeightProperties(Object obj)
                      throws IOException

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

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

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

setBottomlessExtrusions

public void setBottomlessExtrusions(boolean bottomless)
                             throws IOException,
                                    AutomationException

Indicates whether the feature layer has elevation values.

Description

While extruding polygon features, setting this boolean property to True will extrude the polygon features without bottom faces. This can enhance performance of the display, particularly in cases where displaying the bottom face of the extruded features may not be necessary.

Product Availability

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

Specified by:

setBottomlessExtrusions in interface IGlobeHeightProperties2

Parameters:

bottomless - The bottomless (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBottomlessExtrusions

public boolean isBottomlessExtrusions()
                               throws IOException,
                                      AutomationException

Indicates whether the feature layer has elevation values.

Product Availability

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

Specified by:

isBottomlessExtrusions in interface IGlobeHeightProperties2

Returns:

The bottomless

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseOption in interface IGlobeHeightProperties

Returns:

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBaseOption in interface IGlobeHeightProperties

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

public 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

Specified by:

getElevationExpressionString in interface IGlobeHeightProperties

Returns:

The pExpressionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElevationExpressionString

public 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

Specified by:

setElevationExpressionString in interface IGlobeHeightProperties

Parameters:

pExpressionString - The pExpressionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElevationExpression

public 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

Specified by:

getElevationExpression in interface IGlobeHeightProperties

Returns:

A reference to a com.esri.arcgis.carto.IExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElevationExpressionByRef

public 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.

Specified by:

setElevationExpressionByRef in interface IGlobeHeightProperties

Parameters:

ppExpression - A reference to a com.esri.arcgis.carto.IExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

public 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

Specified by:

getOffset in interface IGlobeHeightProperties

Returns:

The pOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

public 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

Specified by:

setOffset in interface IGlobeHeightProperties

Parameters:

pOffset - The pOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseLayer

public ILayer getBaseLayer()
                    throws IOException,
                           AutomationException

The base layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseLayer in interface IGlobeHeightProperties

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

public void setBaseLayerByRef(ILayer ppBase)
                       throws IOException,
                              AutomationException

The base layer.

Product Availability

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

Specified by:

setBaseLayerByRef in interface IGlobeHeightProperties

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

public double getZFactor()
                  throws IOException,
                         AutomationException

The z factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZFactor in interface IGlobeHeightProperties

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZFactor in interface IGlobeHeightProperties

Parameters:

pZFactor - The pZFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public 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

Specified by:

apply in interface IGlobeHeightProperties

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

public 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

Specified by:

setHasElevationValues in interface IGlobeHeightProperties

Parameters:

pbHasElevation - The pbHasElevation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasElevationValues

public 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

Specified by:

isHasElevationValues in interface IGlobeHeightProperties

Returns:

The pbHasElevation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseElevationValues

public 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

Specified by:

setUseElevationValues in interface IGlobeHeightProperties

Parameters:

pbUseElevation - The pbUseElevation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseElevationValues

public 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

Specified by:

isUseElevationValues in interface IGlobeHeightProperties

Returns:

The pbUseElevation

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionType in interface IGlobeHeightProperties

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionType in interface IGlobeHeightProperties

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtrusionExpressionString in interface IGlobeHeightProperties

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtrusionExpressionString in interface IGlobeHeightProperties

Parameters:

pExtrusion - The pExtrusion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtrusionExpression

public 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

Specified by:

getExtrusionExpression in interface IGlobeHeightProperties

Returns:

A reference to a com.esri.arcgis.carto.IExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtrusionExpressionByRef

public void setExtrusionExpressionByRef(IExpression ppExtrusion)
                                 throws IOException,
                                        AutomationException

The extrusion expression object.

Product Availability

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

Specified by:

setExtrusionExpressionByRef in interface IGlobeHeightProperties

Parameters:

ppExtrusion - A reference to a com.esri.arcgis.carto.IExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyFeatureProperties

public 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

Specified by:

applyFeatureProperties in interface IGlobeHeightProperties

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.

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