com.esri.arcgis.animation
Interface IVideoExportUtils

All Superinterfaces:

Serializable

All Known Subinterfaces:

IVideoExportUtils2

All Known Implementing Classes:

AGAnimationUtils

public interface IVideoExportUtils
extends Serializable

Provides access to video export utility methods.

Remarks

This interface exposes some methods for capturing bitmaps from the application display. It can be used to develop custom animation exporters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	getOffScreenBitmapHandle(IAGAnimationContainer pContainer, int[] phBitmap) The bitmap handle from an offscreen rendering buffer.
void	getOffScreenTiledBitmapHandle(IAGAnimationContainer pContainer, tagRECT pOutputRect, int[] phBitmap) The tiled bitmap handle from an offscreen rendering buffer.
void	getWindowBitmapHandle(IAGAnimationContainer pContainer, int[] phBitmap) The bitmap handle from an OpenGL or GDI rendered window.
boolean	isBBoxNavigationMode(IAGAnimationContainer pContainer) Indicates bounding box navigation mode.
void	restorePreviousContext(IAGAnimationContainer pContainer) Restores the OpenGL rendering context after offscreen video export.
void	setBBoxNavigationMode(IAGAnimationContainer pContainer, boolean pbBBoxMode) Indicates bounding box navigation mode.

Method Detail

restorePreviousContext

void restorePreviousContext(IAGAnimationContainer pContainer)
                            throws IOException,
                                   AutomationException

Restores the OpenGL rendering context after offscreen video export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffScreenBitmapHandle

void getOffScreenBitmapHandle(IAGAnimationContainer pContainer,
                              int[] phBitmap)
                              throws IOException,
                                     AutomationException

The bitmap handle from an offscreen rendering buffer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWindowBitmapHandle

void getWindowBitmapHandle(IAGAnimationContainer pContainer,
                           int[] phBitmap)
                           throws IOException,
                                  AutomationException

The bitmap handle from an OpenGL or GDI rendered window.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffScreenTiledBitmapHandle

void getOffScreenTiledBitmapHandle(IAGAnimationContainer pContainer,
                                   tagRECT pOutputRect,
                                   int[] phBitmap)
                                   throws IOException,
                                          AutomationException

The tiled bitmap handle from an offscreen rendering buffer.

Remarks

Using this method, you can export a custom resolution image (bitmap) from map or globe. The bitmap handle returned can be used to create a bitmap on disk. This method makes use of the offscreen rendering, which allows you to capture the bitmap even if a window is covering the main viewer. Offscreen rendering works best if your application window is maximized.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

pOutputRect - A Structure: com.esri.arcgis.system.tagRECT (in)

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBBoxNavigationMode

boolean isBBoxNavigationMode(IAGAnimationContainer pContainer)
                             throws IOException,
                                    AutomationException

Indicates bounding box navigation mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

Returns:

The pbBBoxMode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBBoxNavigationMode

void setBBoxNavigationMode(IAGAnimationContainer pContainer,
                           boolean pbBBoxMode)
                           throws IOException,
                                  AutomationException

Indicates bounding box navigation mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

pbBBoxMode - The pbBBoxMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.