com.esri.arcgis.analyst3d
Class IMarker3DPlacementProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.display.IMarkerSymbolProxy
          extended bycom.esri.arcgis.analyst3d.IMarker3DPlacementProxy
All Implemented Interfaces:
java.io.Externalizable, IMarker3DPlacement, IMarkerSymbol, java.io.Serializable

public class IMarker3DPlacementProxy
extends IMarkerSymbolProxy
implements IMarker3DPlacement, java.io.Serializable

Provides access to members that control the simple 3D marker symbol origin.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  IMarker3DPlacementProxy()
          For internal use only
  IMarker3DPlacementProxy(java.lang.Object obj)
           
protected IMarker3DPlacementProxy(java.lang.Object obj, java.lang.String iid)
           
  IMarker3DPlacementProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected IMarker3DPlacementProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 void applyToPoint(IPoint inShape, IGeometry[] outShape, double enforcedZ, double unitFactor, double zScale)
          Applies symbol construction to original shape.
 double getDepth()
          The depth value.
 IVector3D getNormalizedOriginOffset()
          Normalized offset vector defining the origin within the MBB relative to lower-left corner.
 IGeometry getShape()
          Marker's shape.
 int getUnits()
          The size units.
 double getWidth()
          The width value.
 double getZOffset()
          The Z offset value.
 boolean isMaintainAspectRatio()
          Indicates if the marker maintains its dimensions based on size.
 void queryRotationAngles(double[] xAngle, double[] yAngle, double[] zAngle)
          Gets the rotation angles for each axis.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 void setDepth(double depth)
          The depth value.
 void setMaintainAspectRatio(boolean bAspectRatio)
          Indicates if the marker maintains its dimensions based on size.
 void setNormalizedOriginOffsetByRef(IVector3D offset)
          Normalized offset vector defining the origin within the MBB relative to lower-left corner.
 void setRotationAngles(double xAngle, double yAngle, double zAngle)
          Sets the rotation angles for each axis.
 void setUnits(int unitsCode)
          The size units.
 void setWidth(double width)
          The width value.
 void setZOffset(double zOffset)
          The Z offset value.
 
Methods inherited from class com.esri.arcgis.display.IMarkerSymbolProxy
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

IMarker3DPlacementProxy

public IMarker3DPlacementProxy(java.lang.String CLSID,
                               java.lang.String host,
                               AuthInfo authInfo)
                        throws java.net.UnknownHostException,
                               java.io.IOException

IMarker3DPlacementProxy

public IMarker3DPlacementProxy()
For internal use only


IMarker3DPlacementProxy

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

IMarker3DPlacementProxy

protected IMarker3DPlacementProxy(java.lang.Object obj,
                                  java.lang.String iid)
                           throws java.io.IOException

IMarker3DPlacementProxy

protected IMarker3DPlacementProxy(java.lang.String CLSID,
                                  java.lang.String iid,
                                  java.lang.String host,
                                  AuthInfo authInfo)
                           throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class IMarkerSymbolProxy
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class IMarkerSymbolProxy
Throws:
java.io.IOException

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:

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.