com.esri.arcgis.analyst3d
Interface IScene

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Globe, ISceneProxy, Scene

public interface IScene
extends java.io.Serializable

COM Interface 'IScene'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description: 'Provides access to members that control the scene.' 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	IID Deprecated. Internal use only
static int	IID787f54e2_ba26_11d2_92f8_44d1f8c00000
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addLayer(ILayer pLayer, boolean autoArrange) Adds a layer to the scene.
void	addLayers(IEnumLayer layers, boolean autoArrange) Adds multiple layers to the scene, optionally arranging them automatically.
boolean	applies(java.lang.Object object) Indicates if the given object is supported by the scene.
void	clearLayers() Removes all layers from the scene.
void	clearSelection() Clears the scene's selection.
void	delayEvents(boolean delay) Used to batch operations together in order to minimize system notifications.
void	deleteLayer(ILayer layer) Deletes a layer from the scene.
ILayer	getActiveGraphicsLayer() The active graphics layer.
IEnvelope	getAreaOfInterest() The area of interest for the scene.
IGraphicsLayer	getBasicGraphicsLayer() The basic graphics layer.
void	getDefaultBackgroundColor(float[] red, float[] green, float[] blue) Returns the default background color.
java.lang.String	getDescription() The description of the scene.
double	getExaggerationFactor() The vertical exaggeration of the scene.
IEnvelope	getExtent() The extent of the scene.
ISelection	getFeatureSelection() The scene's feature selection.
ILayer	getLayer(int index) The layer corresponding to a given index.
int	getLayerCount() The number of layers in the scene.
IEnumLayer	getLayers(IUID uid, boolean recursive) The layers in the scene of the type specified in the UID.
java.lang.String	getName() The name of the scene.
ISceneGraph	getSceneGraph() The scene's scenegraph.
int	getSelectionCount() The number of selected features.
ISpatialReference	getSpatialReference() The spatial reference of the scene.
void	moveLayer(ILayer layer, int toIndex) Moves a layer to another position within the Table Of Contents.
void	proposeSpatialReference(ISpatialReference pProposedSR, boolean[] pbChanged) Proposes a spatial reference for the scene.
void	recalculateExtent() Forces the scene's extent to be recalculated.
void	selectByShape(IGeometry shape, ISelectionEnvironment env, boolean justOne) Selects features in the scene given a shape and an optional selection environment.
void	selectFeature(ILayer layer, IFeature pFeature) Selects a feature.
void	setActiveGraphicsLayerByRef(ILayer ppLayer) The active graphics layer.
void	setAreaOfInterest(IEnvelope aoi) The area of interest for the scene.
void	setDefaultBackgroundColor(float red, float green, float blue) Sets the default background color.
void	setDescription(java.lang.String descr) The description of the scene.
void	setExaggerationFactor(double exaggerationFactor) The vertical exaggeration of the scene.
void	setFeatureSelectionByRef(ISelection selection) The scene's feature selection.
void	setName(java.lang.String name) The name of the scene.
void	setSpatialReferenceByRef(ISpatialReference spatialRef) The spatial reference of the scene.
void	suggestExaggerationFactor(double aspectRatio, double[] exaggerationFactor) Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.

Field Detail

IID787f54e2_ba26_11d2_92f8_44d1f8c00000

static final int IID787f54e2_ba26_11d2_92f8_44d1f8c00000

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

Method Detail

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the scene.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

suggestExaggerationFactor

void suggestExaggerationFactor(double aspectRatio,
                               double[] exaggerationFactor)
                               throws java.io.IOException,
                                      AutomationException

Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.

Parameters:

aspectRatio - The aspectRatio (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExaggerationFactor

double getExaggerationFactor()
                             throws java.io.IOException,
                                    AutomationException

The vertical exaggeration of the scene.

Returns:

The exaggerationFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExaggerationFactor

void setExaggerationFactor(double exaggerationFactor)
                           throws java.io.IOException,
                                  AutomationException

The vertical exaggeration of the scene.

Parameters:

exaggerationFactor - The exaggerationFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

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

Indicates if the given object is supported by the scene.

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the scene.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the scene.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The description of the scene.

Returns:

The descr

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String descr)
                    throws java.io.IOException,
                           AutomationException

The description of the scene.

Parameters:

descr - The descr (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The area of interest for the scene.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The area of interest for the scene.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerCount

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

The number of layers in the scene.

Returns:

The pcLayers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

The layer corresponding to a given index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayers

IEnumLayer getLayers(IUID uid,
                     boolean recursive)
                     throws java.io.IOException,
                            AutomationException

The layers in the scene of the type specified in the UID. If 'recursive' is true, includes layers in group layers.

Parameters:

uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass null if not required)

recursive - The recursive (in, optional, pass false if not required)

Returns:

A reference to a com.esri.arcgis.carto.IEnumLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer pLayer,
              boolean autoArrange)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the scene.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

autoArrange - The autoArrange (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayers

void addLayers(IEnumLayer layers,
               boolean autoArrange)
               throws java.io.IOException,
                      AutomationException

Adds multiple layers to the scene, optionally arranging them automatically.

Parameters:

layers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)

autoArrange - The autoArrange (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteLayer

void deleteLayer(ILayer layer)
                 throws java.io.IOException,
                        AutomationException

Deletes a layer from the scene.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveLayer

void moveLayer(ILayer layer,
               int toIndex)
               throws java.io.IOException,
                      AutomationException

Moves a layer to another position within the Table Of Contents.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

toIndex - The toIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearLayers

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

Removes all layers from the scene.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the scene.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference of the scene.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

proposeSpatialReference

void proposeSpatialReference(ISpatialReference pProposedSR,
                             boolean[] pbChanged)
                             throws java.io.IOException,
                                    AutomationException

Proposes a spatial reference for the scene.

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBasicGraphicsLayer

IGraphicsLayer getBasicGraphicsLayer()
                                     throws java.io.IOException,
                                            AutomationException

The basic graphics layer.

Returns:

A reference to a com.esri.arcgis.carto.IGraphicsLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveGraphicsLayer

ILayer getActiveGraphicsLayer()
                              throws java.io.IOException,
                                     AutomationException

The active graphics layer. If no graphic layers exist, a basic memory graphics layer will be created.

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveGraphicsLayerByRef

void setActiveGraphicsLayerByRef(ILayer ppLayer)
                                 throws java.io.IOException,
                                        AutomationException

The active graphics layer. If no graphic layers exist, a basic memory graphics layer will be created.

Parameters:

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delayEvents

void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together in order to minimize system notifications.

Parameters:

delay - The delay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionCount

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

The number of selected features.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectFeature

void selectFeature(ILayer layer,
                   IFeature pFeature)
                   throws java.io.IOException,
                          AutomationException

Selects a feature.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearSelection

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

Clears the scene's selection.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureSelection

ISelection getFeatureSelection()
                               throws java.io.IOException,
                                      AutomationException

The scene's feature selection.

Returns:

A reference to a com.esri.arcgis.carto.ISelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureSelectionByRef

void setFeatureSelectionByRef(ISelection selection)
                              throws java.io.IOException,
                                     AutomationException

The scene's feature selection.

Parameters:

selection - A reference to a com.esri.arcgis.carto.ISelection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectByShape

void selectByShape(IGeometry shape,
                   ISelectionEnvironment env,
                   boolean justOne)
                   throws java.io.IOException,
                          AutomationException

Selects features in the scene given a shape and an optional selection environment.

Parameters:

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

env - A reference to a com.esri.arcgis.carto.ISelectionEnvironment (in)

justOne - The justOne (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

recalculateExtent

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

Forces the scene's extent to be recalculated.

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 scene's scenegraph.

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.

setDefaultBackgroundColor

void setDefaultBackgroundColor(float red,
                               float green,
                               float blue)
                               throws java.io.IOException,
                                      AutomationException

Sets the default background color.

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultBackgroundColor

void getDefaultBackgroundColor(float[] red,
                               float[] green,
                               float[] blue)
                               throws java.io.IOException,
                                      AutomationException

Returns the default background color.

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.