ArcObjects Library Reference  

SelectFeatures

About the Custom scene navigation commands Sample

[C#]

SelectFeatures.cs

using System;
using ESRI.ArcGIS.Analyst3D;
using ESRI.ArcGIS.Carto;
using ESRI.ArcGIS.Geometry;
using ESRI.ArcGIS.Controls;
using ESRI.ArcGIS.ADF.BaseClasses;
using ESRI.ArcGIS.ADF.CATIDs;
using System.Runtime.InteropServices;

namespace sceneTools
{
	[ClassInterface(ClassInterfaceType.None)]
	[Guid("7B9ECCAC-4B67-4795-9E1E-1EAF7CC64CE4")]

	public sealed class SelectFeatures : BaseTool
	{
        #region COM Registration Function(s)
        [ComRegisterFunction()]
        [ComVisible(false)]
        static void RegisterFunction(Type registerType)
        {
            // Required for ArcGIS Component Category Registrar support
            ArcGISCategoryRegistration(registerType);

            //
            // TODO: Add any COM registration code here
            //
        }

        [ComUnregisterFunction()]
        [ComVisible(false)]
        static void UnregisterFunction(Type registerType)
        {
            // Required for ArcGIS Component Category Registrar support
            ArcGISCategoryUnregistration(registerType);

            //
            // TODO: Add any COM unregistration code here
            //
        }

        #region ArcGIS Component Category Registrar generated code
        /// <summary>
        /// Required method for ArcGIS Component Category registration -
        /// Do not modify the contents of this method with the code editor.
        /// </summary>
        private static void ArcGISCategoryRegistration(Type registerType)
        {
            string regKey = string.Format("HKEY_CLASSES_ROOT\\CLSID\\{{{0}}}", registerType.GUID);
            ControlsCommands.Register(regKey);

        }
        /// <summary>
        /// Required method for ArcGIS Component Category unregistration -
        /// Do not modify the contents of this method with the code editor.
        /// </summary>
        private static void ArcGISCategoryUnregistration(Type registerType)
        {
            string regKey = string.Format("HKEY_CLASSES_ROOT\\CLSID\\{{{0}}}", registerType.GUID);
            ControlsCommands.Unregister(regKey);

        }

        #endregion
        #endregion
    
		private System.Windows.Forms.Cursor m_pCursor;
		private ISceneHookHelper m_pSceneHookHelper;

		public SelectFeatures()
		{
			base.m_category = "Sample_SceneControl(C#)";
			base.m_caption = "Select Features";
			base.m_toolTip = "Select Features";
			base.m_name = "Sample_SceneControl(C#)/SelectFeatures";
			base.m_message = "Select features by clicking";

			//Load resources
			string[] res = GetType().Assembly.GetManifestResourceNames();
			if(res.GetLength(0) > 0)
			{
				base.m_bitmap = new System.Drawing.Bitmap(GetType().Assembly.GetManifestResourceStream("sceneTools.SelectFeatures.bmp"));
			}
			m_pCursor = new System.Windows.Forms.Cursor(GetType().Assembly.GetManifestResourceStream("sceneTools.SelectFeatures.cur"));
		
			m_pSceneHookHelper = new SceneHookHelperClass ();
		}
        
		public override void OnCreate(object hook)
		{
			m_pSceneHookHelper.Hook = hook;
		}
	
		public override bool Enabled
		{
			get
			{
				if(m_pSceneHookHelper.Hook == null || m_pSceneHookHelper.Scene == null)
					return false;
				else
				{
					IScene pScene = (IScene) m_pSceneHookHelper.Scene;

					//Disable if no layer
					if(pScene.LayerCount == 0)
						return false;

					//Enable if any selectable layers
					bool bSelectable = false;

					IEnumLayer pEnumLayer;
					pEnumLayer = pScene.get_Layers(null, true);
					pEnumLayer.Reset();

					ILayer pLayer = (ILayer) pEnumLayer.Next();

					//Loop through the scene layers
					do
					{
						//Determine if there is a selectable feature layer
						if(pLayer is IFeatureLayer)
						{
							IFeatureLayer pFeatureLayer = (IFeatureLayer) pLayer;
							if(pFeatureLayer.Selectable == true)
							{
								bSelectable = true;
								break;
							}
						}
						pLayer = pEnumLayer.Next();
					}
					while(pLayer != null);
				
					return bSelectable;
				}
			}
		}
	
		public override int Cursor
		{
			get
			{
				return m_pCursor.Handle.ToInt32();
			}
		}
	
		public override bool Deactivate()
		{
			return true;
		}
	
		public override void OnMouseUp(int Button, int Shift, int X, int Y)
		{
			//Get the scene graph
			ISceneGraph pSceneGraph = m_pSceneHookHelper.SceneGraph;

			//Get the scene
			IScene pScene = (IScene) m_pSceneHookHelper.Scene;

			IPoint pPoint;
			object pOwner, pObject;

			//Translate screen coordinates into a 3D point
			pSceneGraph.Locate(pSceneGraph.ActiveViewer, X, Y, esriScenePickMode.esriScenePickGeography, true, out pPoint, out pOwner, out pObject);

			//Get a selection environment
			ISelectionEnvironment pSelectionEnv;
			pSelectionEnv = new SelectionEnvironmentClass();
			
			if(Shift == 0)
			{
				pSelectionEnv.CombinationMethod = ESRI.ArcGIS.Carto.esriSelectionResultEnum.esriSelectionResultNew;

				//Clear previous selection
				if(pOwner == null)
				{
					pScene.ClearSelection();
					return;
				}
			}
			else
				pSelectionEnv.CombinationMethod = ESRI.ArcGIS.Carto.esriSelectionResultEnum.esriSelectionResultAdd;

			//If the layer is a selectable feature layer
			if(pOwner is IFeatureLayer)
			{
				IFeatureLayer pFeatureLayer = (IFeatureLayer) pOwner;

				if(pFeatureLayer.Selectable == true)
				{
					//Select by Shape
					pScene.SelectByShape(pPoint, pSelectionEnv, false);
				}
			}

			//Refresh the scene viewer
			pSceneGraph.RefreshViewers();
		}
	}
}

[Visual Basic .NET]

SelectFeatures.vb

Imports ESRI.ArcGIS.Analyst3D
Imports ESRI.ArcGIS.Carto
Imports ESRI.ArcGIS.GeomeTry
Imports ESRI.ArcGIS.Controls
Imports ESRI.ArcGIS.ADF.BaseClasses
Imports ESRI.ArcGIS.ADF.CATIDs
Imports System.Runtime.InteropServices

<ComClass(SelectFeatures.ClassId, SelectFeatures.InterfaceId, SelectFeatures.EventsId)> _
Public NotInheritable Class SelectFeatures
    Inherits BaseTool

#Region "COM GUIDs"
    ' These  GUIDs provide the COM identity for this class 
    ' and its COM interfaces. If you change them, existing 
    ' clients will no longer be able to access the class.
    Public Const ClassId As String = "24AADD40-4708-4B59-8F1F-3CC68FA510F6"
    Public Const InterfaceId As String = "93A59666-1479-47C2-96E2-A079ED988A47"
    Public Const EventsId As String = "9DD4B578-050E-418D-BE35-1B41572AC49D"
#End Region
#Region "COM Registration Function(s)"
    <ComRegisterFunction(), ComVisibleAttribute(False)> _
    Public Shared Sub RegisterFunction(ByVal registerType As Type)
        ' Required for ArcGIS Component Category Registrar support
        ArcGISCategoryRegistration(registerType)

        'Add any COM registration code after the ArcGISCategoryRegistration() call

    End Sub

    <ComUnregisterFunction(), ComVisibleAttribute(False)> _
    Public Shared Sub UnregisterFunction(ByVal registerType As Type)
        ' Required for ArcGIS Component Category Registrar support
        ArcGISCategoryUnregistration(registerType)

        'Add any COM unregistration code after the ArcGISCategoryUnregistration() call

    End Sub

#Region "ArcGIS Component Category Registrar generated code"
    ''' <summary>
    ''' Required method for ArcGIS Component Category registration -
    ''' Do not modify the contents of this method with the code editor.
    ''' </summary>
    Private Shared Sub ArcGISCategoryRegistration(ByVal registerType As Type)
        Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
        ControlsCommands.Register(regKey)

    End Sub
    ''' <summary>
    ''' Required method for ArcGIS Component Category unregistration -
    ''' Do not modify the contents of this method with the code editor.
    ''' </summary>
    Private Shared Sub ArcGISCategoryUnregistration(ByVal registerType As Type)
        Dim regKey As String = String.Format("HKEY_CLASSES_ROOT\CLSID\{{{0}}}", registerType.GUID)
        ControlsCommands.Unregister(regKey)

    End Sub

#End Region
#End Region

    Private m_pCursor As System.Windows.Forms.Cursor
    Private m_pSceneHookHelper As ISceneHookHelper

  ' A creatable COM class must have a Public Sub New() 
  ' with no parameters, otherwise, the class will not be 
  ' registered in the COM registry and cannot be created 
  ' via CreateObject.
    Public Sub New()
        MyBase.New()

        MyBase.m_category = "Sample_SceneControl(VB.NET)"
        MyBase.m_caption = "Select Features"
        MyBase.m_toolTip = "Select Features"
        MyBase.m_name = "Sample_SceneControl(VB.NET)/SelectFeatures"
        MyBase.m_message = "Select features by clicking"

        'Load resources
        Dim res() As String = GetType(SelectFeatures).Assembly.GetManifestResourceNames()
        If res.GetLength(0) > 0 Then
            MyBase.m_bitmap = New System.Drawing.Bitmap(GetType(SelectFeatures).Assembly.GetManifestResourceStream("SceneToolsVB.SelectFeatures.bmp"))
        End If
        m_pCursor = New System.Windows.Forms.Cursor(GetType(SelectFeatures).Assembly.GetManifestResourceStream("SceneToolsVB.SelectFeatures.cur"))

        m_pSceneHookHelper = New SceneHookHelperClass
    End Sub

    Public Overrides Sub OnCreate(ByVal hook As Object)
        m_pSceneHookHelper.Hook = hook
    End Sub

    Public Overrides ReadOnly Property Enabled() As Boolean
        Get
            If (m_pSceneHookHelper.Hook Is Nothing Or m_pSceneHookHelper.Scene Is Nothing) Then
                Return False
            Else
                Dim pScene As IScene = CType(m_pSceneHookHelper.Scene, IScene)

                'Disable if no layer
                If (pScene.LayerCount = 0) Then
                    Return False
                End If

                'Enable if any selectable layers
                Dim bSelectable As Boolean
                bSelectable = False

                Dim pEnumLayer As IEnumLayer
                pEnumLayer = pScene.Layers(Nothing, True)
                pEnumLayer.Reset()

                Dim pLayer As ILayer = CType(pEnumLayer.Next(), ILayer)

                'Loop through the scene layers
                Do Until (pLayer Is Nothing)
                    'Determine if there is a selectable feature layer
                    If TypeOf pLayer Is IFeatureLayer Then
                        Dim pFeatureLayer As IFeatureLayer = CType(pLayer, IFeatureLayer)

                        If (pFeatureLayer.Selectable = True) Then
                            bSelectable = True
                            Exit Do
                        End If
                    End If
                    pLayer = pEnumLayer.Next()
                Loop

                Return bSelectable
            End If
        End Get
    End Property

    Public Overrides ReadOnly Property Cursor() As Integer
        Get
            Return m_pCursor.Handle.ToInt32()
        End Get
    End Property

    Public Overrides Function Deactivate() As Boolean
        Return True
    End Function

    Public Overrides Sub OnMouseUp(ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Integer, ByVal Y As Integer)

        'Get the scene graph
        Dim pSceneGraph As ISceneGraph = CType(m_pSceneHookHelper.SceneGraph, ISceneGraph)

        'Get the scene
        Dim pScene As IScene = CType(m_pSceneHookHelper.Scene, IScene)

        Dim pPoint As IPoint = Nothing
        Dim pOwner As Object = Nothing, pObject As Object = Nothing

        'Translate screen coordinates into a 3D point
        pSceneGraph.Locate(pSceneGraph.ActiveViewer, X, Y, esriScenePickMode.esriScenePickGeography, True, pPoint, pOwner, pObject)

        'Get a selection environment
        Dim pSelectionEnv As ISelectionEnvironment
        pSelectionEnv = New SelectionEnvironmentClass

        If (Shift = 0) Then
            pSelectionEnv.CombinationMethod = ESRI.ArcGIS.Carto.esriSelectionResultEnum.esriSelectionResultNew

            'Clear previous selection
            If (pOwner Is Nothing) Then
                pScene.ClearSelection()
                Return
            End If
        Else
            pSelectionEnv.CombinationMethod = ESRI.ArcGIS.Carto.esriSelectionResultEnum.esriSelectionResultAdd
        End If

        'If the layer is a selectable feature layer
        If TypeOf pOwner Is IFeatureLayer Then
            Dim pFeatureLayer As IFeatureLayer = CType(pOwner, IFeatureLayer)
            If (pFeatureLayer.Selectable = True) Then
                'Select by Shape
                pScene.SelectByShape(pPoint, pSelectionEnv, False)
            End If

            'Refresh the scene viewer
            pSceneGraph.RefreshViewers()
        End If
    End Sub
End Class