ArcGIS Developer Help

ControlsGlobeSwipeToolClass Class

Interactively reveals layers on a globe.

Product Availability

Available with ArcGIS Engine.

Description

The CLSID of this command is: {790854A7-33E5-4E35-8DBB-926FCCD83189}.

This command works with the ToolbarControl, GlobeControl and ArcGlobe.

This command requires a 3DAnalyst extension. Any ArcGIS Engine application using this command must check out a 3DAnalyst extension using either the LicenseControl or the AoInitialize object.

This command must be used in conjunction with CommandsEnvironment singleton object. Failure to instantiate the CommandsEnvironment singleton object results in this command internally using it's own instance of the CommandsEnvironment object and appearing disabled to the end user.

This command gets the layer to be swiped from the ILayerEffectProperties::SwipeLayer property on the CommandsEnvironment singleton. This can be set programmatically or interactively by the end user selecting a layer from the ControlsGlobeLayerListToolControl.

Interfaces

Interfaces	Description
ICommand (esriSystemUI)	Provides access to members that define a COM command.
ITool (esriSystemUI)	Provides access to members that define a tool.

[C#]

using ESRI.ArcGIS.Controls;
using ESRI.ArcGIS.SystemUI;

public partial class Form1 : Form
{
    private CommandsEnvironmentClass m_CommandsEnvironment = new CommandsEnvironmentClass();
    private void Form1_Load(object sender, System.EventArgs e)
    {
        //Set buddy control
        axToolbarControl1.SetBuddyControl(axGlobeControl1);
        //Add items to ToolbarControl
        axToolbarControl1.AddItem("esriControls.ControlsGlobeOpenDocCommand", -1, -1, false, 0, esriCommandStyles.esriCommandStyleIconOnly);
        axToolbarControl1.AddItem("esriControls.ControlsGlobeSwipeTool", -1, -1, true, 0, esriCommandStyles.esriCommandStyleIconOnly);
        axToolbarControl1.AddItem("esriControls.ControlsGlobeLayerListToolControl", -1, -1, false, 0, esriCommandStyles.esriCommandStyleIconOnly);
    }
}

[Visual Basic .NET]

Imports ESRI.ArcGIS.Controls
Imports ESRI.ArcGIS.SystemUI

Public Class Form1

    Private m_CommandsEnvironment As New CommandsEnvironmentClass

    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        'Set buddy control
        AxToolbarControl1.SetBuddyControl(AxGlobeControl1)
        'Add items to ToolbarControl
        AxToolbarControl1.AddItem("esriControls.ControlsGlobeOpenDocCommand", -1, -1, False, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsGlobeSwipeTool", -1, -1, True, 0, esriCommandStyles.esriCommandStyleIconOnly)
        AxToolbarControl1.AddItem("esriControls.ControlsGlobeLayerListToolControl", -1, -1, False, 0, esriCommandStyles.esriCommandStyleIconOnly)
    End Sub

End Class