com.esri.arcgis.globecore
Class GlobeGraphicsElementProperties

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

All Implemented Interfaces:

IGlobeGraphicsElementProperties, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class GlobeGraphicsElementProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeGraphicsElementProperties, IXMLSerialize, IPersistStream, IXMLVersionSupport, Externalizable

The Globe Graphics Element Properties.

Remarks

When a globe graphics element is instantiated, a default set of element properties is created for the element. Depending on the type of element, the property type and value may vary (refer to the library overview for details). If a developer wants to use a set of properties of non-default values, this coclass should be used. See the GlobeGraphicsLayer help for a sample code.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GlobeGraphicsElementProperties()
Constructs a GlobeGraphicsElementProperties using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getCallOutLineOffset(double[] pLongitudeInDegrees, double[] pLatitudeInDegrees, double[] pAltitudeInMeters) The offset introduced by the callout line in the graphics element position.
ISimpleLineSymbol	getCallOutLineSymbol() The symbol used for the callout line.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getDrapedDensificationDistance() For draped line elements, densification distance in meters.
double	getDrapeZOffset() The offset for elevation values when element is draped.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getOrientationMode() The orientation mode, if supported by the element.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isDrapeElement() The option to place the element as a vector on the Globe surface.
boolean	isDrapeQuality() The option to use maximum resolution elevation when draping.
boolean	isFixedScreenSize() The option to keep a fixed screen size, if supported by the element.
boolean	isIlluminate() The illumination option for a graphics element.
boolean	isRasterize() The option to rasterize the element on the Globe surface.
boolean	isUseCallOutLine() The option to add a callout line, if supported by the element.
void	load(IStream pstm) load
void	putCallOutLineOffset(double longitudeInDegrees, double latitudeInDegrees, double altitudeInMeters) The offset introduced by the callout line in the graphics element position.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCallOutLineSymbol(ISimpleLineSymbol ppLineSym) The symbol used for the callout line.
void	setDrapedDensificationDistance(double pMeters) For draped line elements, densification distance in meters.
void	setDrapeElement(boolean pbDrape) The option to place the element as a vector on the Globe surface.
void	setDrapeQuality(boolean pbUseMaximumResolution) The option to use maximum resolution elevation when draping.
void	setDrapeZOffset(double pOffset) The offset for elevation values when element is draped.
void	setFixedScreenSize(boolean pbFixed) The option to keep a fixed screen size, if supported by the element.
void	setIlluminate(boolean pbIlluminate) The illumination option for a graphics element.
void	setOrientationMode(int pMode) The orientation mode, if supported by the element.
void	setRasterize(boolean pbRasterize) The option to rasterize the element on the Globe surface.
void	setUseCallOutLine(boolean pbUseCallOut) The option to add a callout line, if supported by the element.
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

GlobeGraphicsElementProperties

public GlobeGraphicsElementProperties()
                               throws IOException,
                                      UnknownHostException

Constructs a GlobeGraphicsElementProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeGraphicsElementProperties

public GlobeGraphicsElementProperties(Object obj)
                               throws IOException

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

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

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

setIlluminate

public void setIlluminate(boolean pbIlluminate)
                   throws IOException,
                          AutomationException

The illumination option for a graphics element.

Product Availability

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

Specified by:

setIlluminate in interface IGlobeGraphicsElementProperties

Parameters:

pbIlluminate - The pbIlluminate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIlluminate

public boolean isIlluminate()
                     throws IOException,
                            AutomationException

The illumination option for a graphics element.

Product Availability

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

Specified by:

isIlluminate in interface IGlobeGraphicsElementProperties

Returns:

The pbIlluminate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedScreenSize

public void setFixedScreenSize(boolean pbFixed)
                        throws IOException,
                               AutomationException

The option to keep a fixed screen size, if supported by the element.

Product Availability

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

Specified by:

setFixedScreenSize in interface IGlobeGraphicsElementProperties

Parameters:

pbFixed - The pbFixed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedScreenSize

public boolean isFixedScreenSize()
                          throws IOException,
                                 AutomationException

The option to keep a fixed screen size, if supported by the element.

Product Availability

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

Specified by:

isFixedScreenSize in interface IGlobeGraphicsElementProperties

Returns:

The pbFixed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrientationMode

public void setOrientationMode(int pMode)
                        throws IOException,
                               AutomationException

The orientation mode, if supported by the element.

Product Availability

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

Specified by:

setOrientationMode in interface IGlobeGraphicsElementProperties

Parameters:

pMode - A com.esri.arcgis.globecore.esriGlobeGraphicsOrientation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrientationMode

public int getOrientationMode()
                       throws IOException,
                              AutomationException

The orientation mode, if supported by the element.

Product Availability

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

Specified by:

getOrientationMode in interface IGlobeGraphicsElementProperties

Returns:

A com.esri.arcgis.globecore.esriGlobeGraphicsOrientation constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCallOutLine

public void setUseCallOutLine(boolean pbUseCallOut)
                       throws IOException,
                              AutomationException

The option to add a callout line, if supported by the element.

Product Availability

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

Specified by:

setUseCallOutLine in interface IGlobeGraphicsElementProperties

Parameters:

pbUseCallOut - The pbUseCallOut (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCallOutLine

public boolean isUseCallOutLine()
                         throws IOException,
                                AutomationException

The option to add a callout line, if supported by the element.

Product Availability

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

Specified by:

isUseCallOutLine in interface IGlobeGraphicsElementProperties

Returns:

The pbUseCallOut

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallOutLineSymbol

public void setCallOutLineSymbol(ISimpleLineSymbol ppLineSym)
                          throws IOException,
                                 AutomationException

The symbol used for the callout line.

Product Availability

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

Specified by:

setCallOutLineSymbol in interface IGlobeGraphicsElementProperties

Parameters:

ppLineSym - A reference to a com.esri.arcgis.display.ISimpleLineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCallOutLineSymbol

public ISimpleLineSymbol getCallOutLineSymbol()
                                       throws IOException,
                                              AutomationException

The symbol used for the callout line.

Product Availability

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

Specified by:

getCallOutLineSymbol in interface IGlobeGraphicsElementProperties

Returns:

A reference to a com.esri.arcgis.display.ISimpleLineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCallOutLineOffset

public void putCallOutLineOffset(double longitudeInDegrees,
                                 double latitudeInDegrees,
                                 double altitudeInMeters)
                          throws IOException,
                                 AutomationException

The offset introduced by the callout line in the graphics element position.

Product Availability

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

Specified by:

putCallOutLineOffset in interface IGlobeGraphicsElementProperties

Parameters:

longitudeInDegrees - The longitudeInDegrees (in)

latitudeInDegrees - The latitudeInDegrees (in)

altitudeInMeters - The altitudeInMeters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCallOutLineOffset

public void getCallOutLineOffset(double[] pLongitudeInDegrees,
                                 double[] pLatitudeInDegrees,
                                 double[] pAltitudeInMeters)
                          throws IOException,
                                 AutomationException

The offset introduced by the callout line in the graphics element position.

Product Availability

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

Specified by:

getCallOutLineOffset in interface IGlobeGraphicsElementProperties

Parameters:

pLongitudeInDegrees - The pLongitudeInDegrees (out: use single element array)

pLatitudeInDegrees - The pLatitudeInDegrees (out: use single element array)

pAltitudeInMeters - The pAltitudeInMeters (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterize

public void setRasterize(boolean pbRasterize)
                  throws IOException,
                         AutomationException

The option to rasterize the element on the Globe surface.

Product Availability

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

Specified by:

setRasterize in interface IGlobeGraphicsElementProperties

Parameters:

pbRasterize - The pbRasterize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRasterize

public boolean isRasterize()
                    throws IOException,
                           AutomationException

The option to rasterize the element on the Globe surface.

Product Availability

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

Specified by:

isRasterize in interface IGlobeGraphicsElementProperties

Returns:

The pbRasterize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrapeElement

public void setDrapeElement(boolean pbDrape)
                     throws IOException,
                            AutomationException

The option to place the element as a vector on the Globe surface.

Product Availability

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

Specified by:

setDrapeElement in interface IGlobeGraphicsElementProperties

Parameters:

pbDrape - The pbDrape (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrapeElement

public boolean isDrapeElement()
                       throws IOException,
                              AutomationException

The option to place the element as a vector on the Globe surface.

Product Availability

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

Specified by:

isDrapeElement in interface IGlobeGraphicsElementProperties

Returns:

The pbDrape

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrapeQuality

public void setDrapeQuality(boolean pbUseMaximumResolution)
                     throws IOException,
                            AutomationException

The option to use maximum resolution elevation when draping.

Product Availability

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

Specified by:

setDrapeQuality in interface IGlobeGraphicsElementProperties

Parameters:

pbUseMaximumResolution - The pbUseMaximumResolution (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrapeQuality

public boolean isDrapeQuality()
                       throws IOException,
                              AutomationException

The option to use maximum resolution elevation when draping.

Product Availability

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

Specified by:

isDrapeQuality in interface IGlobeGraphicsElementProperties

Returns:

The pbUseMaximumResolution

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrapeZOffset

public void setDrapeZOffset(double pOffset)
                     throws IOException,
                            AutomationException

The offset for elevation values when element is draped.

Product Availability

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

Specified by:

setDrapeZOffset in interface IGlobeGraphicsElementProperties

Parameters:

pOffset - The pOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrapeZOffset

public double getDrapeZOffset()
                       throws IOException,
                              AutomationException

The offset for elevation values when element is draped.

Product Availability

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

Specified by:

getDrapeZOffset in interface IGlobeGraphicsElementProperties

Returns:

The pOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrapedDensificationDistance

public void setDrapedDensificationDistance(double pMeters)
                                    throws IOException,
                                           AutomationException

For draped line elements, densification distance in meters.

Product Availability

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

Specified by:

setDrapedDensificationDistance in interface IGlobeGraphicsElementProperties

Parameters:

pMeters - The pMeters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrapedDensificationDistance

public double getDrapedDensificationDistance()
                                      throws IOException,
                                             AutomationException

For draped line elements, densification distance in meters.

Product Availability

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

Specified by:

getDrapedDensificationDistance in interface IGlobeGraphicsElementProperties

Returns:

The pMeters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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