com.esri.arcgis.controls
Interface ISceneControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISceneControlProxy, SceneBean, SceneControl

public interface ISceneControl
extends java.io.Serializable

COM Interface 'ISceneControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the 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 =

Field Summary

static java.lang.String	DISPID__501_GET_NAME
static java.lang.String	DISPID__501_PUT_NAME
static java.lang.String	DISPID__504_GET_NAME
static java.lang.String	DISPID__504_PUT_NAME
static java.lang.String	DISPID__514_GET_NAME
static java.lang.String	DISPID__514_PUT_NAME
static java.lang.String	DISPID__515_GET_NAME
static java.lang.String	DISPID__520_GET_NAME
static java.lang.String	DISPID__520_PUT_NAME
static java.lang.String	DISPID__521_GET_NAME
static java.lang.String	DISPID__521_PUT_NAME
static java.lang.String	DISPID__522_GET_NAME
static java.lang.String	DISPID__522_PUTREF_NAME
static java.lang.String	DISPID__552_NAME
static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_10_GET_NAME
static java.lang.String	DISPID_10_PUT_NAME
static java.lang.String	DISPID_11_GET_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_12_PUT_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_13_PUT_NAME
static java.lang.String	DISPID_14_GET_NAME
static java.lang.String	DISPID_14_PUT_NAME
static java.lang.String	DISPID_15_GET_NAME
static java.lang.String	DISPID_15_PUT_NAME
static java.lang.String	DISPID_16_GET_NAME
static java.lang.String	DISPID_16_PUT_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUTREF_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUTREF_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_6_PUTREF_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_7_PUT_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	DISPID_9_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID886f5a43_99a7_477d_affb_8b374f30da45
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the SceneControl.
boolean	checkSxFile(java.lang.String fileName) Checks if a filename is a scene document.
boolean	esri_isEnabled() Indicates whether the SceneControl can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the SceneControl can respond to user generated events.
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.
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.
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.
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.
int	getTipDelay() The delay before scene tips are shown.
int	getTipStyle() The style of scene tips.
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	loadSxFile(java.lang.String sxPath) Loads a scene document into the SceneControl.
void	setAppearance(int pappearance) The appearance of the SceneControl.
void	setBackColor(int pclr) Background color of the SceneControl.
void	setBorderStyle(int pstyle) The border style of the SceneControl.
void	setCameraByRef(ICamera pVal) The Camera object associated with the SceneControl.
void	setCurrentToolByRef(ITool pVal) Current active tool for the SceneControl.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with a control.
void	setDocumentFilename(java.lang.String documentFilename) The filename of the last scene document loaded into the control.
void	setKeyIntercept(int pVal) A property that specifies interception of key strokes that are normally handled by the container.
void	setMouseIconByRef(Picture ppMouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int ppointer) The mouse pointer displayed over the SceneControl.
void	setNavigate(boolean pVal) Indicates if the SceneControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean pVal) Indicates whether to override the background color of the scene document.
void	setSceneGraphByRef(ISceneGraph pVal) The SceneGraph object associated with the SceneControl.
void	setShowSceneTips(boolean show) Indicates if scene tips are shown.
void	setTipDelay(int delay) The delay before scene tips are shown.
void	setTipStyle(int style) The style of scene tips.

Field Detail

IID886f5a43_99a7_477d_affb_8b374f30da45

static final int IID886f5a43_99a7_477d_affb_8b374f30da45

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID__501_PUT_NAME

static final java.lang.String DISPID__501_PUT_NAME

See Also:

Constant Field Values

DISPID__501_GET_NAME

static final java.lang.String DISPID__501_GET_NAME

See Also:

Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME

See Also:

Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME

See Also:

Constant Field Values

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME

See Also:

Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME

See Also:

Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME

See Also:

Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME

See Also:

Constant Field Values

DISPID__521_PUT_NAME

static final java.lang.String DISPID__521_PUT_NAME

See Also:

Constant Field Values

DISPID__521_GET_NAME

static final java.lang.String DISPID__521_GET_NAME

See Also:

Constant Field Values

DISPID__522_PUTREF_NAME

static final java.lang.String DISPID__522_PUTREF_NAME

See Also:

Constant Field Values

DISPID__522_GET_NAME

static final java.lang.String DISPID__522_GET_NAME

See Also:

Constant Field Values

DISPID__515_GET_NAME

static final java.lang.String DISPID__515_GET_NAME

See Also:

Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_3_PUTREF_NAME

static final java.lang.String DISPID_3_PUTREF_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_5_PUTREF_NAME

static final java.lang.String DISPID_5_PUTREF_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_6_PUTREF_NAME

static final java.lang.String DISPID_6_PUTREF_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_9_PUT_NAME

static final java.lang.String DISPID_9_PUT_NAME

See Also:

Constant Field Values

DISPID_10_PUT_NAME

static final java.lang.String DISPID_10_PUT_NAME

See Also:

Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME

See Also:

Constant Field Values

DISPID_11_GET_NAME

static final java.lang.String DISPID_11_GET_NAME

See Also:

Constant Field Values

DISPID_12_PUT_NAME

static final java.lang.String DISPID_12_PUT_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_14_PUT_NAME

static final java.lang.String DISPID_14_PUT_NAME

See Also:

Constant Field Values

DISPID_14_GET_NAME

static final java.lang.String DISPID_14_GET_NAME

See Also:

Constant Field Values

DISPID_15_PUT_NAME

static final java.lang.String DISPID_15_PUT_NAME

See Also:

Constant Field Values

DISPID_15_GET_NAME

static final java.lang.String DISPID_15_GET_NAME

See Also:

Constant Field Values

DISPID_16_GET_NAME

static final java.lang.String DISPID_16_GET_NAME

See Also:

Constant Field Values

DISPID_16_PUT_NAME

static final java.lang.String DISPID_16_PUT_NAME

See Also:

Constant Field Values

Method Detail

setBackColor

void setBackColor(int pclr)
                  throws java.io.IOException,
                         AutomationException

Background color of the SceneControl.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackColor

int getBackColor()
                 throws java.io.IOException,
                        AutomationException

Background color of the SceneControl.

Returns:

The pclr (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the SceneControl.

Parameters:

pstyle - 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

int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException

The border style of the SceneControl.

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

void esri_setEnabled(boolean pbool)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the SceneControl can respond to user generated events.

Parameters:

pbool - The pbool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the SceneControl can respond to user generated events.

Returns:

The pbool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the SceneControl.

Parameters:

pappearance - 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

int getAppearance()
                  throws java.io.IOException,
                         AutomationException

The appearance of the SceneControl.

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

void setMousePointer(int ppointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the SceneControl.

Parameters:

ppointer - 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

int getMousePointer()
                    throws java.io.IOException,
                           AutomationException

The mouse pointer displayed over the SceneControl.

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

void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Parameters:

ppMouseIcon - 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

Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

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

int getHWnd()
            throws java.io.IOException,
                   AutomationException

Handle to the window associated with the SceneControl.

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

void aboutBox()
              throws java.io.IOException,
                     AutomationException

Displays a dialog of information about the SceneControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadSxFile

void loadSxFile(java.lang.String sxPath)
                throws java.io.IOException,
                       AutomationException

Loads a scene document into the SceneControl.

Parameters:

sxPath - The sxPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScene

IScene getScene()
                throws java.io.IOException,
                       AutomationException

The Scene object associated with the SceneControl.

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

ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException

The SceneGraph object associated with the SceneControl.

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

void setSceneGraphByRef(ISceneGraph pVal)
                        throws java.io.IOException,
                               AutomationException

The SceneGraph object associated with the SceneControl.

Parameters:

pVal - 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

ISceneViewer getSceneViewer()
                            throws java.io.IOException,
                                   AutomationException

The SceneViewer associated with the SceneControl.

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

ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException

The Camera object associated with the SceneControl.

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

void setCameraByRef(ICamera pVal)
                    throws java.io.IOException,
                           AutomationException

The Camera object associated with the SceneControl.

Parameters:

pVal - 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

ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

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

void setCurrentToolByRef(ITool pVal)
                         throws java.io.IOException,
                                AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

Parameters:

pVal - 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

boolean isNavigate()
                   throws java.io.IOException,
                          AutomationException

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNavigate

void setNavigate(boolean pVal)
                 throws java.io.IOException,
                        AutomationException

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkSxFile

boolean checkSxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

Checks if a filename is a scene document.

Parameters:

fileName - The fileName (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with a control.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

void setDocumentFilename(java.lang.String documentFilename)
                         throws java.io.IOException,
                                AutomationException

The filename of the last scene document loaded into the control.

Parameters:

documentFilename - The documentFilename (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException

The filename of the last scene document loaded into the control.

Returns:

The documentFilename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObject

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.

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

void setOverrideBackColor(boolean pVal)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to override the background color of the scene document.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOverrideBackColor

boolean isOverrideBackColor()
                            throws java.io.IOException,
                                   AutomationException

Indicates whether to override the background color of the scene document.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSceneTips

void setShowSceneTips(boolean show)
                      throws java.io.IOException,
                             AutomationException

Indicates if scene tips are shown.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSceneTips

boolean isShowSceneTips()
                        throws java.io.IOException,
                               AutomationException

Indicates if scene tips are shown.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTipStyle

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

The style of scene tips.

Parameters:

style - 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

int getTipStyle()
                throws java.io.IOException,
                       AutomationException

The style of scene tips.

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

void setTipDelay(int delay)
                 throws java.io.IOException,
                        AutomationException

The delay before scene tips are shown.

Parameters:

delay - The delay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipDelay

int getTipDelay()
                throws java.io.IOException,
                       AutomationException

The delay before scene tips are shown.

Returns:

The delay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

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.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

void setKeyIntercept(int pVal)
                     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.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.