ValidateAutoCamera Method

In This Topic

Validates the input CIMAutoCamera for the given ArcGIS.Core.CIM.CIMAutoCamera.Source and ArcGIS.Core.CIM.CIMAutoCamera.AutoCameraType values. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function ValidateAutoCamera( _
   ByVal autoCamera As CIMAutoCamera _
) As Boolean

public bool ValidateAutoCamera( 
   CIMAutoCamera autoCamera
)

Parameters

autoCamera: The auto camera to validate

Return Value

True if the autocamera is valid for this mapframe.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

An auto camera is used to set map frame display constraints. Display constraints are used to set limits on the map extent within the map frame. Refer to Map frame constraints in the Pro product help for more information on constraints. Only required settings for the given AutoCameraSource will be validated. Optional, or "non-required", settings are ignored (eg autoCamera.Margin). Validation criteria differ depending on the ArcGIS.Core.CIM.CIMAutoCamera.Source and ArcGIS.Core.CIM.CIMAutoCamera.AutoCameraType values. The criteria are as follows:
o ArcGIS.Core.CIM.AutoCameraSource.None: there are no required settings. An autocamera with source value AutoCameraSource.None is always considered valid.
o ArcGIS.Core.CIM.AutoCameraSource.Fixed: autoCamera.AutoCameraType is evaluated as follows:
o ArcGIS.Core.CIM.AutoCameraType.Extent: ArcGIS.Core.CIM.CIMAutoCamera.Extent must be present. If ArcGIS.Core.CIM.CIMAutoCamera.IntersectLayerPath is specified it must be the URI of a valid layer in the mapframe's map.
o ArcGIS.Core.CIM.AutoCameraType.Center: ArcGIS.Core.CIM.CIMAutoCamera.Camera must be present. If ArcGIS.Core.CIM.CIMAutoCamera.IntersectLayerPath is specified it must be the URI of a valid layer in the mapframe's map.
o ArcGIS.Core.CIM.AutoCameraType.CenterAndScale: ArcGIS.Core.CIM.CIMAutoCamera.Camera must be present.
o ArcGIS.Core.CIM.AutoCameraType.Scale: ArcGIS.Core.CIM.CIMAutoCamera.Camera must be present.
Note: the X,Y of the camera, when present, must fall within the domain of the mapframe's map spatial reference. o ArcGIS.Core.CIM.AutoCameraSource.MapFrameLink: autoCamera.AutoCameraType is evaluated as follows:
o ArcGIS.Core.CIM.AutoCameraType.Extent:
o ArcGIS.Core.CIM.AutoCameraType.Center:
ArcGIS.Core.CIM.CIMAutoCamera.MapFrameLinkName must be present and point to a valid map frame in the same layout other than itself. If ArcGIS.Core.CIM.CIMAutoCamera.IntersectLayerPath is specified it must be the URI of a valid layer in the mapframe's map.
o ArcGIS.Core.CIM.AutoCameraType.CenterAndScale:
o ArcGIS.Core.CIM.AutoCameraType.Scale:
ArcGIS.Core.CIM.CIMAutoCamera.MapFrameLinkName must be present and point to a valid map frame in the same layout other than itself
o ArcGIS.Core.CIM.AutoCameraSource.MapSeriesLink A map series must be present in the layout. It can be enabled or disabled. autoCamera.AutoCameraType is evaluated as follows:
o ArcGIS.Core.CIM.AutoCameraType.Extent:
o ArcGIS.Core.CIM.AutoCameraType.Center:
If ArcGIS.Core.CIM.CIMAutoCamera.IntersectLayerPath is specified it must be the URI of a valid layer in the mapframe's map.
Note:Extent and Camera properties are ignored.
o ArcGIS.Core.CIM.AutoCameraType.CenterAndScale: invalid autoCamera.AutoCameraType.
o ArcGIS.Core.CIM.AutoCameraType.Scale: invalid autoCamera.AutoCameraType.

Example

SetAutoCameraNone

{
  //Note: Must be on QueuedTask.Run
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.None;
  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraFixedExtent

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.Fixed;
  autoCamera.AutoCameraType = AutoCameraType.Extent;

  var mf_extent = mapFrame.GetViewExtent();

  var extent = EnvelopeBuilderEx.CreateEnvelope(
    400748.62, 800296.4, 1310669.05, 1424520.74, mapFrame.Map.SpatialReference);
  autoCamera.Extent = extent;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraFixedCenter

{
  //Note: run within the QueuedTask
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.Fixed;
  autoCamera.AutoCameraType = AutoCameraType.Center;

  var camera = mapFrame.GetMapView(LayoutView.Active).Camera;
  var center = mapFrame.GetViewCenter();

  //var extent = EnvelopeBuilderEx.CreateEnvelope(
  //	400748.62, 800296.4, 1310669.05, 1424520.74, mf.Map.SpatialReference);
  //autoCamera.Extent = extent;

  var camera2 = new CIMViewCamera()
  {
    Heading = 0,
    Pitch = -90,
    Roll = 0,
    Scale = 21169571,
    X = 855708,
    Y = 1112409,
    Z = double.NaN
  };
  autoCamera.Camera = camera2;
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraFixedScale

{
  //Note: run within the QueuedTask

  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.Fixed;
  autoCamera.AutoCameraType = AutoCameraType.Scale;

  var camera = mapFrame.GetMapView(LayoutView.Active).Camera;
  var center = mapFrame.GetViewCenter();

  //var extent = EnvelopeBuilderEx.CreateEnvelope(
  //	400748.62, 800296.4, 1310669.05, 1424520.74, mf.Map.SpatialReference);
  //autoCamera.Extent = extent;

  var camera2 = new CIMViewCamera()
  {
    Heading = 0,
    Pitch = -90,
    Roll = 0,
    Scale = 20000571,
    X = 1310669.0 + ((400748.5 - 1310669.0) / 2.0),
    Y = 800296.4 + ((1424520.74 - 800296.4) / 2.0),
    Z = double.NaN
  };
  autoCamera.Camera = camera2;
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  //autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);

}

SetAutoCameraLinkedExtent

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapFrameLink;
  autoCamera.AutoCameraType = AutoCameraType.Extent;
  autoCamera.MapFrameLinkName = "mapFrameLink";

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraLinkedCenter

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapFrameLink;
  autoCamera.AutoCameraType = AutoCameraType.Center;
  autoCamera.MapFrameLinkName = "mapFrameLink";
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraLinkedCenterAndScale

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapFrameLink;
  autoCamera.AutoCameraType = AutoCameraType.CenterAndScale;
  autoCamera.MapFrameLinkName = "mapFrameLink";
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraLinkedScale

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapFrameLink;
  autoCamera.AutoCameraType = AutoCameraType.Scale;
  autoCamera.MapFrameLinkName = "mapFrameLink";
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraLinkedMapSeriesShape

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapSeriesLink;
  autoCamera.AutoCameraType = AutoCameraType.Extent;
  //autoCamera.MapFrameLinkName = mapFrameLink;
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraLinkedMapSeriesCenter

{
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.MapSeriesLink;
  autoCamera.AutoCameraType = AutoCameraType.Center;

  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  autoCamera.IntersectLayerPath = states.URI;

  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

SetAutoCameraFixedCenterAndScale

{
  //Note: run within the QueuedTask
  var autoCamera = mapFrame.GetAutoCamera();
  autoCamera.Source = AutoCameraSource.Fixed;
  autoCamera.AutoCameraType = AutoCameraType.CenterAndScale;

  var camera = mapFrame.GetMapView(LayoutView.Active).Camera;
  var center = mapFrame.GetViewCenter();

  //var extent = EnvelopeBuilderEx.CreateEnvelope(
  //	400748.62, 800296.4, 1310669.05, 1424520.74, mf.Map.SpatialReference);
  //autoCamera.Extent = extent;

  var camera2 = new CIMViewCamera()
  {
    Heading = 0,
    Pitch = -90,
    Roll = 0,
    Scale = 21169571,
    X = 1310669.0 + ((400748.5 - 1310669.0) / 2.0),
    Y = 800296.4 + ((1424520.74 - 800296.4) / 2.0),
    Z = double.NaN
  };
  autoCamera.Camera = camera2;
  var states = mapFrame.Map.GetLayersAsFlattenedList().First(l => l.Name == "State_Polygons");
  //autoCamera.IntersectLayerPath = states.URI;
  if (mapFrame.ValidateAutoCamera(autoCamera) &&
    !mapFrame.IsMapSeriesMapFrame())
    mapFrame.SetAutoCamera(autoCamera);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

MapFrame Class
MapFrame Members

Send feedback