com.esri.arcgis.analyst3d
Interface ISceneGraphEvents

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
ISceneGraphEventsAdapter, ISceneGraphEventsProxy

public interface ISceneGraphEvents
extends EventListener, Serializable

Provides access to events that occur when the state of the scene graph changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void activeViewerChanged(ISceneGraphEventsActiveViewerChangedEvent theEvent)
          Fired when the active viewer changes.
 void afterDraw(ISceneGraphEventsAfterDrawEvent theEvent)
          Fired when drawing finishes.
 boolean beforeDraw(ISceneGraphEventsBeforeDrawEvent theEvent)
          Fired when drawing starts.
 void interactionStopped(ISceneGraphEventsInteractionStoppedEvent theEvent)
          Fired when interaction stops.
 void recordingStarted(ISceneGraphEventsRecordingStartedEvent theEvent)
          Fired when node recording starts.
 void recordingStopped(ISceneGraphEventsRecordingStoppedEvent theEvent)
          Fired when node recording stops.
 void viewerAdded(ISceneGraphEventsViewerAddedEvent theEvent)
          Fired when a new viewer is added.
 void viewerRemoved(ISceneGraphEventsViewerRemovedEvent theEvent)
          Fired when a viewer is removed.
 

Method Detail

activeViewerChanged

void activeViewerChanged(ISceneGraphEventsActiveViewerChangedEvent theEvent)
                         throws IOException,
                                AutomationException
Fired when the active viewer changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

viewerAdded

void viewerAdded(ISceneGraphEventsViewerAddedEvent theEvent)
                 throws IOException,
                        AutomationException
Fired when a new viewer is added.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

viewerRemoved

void viewerRemoved(ISceneGraphEventsViewerRemovedEvent theEvent)
                   throws IOException,
                          AutomationException
Fired when a viewer is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interactionStopped

void interactionStopped(ISceneGraphEventsInteractionStoppedEvent theEvent)
                        throws IOException,
                               AutomationException
Fired when interaction stops.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recordingStarted

void recordingStarted(ISceneGraphEventsRecordingStartedEvent theEvent)
                      throws IOException,
                             AutomationException
Fired when node recording starts.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recordingStopped

void recordingStopped(ISceneGraphEventsRecordingStoppedEvent theEvent)
                      throws IOException,
                             AutomationException
Fired when node recording stops.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeDraw

boolean beforeDraw(ISceneGraphEventsBeforeDrawEvent theEvent)
                   throws IOException,
                          AutomationException
Fired when drawing starts.

Remarks

This event method is often used by an OpenGL routine that renders something before the main features in the scene are drawn. A good example is the scene background, such as sky/sun/moon etc. Just like the art of painting, one normally needs to draw the background first and then the main feature. So this method is generally for the background rendering. It can also be used for executing some routines other than drawing.

The BeforeDraw method returns a boolean value. When it's set to true, the SceneGraph's drawing is disabled, and you as a developer take control of the drawing (e.g. via OpenGL). Otherwise, the SceneGraph takes care of drawing as usual.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Returns:
The pbHandled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

afterDraw

void afterDraw(ISceneGraphEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException
Fired when drawing finishes.

Remarks

This event method is often used by an OpenGL routine that renders something after the main features in the scene are drawn. Just like the art of painting, one normally needs to draw the background first and then the main feature, followed by foreground features or other miscellaneous features. So this method is generally used for drawing of graphics after the background and the main features are drawn. It can also be used for executing some routines other than drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.