com.esri.arcgis.controls
Class SceneControl

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Canvas
          extended by com.esri.arcgis.interop.Ocx
              extended by com.esri.arcgis.controls.SceneControl
All Implemented Interfaces:
ISceneControl, ISceneControlDefault, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class SceneControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, ISceneControlDefault, ISceneControl, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

COM Class 'SceneControl'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Esri SceneControl' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Canvas
java.awt.Canvas.AccessibleAWTCanvas
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Ocx
rootParentContainers, rootWindows
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface com.esri.arcgis.controls.ISceneControlDefault
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUTREF_NAME, DISPID_6_GET_NAME, DISPID_6_PUTREF_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID6f7c3afd_ee18_4633_8611_a2aa3cfb869b, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.ISceneControl
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUTREF_NAME, DISPID_6_GET_NAME, DISPID_6_PUTREF_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID886f5a43_99a7_477d_affb_8b374f30da45, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.ITOCBuddy
IID, IID5eeb268c_9b77_406d_8fc5_489324d0758b, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.IToolbarBuddy
IID, IIDd00f1736_7a95_4f5e_b54f_e2863c425dc3, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IPersistStreamInit
IID, IID7fd52380_4e07_101b_ae2d_08002b2ec713, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SceneControl()
          Constructs a SceneControl using ArcGIS Engine.
SceneControl(java.lang.Object o)
          Constructs a SceneControl.
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the SceneControl.
 void addISceneControlEventsListener(ISceneControlEvents theListener)
          addISceneControlEventsListener.
 void addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
          addITOCBuddyEventsListener.
 void addNotify()
           
 boolean checkSxFile(java.lang.String fileName)
          Checks if a filename is a scene document.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 boolean esri_isEnabled()
          Indicates whether the SceneControl can respond to user generated events.
 void esri_setEnabled(boolean rhs1)
          Indicates whether the SceneControl can respond to user generated events.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 IActiveView getActiveView()
          Returns the underlying object implementing basic map and ActiveView.
 int getAppearance()
          The appearance of the SceneControl.
 int getBackColor()
          Background color of the SceneControl.
 int getBorderStyle()
          The border style of the SceneControl.
 ICamera getCamera()
          The Camera object associated with the SceneControl.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 ITool getCurrentTool()
          Current active tool for the SceneControl.
 java.lang.Object getCustomProperty()
          A property to associate data with a control.
 java.lang.String getDocumentFilename()
          The filename of the last scene document loaded into the control.
 int getHWnd()
          Handle to the window associated with the SceneControl.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the SceneControl.
 java.lang.Object getObject()
          A property that returns the underlying control.
 double getScale(IBasicMap pBasicMap)
          Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.
 IScene getScene()
          The Scene object associated with the SceneControl.
 ISceneGraph getSceneGraph()
          The SceneGraph object associated with the SceneControl.
 ISceneViewer getSceneViewer()
          The SceneViewer associated with the SceneControl.
 void getSizeMax(_ULARGE_INTEGER[] pCbSize)
          getSizeMax
 int getTipDelay()
          The delay before scene tips are shown.
 int getTipStyle()
          The style of scene tips.
 void initNew()
          initNew
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isNavigate()
          Indicates if the SceneControl performs default scene navigation in response to mouse events.
 boolean isOverrideBackColor()
          Indicates whether to override the background color of the scene document.
 boolean isShowSceneTips()
          Indicates if scene tips are shown.
 void load(IStream pStm)
          load
 void loadSxFile(java.lang.String sxPath)
          Loads a scene document into the SceneControl.
 void release()
          Release a SceneControl.
 void removeISceneControlEventsListener(ISceneControlEvents theListener)
          removeISceneControlEventsListener.
 void removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
          removeITOCBuddyEventsListener.
 void save(IStream pStm, int fClearDirty)
          save
 void setAppearance(int rhs1)
          The appearance of the SceneControl.
 void setBackColor(int rhs1)
          Background color of the SceneControl.
 void setBorderStyle(int rhs1)
          The border style of the SceneControl.
 void setCameraByRef(ICamera rhs1)
          The Camera object associated with the SceneControl.
 void setCurrentToolByRef(ITool rhs1)
          Current active tool for the SceneControl.
 void setCustomProperty(java.lang.Object rhs1)
          A property to associate data with a control.
 void setDocumentFilename(java.lang.String rhs1)
          The filename of the last scene document loaded into the control.
 void setKeyIntercept(int rhs1)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setMouseIconByRef(Picture rhs1)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int rhs1)
          The mouse pointer displayed over the SceneControl.
 void setNavigate(boolean rhs1)
          Indicates if the SceneControl performs default scene navigation in response to mouse events.
 void setOverrideBackColor(boolean rhs1)
          Indicates whether to override the background color of the scene document.
 void setSceneGraphByRef(ISceneGraph rhs1)
          The SceneGraph object associated with the SceneControl.
 void setShowSceneTips(boolean rhs1)
          Indicates if scene tips are shown.
 void setTipDelay(int rhs1)
          The delay before scene tips are shown.
 void setTipStyle(int rhs1)
          The style of scene tips.
 
Methods inherited from class com.esri.arcgis.interop.Ocx
checkIfVisible, dispose, finalize, getCanvasWindowHandle, getControlWindowHandle, getMinimumSize, getObjRef, getPreferredSize, paint, removeNotify, setBounds, setBounds, setSize, setSize, zz_doQueuedSets, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet
 
Methods inherited from class java.awt.Canvas
createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SceneControl

public SceneControl()
Constructs a SceneControl using ArcGIS Engine.


SceneControl

public SceneControl(java.lang.Object o)
Constructs a SceneControl.

Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addISceneControlEventsListener

public void addISceneControlEventsListener(ISceneControlEvents theListener)
                                    throws java.io.IOException
addISceneControlEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ISceneControlEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeISceneControlEventsListener

public void removeISceneControlEventsListener(ISceneControlEvents theListener)
                                       throws java.io.IOException
removeISceneControlEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ISceneControlEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                throws java.io.IOException
addITOCBuddyEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                   throws java.io.IOException
removeITOCBuddyEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addNotify

public void addNotify()
Overrides:
addNotify in class com.esri.arcgis.interop.Ocx

release

public void release()
Release a SceneControl.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException,
                         AutomationException
Background color of the SceneControl.

Specified by:
setBackColor in interface ISceneControl
Specified by:
setBackColor in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws java.io.IOException,
                        AutomationException
Background color of the SceneControl.

Specified by:
getBackColor in interface ISceneControl
Specified by:
getBackColor in interface ISceneControlDefault
Returns:
The returnValue (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException,
                           AutomationException
The border style of the SceneControl.

Specified by:
setBorderStyle in interface ISceneControl
Specified by:
setBorderStyle in interface ISceneControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException
The border style of the SceneControl.

Specified by:
getBorderStyle in interface ISceneControl
Specified by:
getBorderStyle in interface ISceneControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the SceneControl can respond to user generated events.

Specified by:
esri_setEnabled in interface ISceneControl
Specified by:
esri_setEnabled in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the SceneControl can respond to user generated events.

Specified by:
esri_isEnabled in interface ISceneControl
Specified by:
esri_isEnabled in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int rhs1)
                   throws java.io.IOException,
                          AutomationException
The appearance of the SceneControl.

Specified by:
setAppearance in interface ISceneControl
Specified by:
setAppearance in interface ISceneControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws java.io.IOException,
                         AutomationException
The appearance of the SceneControl.

Specified by:
getAppearance in interface ISceneControl
Specified by:
getAppearance in interface ISceneControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int rhs1)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the SceneControl.

Specified by:
setMousePointer in interface ISceneControl
Specified by:
setMousePointer in interface ISceneControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the SceneControl.

Specified by:
getMousePointer in interface ISceneControl
Specified by:
getMousePointer in interface ISceneControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture rhs1)
                       throws java.io.IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
setMouseIconByRef in interface ISceneControl
Specified by:
setMouseIconByRef in interface ISceneControlDefault
Parameters:
rhs1 - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
getMouseIcon in interface ISceneControl
Specified by:
getMouseIcon in interface ISceneControlDefault
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Handle to the window associated with the SceneControl.

Specified by:
getHWnd in interface ISceneControl
Specified by:
getHWnd in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws java.io.IOException,
                     AutomationException
Displays a dialog of information about the SceneControl.

Specified by:
aboutBox in interface ISceneControl
Specified by:
aboutBox in interface ISceneControlDefault
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadSxFile

public void loadSxFile(java.lang.String sxPath)
                throws java.io.IOException,
                       AutomationException
Loads a scene document into the SceneControl.

Specified by:
loadSxFile in interface ISceneControl
Specified by:
loadSxFile in interface ISceneControlDefault
Parameters:
sxPath - The sxPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScene

public IScene getScene()
                throws java.io.IOException,
                       AutomationException
The Scene object associated with the SceneControl.

Specified by:
getScene in interface ISceneControl
Specified by:
getScene in interface ISceneControlDefault
Returns:
A reference to a com.esri.arcgis.analyst3d.IScene
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException
The SceneGraph object associated with the SceneControl.

Specified by:
getSceneGraph in interface ISceneControl
Specified by:
getSceneGraph in interface ISceneControlDefault
Returns:
A reference to a com.esri.arcgis.analyst3d.ISceneGraph
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSceneGraphByRef

public void setSceneGraphByRef(ISceneGraph rhs1)
                        throws java.io.IOException,
                               AutomationException
The SceneGraph object associated with the SceneControl.

Specified by:
setSceneGraphByRef in interface ISceneControl
Specified by:
setSceneGraphByRef in interface ISceneControlDefault
Parameters:
rhs1 - A reference to a com.esri.arcgis.analyst3d.ISceneGraph (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSceneViewer

public ISceneViewer getSceneViewer()
                            throws java.io.IOException,
                                   AutomationException
The SceneViewer associated with the SceneControl.

Specified by:
getSceneViewer in interface ISceneControl
Specified by:
getSceneViewer in interface ISceneControlDefault
Returns:
A reference to a com.esri.arcgis.analyst3d.ISceneViewer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException
The Camera object associated with the SceneControl.

Specified by:
getCamera in interface ISceneControl
Specified by:
getCamera in interface ISceneControlDefault
Returns:
A reference to a com.esri.arcgis.analyst3d.ICamera
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCameraByRef

public void setCameraByRef(ICamera rhs1)
                    throws java.io.IOException,
                           AutomationException
The Camera object associated with the SceneControl.

Specified by:
setCameraByRef in interface ISceneControl
Specified by:
setCameraByRef in interface ISceneControlDefault
Parameters:
rhs1 - A reference to a com.esri.arcgis.analyst3d.ICamera (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException
Current active tool for the SceneControl. Set to nothing to clear the tool.

Specified by:
getCurrentTool in interface ISceneControl
Specified by:
getCurrentTool in interface ISceneControlDefault
Specified by:
getCurrentTool in interface IToolbarBuddy
Returns:
A reference to a com.esri.arcgis.systemUI.ITool
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool rhs1)
                         throws java.io.IOException,
                                AutomationException
Current active tool for the SceneControl. Set to nothing to clear the tool.

Specified by:
setCurrentToolByRef in interface ISceneControl
Specified by:
setCurrentToolByRef in interface ISceneControlDefault
Specified by:
setCurrentToolByRef in interface IToolbarBuddy
Parameters:
rhs1 - A reference to a com.esri.arcgis.systemUI.ITool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNavigate

public boolean isNavigate()
                   throws java.io.IOException,
                          AutomationException
Indicates if the SceneControl performs default scene navigation in response to mouse events.

Specified by:
isNavigate in interface ISceneControl
Specified by:
isNavigate in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNavigate

public void setNavigate(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException
Indicates if the SceneControl performs default scene navigation in response to mouse events.

Specified by:
setNavigate in interface ISceneControl
Specified by:
setNavigate in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkSxFile

public boolean checkSxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException
Checks if a filename is a scene document.

Specified by:
checkSxFile in interface ISceneControl
Specified by:
checkSxFile in interface ISceneControlDefault
Parameters:
fileName - The fileName (in)
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with a control.

Specified by:
getCustomProperty in interface ISceneControl
Specified by:
getCustomProperty in interface ISceneControlDefault
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object rhs1)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with a control.

Specified by:
setCustomProperty in interface ISceneControl
Specified by:
setCustomProperty in interface ISceneControlDefault
Parameters:
rhs1 - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String rhs1)
                         throws java.io.IOException,
                                AutomationException
The filename of the last scene document loaded into the control.

Specified by:
setDocumentFilename in interface ISceneControl
Specified by:
setDocumentFilename in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException
The filename of the last scene document loaded into the control.

Specified by:
getDocumentFilename in interface ISceneControl
Specified by:
getDocumentFilename in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:
getObject in interface ISceneControl
Specified by:
getObject in interface ISceneControlDefault
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverrideBackColor

public void setOverrideBackColor(boolean rhs1)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to override the background color of the scene document.

Specified by:
setOverrideBackColor in interface ISceneControl
Specified by:
setOverrideBackColor in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverrideBackColor

public boolean isOverrideBackColor()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to override the background color of the scene document.

Specified by:
isOverrideBackColor in interface ISceneControl
Specified by:
isOverrideBackColor in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowSceneTips

public void setShowSceneTips(boolean rhs1)
                      throws java.io.IOException,
                             AutomationException
Indicates if scene tips are shown.

Specified by:
setShowSceneTips in interface ISceneControl
Specified by:
setShowSceneTips in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowSceneTips

public boolean isShowSceneTips()
                        throws java.io.IOException,
                               AutomationException
Indicates if scene tips are shown.

Specified by:
isShowSceneTips in interface ISceneControl
Specified by:
isShowSceneTips in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int rhs1)
                 throws java.io.IOException,
                        AutomationException
The style of scene tips.

Specified by:
setTipStyle in interface ISceneControl
Specified by:
setTipStyle in interface ISceneControlDefault
Parameters:
rhs1 - A com.esri.arcgis.systemUI.esriTipStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipStyle

public int getTipStyle()
                throws java.io.IOException,
                       AutomationException
The style of scene tips.

Specified by:
getTipStyle in interface ISceneControl
Specified by:
getTipStyle in interface ISceneControlDefault
Returns:
A com.esri.arcgis.systemUI.esriTipStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int rhs1)
                 throws java.io.IOException,
                        AutomationException
The delay before scene tips are shown.

Specified by:
setTipDelay in interface ISceneControl
Specified by:
setTipDelay in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipDelay

public int getTipDelay()
                throws java.io.IOException,
                       AutomationException
The delay before scene tips are shown.

Specified by:
getTipDelay in interface ISceneControl
Specified by:
getTipDelay in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
getKeyIntercept in interface ISceneControl
Specified by:
getKeyIntercept in interface ISceneControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
setKeyIntercept in interface ISceneControl
Specified by:
setKeyIntercept in interface ISceneControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException
Returns the underlying object implementing basic map and ActiveView. This is used to populate the TOC.

Specified by:
getActiveView in interface ITOCBuddy
Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale(IBasicMap pBasicMap)
                throws java.io.IOException,
                       AutomationException
Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Specified by:
getScale in interface ITOCBuddy
Parameters:
pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Returns:
The dScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStreamInit
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
load

Specified by:
load in interface IPersistStreamInit
Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStreamInit
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
getSizeMax

Specified by:
getSizeMax in interface IPersistStreamInit
Parameters:
pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initNew

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

Specified by:
initNew in interface IPersistStreamInit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.