ArcObjects Library Reference  

TargetZoom

About the Custom scene navigation commands Sample

[C#]

TargetZoom.cs

using System;
using ESRI.ArcGIS.Analyst3D;
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("6104E022-3859-4d89-9BEF-984375BA41F9")]

	public sealed class TargetZoom : 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 TargetZoom()
		{
			base.m_category = "Sample_SceneControl(C#)";
			base.m_caption = "Target Zoom";
			base.m_toolTip = "Zoom to Target";
			base.m_name = "Sample_SceneControl(C#)/TargetZoom";
			base.m_message = "Zoom to selected target";

			//Load resources
			string[] res = GetType().Assembly.GetManifestResourceNames();
			if(res.GetLength(0) > 0)
			{
				base.m_bitmap = new System.Drawing.Bitmap(GetType().Assembly.GetManifestResourceStream("sceneTools.TargetZoom.bmp"));
			}
			m_pCursor = new System.Windows.Forms.Cursor(GetType().Assembly.GetManifestResourceStream("sceneTools.targetzoom.cur"));
		
			m_pSceneHookHelper = new SceneHookHelperClass ();
		}

		public override bool Enabled
		{
			get
			{
				if(m_pSceneHookHelper.Scene == null)
					return false;
				else
					return true;
			}
		}
	
		public override void OnCreate(object hook)
		{
			m_pSceneHookHelper.Hook = hook;
		}
	
		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 = (ISceneGraph) m_pSceneHookHelper.SceneGraph;

			IPoint pNewTgt;
			object pOwner, pObject;

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

			if(pNewTgt == null) return;

			//Get the scene viewer's camera
			ICamera pCamera = (ICamera) m_pSceneHookHelper.Camera;

			//If orthographic (2D) type
			if(pCamera.ProjectionType == esri3DProjectionType.esriOrthoProjection )
			{
				//Set the camera's new target and zoom in
				pCamera.Target = pNewTgt;
				pCamera.Zoom(0.25);

				//Redraw the scene viewer
				pSceneGraph.ActiveViewer.Redraw(true);
			}
			else
			{
				//Get the camera's old target and observer
				IPoint pOldTgt = (IPoint) pCamera.Target;
				IPoint pOldObs = (IPoint) pCamera.Observer;

				//Set the camera's new target and get the new observer
				pCamera.Target = pNewTgt;
				pCamera.PolarUpdate(0.1, 0, 0, true);
 
				IPoint pNewObs = (IPoint) pCamera.Observer;

				//Get the duration in seconds of last redraw
				//and the average number of frames per second
				double dlastFrameDuration, dMeanFrameRate;
				pSceneGraph.GetDrawingTimeInfo(out dlastFrameDuration, out dMeanFrameRate);

				if(dlastFrameDuration < 0.01)
					dlastFrameDuration = 0.01;

				int iSteps;
				iSteps = (int) (2 / dlastFrameDuration);
				if(iSteps < 1)
					iSteps = 1;

				if(iSteps > 60)
					iSteps = 60;

				double dxObs, dyObs, dzObs;
				double dxTgt, dyTgt, dzTgt;

				dxObs = (pNewObs.X - pOldObs.X) / iSteps;
				dyObs = (pNewObs.Y - pOldObs.Y) / iSteps;
				dzObs = (pNewObs.Z - pOldObs.Z) / iSteps;

				dxTgt = (pNewTgt.X - pOldTgt.X) / iSteps;
				dyTgt = (pNewTgt.Y - pOldTgt.Y) / iSteps;
				dzTgt = (pNewTgt.Z - pOldTgt.Z) / iSteps;

				//Loop through each step moving the camera's observer and target from the
				//old positions to the new positions, refreshing the scene viewer each time
				for(int i=0; i < iSteps; i++)
				{
					pNewObs.X = pOldObs.X + (i * dxObs);
					pNewObs.Y = pOldObs.Y + (i * dyObs);
					pNewObs.Z = pOldObs.Z + (i * dzObs);

					pNewTgt.X = pOldTgt.X + (i * dxTgt);
					pNewTgt.Y = pOldTgt.Y + (i * dyTgt);
					pNewTgt.Z = pOldTgt.Z + (i * dzTgt);

					pCamera.Observer = pNewObs;
					pCamera.Target = pNewTgt;
					pSceneGraph.ActiveViewer.Redraw(true);
				}
			}
		}
	}
}

[Visual Basic .NET]

TargetZoom.vb

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

<ComClass(TargetZoom.ClassId, TargetZoom.InterfaceId, TargetZoom.EventsId)> _
Public NotInheritable Class TargetZoom
    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 = "10F310A0-9EB1-40E0-A5BD-81845662D17A"
    Public Const InterfaceId As String = "8B7EE6FE-F487-4773-ACF7-6332A627970C"
    Public Const EventsId As String = "3C2C7366-FF01-4670-A792-D50E8CCAA038"
#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 = "Target Zoom"
        MyBase.m_toolTip = "Zoom to Target"
        MyBase.m_name = "Sample_SceneControl(VB.NET)/TargetZoom"
        MyBase.m_message = "Zoom to selected target"

        'Load resources
        Dim res() As String = GetType(TargetZoom).Assembly.GetManifestResourceNames()
        If res.GetLength(0) > 0 Then
            MyBase.m_bitmap = New System.Drawing.Bitmap(GetType(TargetZoom).Assembly.GetManifestResourceStream("SceneToolsVB.TargetZoom.bmp"))
        End If
        m_pCursor = New System.Windows.Forms.Cursor(GetType(TargetZoom).Assembly.GetManifestResourceStream("SceneToolsVB.targetzoom.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.Scene Is Nothing) Then
                Return False
            Else
                Return True
            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)

        Dim pNewTgt 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.esriScenePickAll, True, pNewTgt, pOwner, pObject)

        If (pNewTgt Is Nothing) Then
            Return
        End If

        'Get the scene viewer's camera
        Dim pCamera As ICamera = CType(m_pSceneHookHelper.Camera, ICamera)

        'If orthographic (2D) type
        If (pCamera.ProjectionType = esri3DProjectionType.esriOrthoProjection) Then
            'Set the camera's new target and zoom in
            pCamera.Target = pNewTgt
            pCamera.Zoom(0.25)

            'Redraw the scene viewer
            pSceneGraph.ActiveViewer.Redraw(True)

        Else
            'Get the camera's old target and observer
            Dim pOldTgt As IPoint = CType(pCamera.Target, IPoint)
            Dim pOldObs As IPoint = CType(pCamera.Observer, IPoint)

            'Set the camera's new target and get the new observer
            pCamera.Target = pNewTgt
            pCamera.PolarUpdate(0.1, 0, 0, True)

            Dim pNewObs As IPoint = CType(pCamera.Observer, IPoint)

            'Get the duration in seconds of last redraw
            'and the average number of frames per second
            Dim dlastFrameDuration, dMeanFrameRate As Double
            pSceneGraph.GetDrawingTimeInfo(dlastFrameDuration, dMeanFrameRate)

            If (dlastFrameDuration < 0.01) Then
                dlastFrameDuration = 0.01
            End If

            Dim iSteps As Integer
            iSteps = 2 / dlastFrameDuration

            If (iSteps < 1) Then
                iSteps = 1
            End If

            If (iSteps > 60) Then
                iSteps = 60
            End If

            Dim dxObs, dyObs, dzObs As Double
            Dim dxTgt, dyTgt, dzTgt As Double

            dxObs = (pNewObs.X - pOldObs.X) / iSteps
            dyObs = (pNewObs.Y - pOldObs.Y) / iSteps
            dzObs = (pNewObs.Z - pOldObs.Z) / iSteps

            dxTgt = (pNewTgt.X - pOldTgt.X) / iSteps
            dyTgt = (pNewTgt.Y - pOldTgt.Y) / iSteps
            dzTgt = (pNewTgt.Z - pOldTgt.Z) / iSteps

            'Loop through each step moving the camera's observer and target from the
            'old positions to the new positions, refreshing the scene viewer each time
            Dim i As Integer
            For i = 0 To iSteps
                pNewObs.X = pOldObs.X + (i * dxObs)
                pNewObs.Y = pOldObs.Y + (i * dyObs)
                pNewObs.Z = pOldObs.Z + (i * dzObs)

                pNewTgt.X = pOldTgt.X + (i * dxTgt)
                pNewTgt.Y = pOldTgt.Y + (i * dyTgt)
                pNewTgt.Z = pOldTgt.Z + (i * dzTgt)

                pCamera.Observer = pNewObs
                pCamera.Target = pNewTgt
                pSceneGraph.ActiveViewer.Redraw(True)
            Next i

        End If
    End Sub
End Class