com.esri.arcgis.analyst3d
Class SimpleMarker3DSymbol

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

All Implemented Interfaces:

IBillboardDisplay, IClone, IDisplayName, IMapLevel, IMarker3DPlacement, IMarkerSymbol, IPersist, IPersistStream, IPropertySupport, ISimpleMarker3DSymbol, ISymbol, ISymbol3D, java.io.Serializable

public class SimpleMarker3DSymbol

extends java.lang.Object

implements ISimpleMarker3DSymbol, IMarker3DPlacement, IMapLevel, ISymbol, IPropertySupport, IPersistStream, IPersist, IClone, IDisplayName, ISymbol3D, IBillboardDisplay

Simple 3D Marker Symbol component.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The SimpleMarker3DSymbol coclass can be used to display a point with simple predefined 3D shapes. The SimpleMarker3DSymbol determines the style of the simple 3D marker symbol and its resolution quality.

See Also:

Serialized Form

Constructor Summary

SimpleMarker3DSymbol()
Constructs a SimpleMarker3DSymbol using ArcGIS Engine.

SimpleMarker3DSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
void	applyToPoint(IPoint inShape, IGeometry[] outShape, double enforcedZ, double unitFactor, double zScale) Applies symbol construction to original shape.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canApply(java.lang.Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
void	draw(IGeometry geometry) Draws the specified shape.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
double	getAngle() Marker symbol angle.
IBillboardDisplay	getAsIBillboardDisplay() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDisplayName	getAsIDisplayName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMapLevel	getAsIMapLevel() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMarker3DPlacement	getAsIMarker3DPlacement() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPropertySupport	getAsIPropertySupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISimpleMarker3DSymbol	getAsISimpleMarker3DSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbol	getAsISymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbol3D	getAsISymbol3D() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IColor	getColor() Marker symbol color.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
double	getDepth() The depth value.
int	getMapLevel() Current map level for drawing multi-level symbols.
java.lang.String	getNameString() The display name of an object.
IVector3D	getNormalizedOriginOffset() Normalized offset vector defining the origin within the MBB relative to lower-left corner.
double	getResolutionQuality() Marker resolution.
int	getROP2() Raster operation code for pixel drawing.
IGeometry	getShape() Marker's shape.
double	getSize() Marker symbol size.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	getStyle() Marker style.
int	getUnits() The size units.
double	getWidth() The width value.
double	getXOffset() Symbol X-axis offset from point location.
double	getYOffset() Symbol Y-axis offset from point location.
double	getZOffset() The Z offset value.
int	hashCode() the hashcode for this object
boolean	isBillboardDisplay() Get Billboard display.
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
boolean	isMaintainAspectRatio() Indicates if the marker maintains its dimensions based on size.
void	load(IStream pstm) Supported Platforms
void	queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary) Fills an existing polygon with the boundary of the specified symbol.
void	queryRotationAngles(double[] xAngle, double[] yAngle, double[] zAngle) Gets the rotation angles for each axis.
void	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setAngle(double angle) Marker symbol angle.
void	setBillboardDisplay(boolean pBillboard) Get Billboard display.
void	setColor(IColor color) Marker symbol color.
void	setDepth(double depth) The depth value.
void	setMaintainAspectRatio(boolean bAspectRatio) Indicates if the marker maintains its dimensions based on size.
void	setMapLevel(int mapLevel) Current map level for drawing multi-level symbols.
void	setNormalizedOriginOffsetByRef(IVector3D offset) Normalized offset vector defining the origin within the MBB relative to lower-left corner.
void	setResolutionQuality(double quality) Marker resolution.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setRotationAngles(double xAngle, double yAngle, double zAngle) Sets the rotation angles for each axis.
void	setSize(double size) Marker symbol size.
void	setStyle(int style) Marker style.
void	setUnits(int unitsCode) The size units.
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setWidth(double width) The width value.
void	setXOffset(double xOffset) Symbol X-axis offset from point location.
void	setYOffset(double yOffset) Symbol Y-axis offset from point location.
void	setZOffset(double zOffset) The Z offset value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMarker3DSymbol

public SimpleMarker3DSymbol()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a SimpleMarker3DSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SimpleMarker3DSymbol

public SimpleMarker3DSymbol(java.lang.Object obj)
                     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a SimpleMarker3DSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SimpleMarker3DSymbol.
SimpleMarker3DSymbol theSimpleMarker3DSymbol = (SimpleMarker3DSymbol) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsISimpleMarker3DSymbol

public ISimpleMarker3DSymbol getAsISimpleMarker3DSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMarker3DPlacement

public IMarker3DPlacement getAsIMarker3DPlacement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMapLevel

public IMapLevel getAsIMapLevel()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISymbol

public ISymbol getAsISymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDisplayName

public IDisplayName getAsIDisplayName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISymbol3D

public ISymbol3D getAsISymbol3D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBillboardDisplay

public IBillboardDisplay getAsIBillboardDisplay()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getStyle

public int getStyle()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISimpleMarker3DSymbol

Marker style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStyle in interface ISimpleMarker3DSymbol

Returns:

A com.esri.arcgis.analyst3d.esriSimple3DMarkerStyle constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setStyle

public void setStyle(int style)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: ISimpleMarker3DSymbol

Marker style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStyle in interface ISimpleMarker3DSymbol

Parameters:

style - A com.esri.arcgis.analyst3d.esriSimple3DMarkerStyle constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolutionQuality

public double getResolutionQuality()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ISimpleMarker3DSymbol

Marker resolution. The range is [0.0, 1.0], where 0 is the lowest and 1 is the highest resolution.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResolutionQuality in interface ISimpleMarker3DSymbol

Returns:

The quality

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolutionQuality

public void setResolutionQuality(double quality)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: ISimpleMarker3DSymbol

Marker resolution. The range is [0.0, 1.0], where 0 is the lowest and 1 is the highest resolution.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResolutionQuality in interface ISimpleMarker3DSymbol

Parameters:

quality - The quality (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getUnits

public int getUnits()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IMarker3DPlacement

The size units.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUnits in interface IMarker3DPlacement

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int unitsCode)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMarker3DPlacement

The size units.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUnits in interface IMarker3DPlacement

Parameters:

unitsCode - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getNormalizedOriginOffset

public IVector3D getNormalizedOriginOffset()
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IMarker3DPlacement

Normalized offset vector defining the origin within the MBB relative to lower-left corner.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNormalizedOriginOffset in interface IMarker3DPlacement

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormalizedOriginOffsetByRef

public void setNormalizedOriginOffsetByRef(IVector3D offset)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IMarker3DPlacement

Normalized offset vector defining the origin within the MBB relative to lower-left corner.

Specified by:

setNormalizedOriginOffsetByRef in interface IMarker3DPlacement

Parameters:

offset - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getZOffset

public double getZOffset()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMarker3DPlacement

The Z offset value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getZOffset in interface IMarker3DPlacement

Returns:

The zOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setZOffset

public void setZOffset(double zOffset)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarker3DPlacement

The Z offset value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZOffset in interface IMarker3DPlacement

Parameters:

zOffset - The zOffset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getShape

public IGeometry getShape()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IMarker3DPlacement

Marker's shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShape in interface IMarker3DPlacement

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyToPoint

public void applyToPoint(IPoint inShape,
                         IGeometry[] outShape,
                         double enforcedZ,
                         double unitFactor,
                         double zScale)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMarker3DPlacement

Applies symbol construction to original shape.

Supported Platforms

Windows, Solaris, Linux

Description

The ApplyToPoint method is used to apply the 3D Marker symbol to a 3D point, thereby creating a georeferenced geometry for use elsewhere. Essentially, it allows you to generate a geometry using the marker symbol as a template. This can be useful, for example, when creating new features to be stored in the geodatabase. The geometry created is usually a multipatch, though it depends upon the 3D symbol being used.

This interface has been traditionally used for converting symbolized 2D feature classes into 3D multipatch feature classes. From 9.2, the Layer 3D to feature class geoprocessing tool can be used as an alternative.

Remarks

The parameters of ApplyToPoint are:

• inShape: sets the 3D point location for creating the new geometry.
• outShape: returns the result of the operation.
• enforcedZ: apply this Z value to the 3D point location, overwriting any existing Z value in the 'inShape' parameter. The default value is AVNaN, representing 'not a number' as defined in the shapefile definition.
• unitFactor: multiply the current Z for the 3D point location by this value (runs after enforcedZ, above). This is useful for converting between units (eg: feet to meters).
• zScale: flatten or stretch the symbol shape along the z-axis by this value (runs after UnitFactor above).

This call will fail if the symbol is protected by IMarker3DSymbol.IsRestricted property.

Specified by:

applyToPoint in interface IMarker3DPlacement

Parameters:

inShape - A reference to a com.esri.arcgis.geometry.IPoint (in)

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

enforcedZ - The enforcedZ (in, optional, pass -1.1E+38 if not required)

unitFactor - The unitFactor (in, optional, pass 0 if not required)

zScale - The zScale (in, optional, pass 1 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryRotationAngles

public void queryRotationAngles(double[] xAngle,
                                double[] yAngle,
                                double[] zAngle)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IMarker3DPlacement

Gets the rotation angles for each axis.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryRotationAngles in interface IMarker3DPlacement

Parameters:

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

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

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setRotationAngles

public void setRotationAngles(double xAngle,
                              double yAngle,
                              double zAngle)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IMarker3DPlacement

Sets the rotation angles for each axis.

Specified by:

setRotationAngles in interface IMarker3DPlacement

Parameters:

xAngle - The xAngle (in)

yAngle - The yAngle (in)

zAngle - The zAngle (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarker3DPlacement

The width value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IMarker3DPlacement

Returns:

The width

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setWidth

public void setWidth(double width)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMarker3DPlacement

The width value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IMarker3DPlacement

Parameters:

width - The width (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getDepth

public double getDepth()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarker3DPlacement

The depth value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDepth in interface IMarker3DPlacement

Returns:

The depth

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDepth

public void setDepth(double depth)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMarker3DPlacement

The depth value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDepth in interface IMarker3DPlacement

Parameters:

depth - The depth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMaintainAspectRatio

public boolean isMaintainAspectRatio()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IMarker3DPlacement

Indicates if the marker maintains its dimensions based on size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMaintainAspectRatio in interface IMarker3DPlacement

Returns:

The bAspectRatio

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMaintainAspectRatio

public void setMaintainAspectRatio(boolean bAspectRatio)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IMarker3DPlacement

Indicates if the marker maintains its dimensions based on size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaintainAspectRatio in interface IMarker3DPlacement

Parameters:

bAspectRatio - The bAspectRatio (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSize

public double getSize()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:

getSize in interface IMarkerSymbol

Returns:

The size

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:

setSize in interface IMarkerSymbol

Parameters:

size - The size (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getColor

public IColor getColor()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.

Color is not supported by the BarChartSymbol coclass.

Specified by:

getColor in interface IMarkerSymbol

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.

Color is not supported by the BarChartSymbol coclass.

Specified by:

setColor in interface IMarkerSymbol

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).

Angle is not supported by the BarChartSymbol coclass.

Specified by:

getAngle in interface IMarkerSymbol

Returns:

The angle

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setAngle

public void setAngle(double angle)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMarkerSymbol

Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).

Angle is not supported by the BarChartSymbol coclass.

Specified by:

setAngle in interface IMarkerSymbol

Parameters:

angle - The angle (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getXOffset

public double getXOffset()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMarkerSymbol

Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:

getXOffset in interface IMarkerSymbol

Returns:

The xOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarkerSymbol

Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:

setXOffset in interface IMarkerSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getYOffset

public double getYOffset()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMarkerSymbol

Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:

getYOffset in interface IMarkerSymbol

Returns:

The yOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setYOffset

public void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMarkerSymbol

Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:

setYOffset in interface IMarkerSymbol

Parameters:

yOffset - The yOffset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Prepares the DC for drawing the symbol.

Specified by:

setupDC in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetDC

public void resetDC()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Restores DC to original state.

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetDC in interface ISymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: ISymbol

Draws the specified shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ISymbol

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ISymbol

Fills an existing polygon with the boundary of the specified symbol.

Supported Platforms

Windows, Solaris, Linux

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

Specified by:

queryBoundary in interface ISymbol

Parameters:

hDC - The hDC (A COM typedef) (in)

displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)

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

boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getROP2

public int getROP2()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getROP2 in interface ISymbol

Returns:

A com.esri.arcgis.display.esriRasterOpCode constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setROP2

public void setROP2(int drawMode)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setROP2 in interface ISymbol

Parameters:

drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at any given time.

Supported Platforms

Windows, Solaris, Linux

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at that particular moment.

Supported Platforms

Windows, Solaris, Linux

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IPropertySupport

The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

Current will return you the current object of the specified type. For instance, I may ask a CircleElement if it supports a Color object. If it does, then I can use Current to get the Color object currently applied to my CircleElement.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IPropertySupport

Applies the given property to the receiver and returns the old object.

Supported Platforms

Windows, Solaris, Linux

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IDisplayName

The display name of an object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IDisplayName

Returns:

The displayName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isBillboardDisplay

public boolean isBillboardDisplay()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IBillboardDisplay

Get Billboard display.

Specified by:

isBillboardDisplay in interface IBillboardDisplay

Returns:

The pBillboard

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setBillboardDisplay

public void setBillboardDisplay(boolean pBillboard)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IBillboardDisplay

Get Billboard display.

Specified by:

setBillboardDisplay in interface IBillboardDisplay

Parameters:

pBillboard - The pBillboard (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.