Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Display Control / ENVIPortal::Animate

ENVIPortal::Animate

ENVIPortal::Animate

The Animate method controls various animation actions between layers displayed in the portal.

Example


; Launch the application
e = ENVI()
 
; Create an ENVIRaster
file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $
  SUBDIRECTORY = ['data'])
raster = e.OpenRaster(file)
 
; Create two layers
view = e.GetView()
layer1 = view.CreateLayer(raster)
layer2 = view.CreateLayer(raster, /CIR)
 
; Create a portal
portal = view.CreatePortal()
 
; Animate portal
portal.Animate, 2.0, /FLICKER

Syntax


ENVIPortal.Animate, Speed [, Keywords=value]

Arguments


Speed

A floating-point value representing the length of time that each layer is displayed in the portal (in seconds). The default value is 0.5.

Keywords


Keywords are applied only during the initial creation of the object.

If you do not set any animation keyword, the FLICKER keyword is automatically set.

BLEND

Set this keyword to exclusively enable blending in the portal.

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

FLICKER

Set this keyword to exclusively enable flickering in the portal. This is the method default behavior.

SWIPE

Set this keyword to exclusively enable swiping in the portal.

OFF

Set this keyword to turn off the portal animation.

Version History


ENVI 5

Introduced

API Version


3.1.0

See Also


ENVIView::CreatePortal, ENVIPortal



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us