platform sdk maps

About maps

In Security Center, a Map entity is a 2D surface (a floor plan, a site layout, or a georeferenced map) that displays the position of cameras, doors, areas, and other entities for operators in Security Desk. Each item placed on a map is a MapObject linked either to a Security Center entity or rendered as a custom shape, image, or text label. The Platform SDK reads and writes the map's contents through the Map entity:

Map map = engine.GetEntity<Map>(mapGuid);
ReadOnlyCollection<MapObject> existingObjects = map.MapObjects;

Common use cases:

• Place cameras, doors, or areas onto a map at specific coordinates, for example as part of an automated commissioning workflow.
• Attach decorative shapes (rectangles, ellipses, polygons, lines) or text labels to annotate floor plans.
• Update an existing map object's position, rotation, or appearance after the underlying entity is moved or renamed.

Map.MapObjects is read-only. Add, modify, or delete map objects through Map.Add, Map.Update, and Map.Remove.

Map object types

All concrete map object types live in Genetec.Sdk.Entities.Maps, derive from MapObject, and have a public parameterless constructor. The available types are:

• Entity-linked: CameraMapObject, DoorMapObject, UnitMapObject, AccessControlUnitMapObject, LprUnitMapObject, DeviceMapObject, ZoneMapObject, IntrusionAreaMapObject, AreaMapObject, MacroMapObject, MapMapObject, CustomEntityMapObject, AlarmMapObject, TilePluginMapObject, SequenceMapObject.
• Shapes: EllipseMapObject, RectangleMapObject, LineMapObject, PolygonMapObject.
• Image and text: ImageMapObject, TextBlockMapObject.

Most types derive from MapRelativeObject, which adds RelativeWidth and RelativeHeight for sizing. The base MapObject exposes the properties common to all types: Id, LinkedEntity, Latitude, Longitude, Rotation, LayerId, and ZIndex.

Adding a map object

Construct a concrete map object, set its properties, and call Map.Add. For entity-linked types, set the target entity's Guid on LinkedEntity:

var camera = new CameraMapObject
{
    LinkedEntity = cameraGuid,
    Latitude = 45.5,
    Longitude = -73.6,
    Rotation = 90.0,
    AngleOfView = 75.0,
    MaxDistance = 50.0,
};

map.Add(camera);

For decorative types, populate the type-specific properties:

var label = new TextBlockMapObject
{
    Text = "Lobby",
    Latitude = 45.5,
    Longitude = -73.6,
    FontSize = 14,
    FontIsBold = true,
};

map.Add(label);

Updating a map object

Modify an existing map object retrieved from Map.MapObjects and call Map.Update:

CameraMapObject camera = map.MapObjects
    .OfType<CameraMapObject>()
    .FirstOrDefault(o => o.LinkedEntity == cameraGuid);

if (camera != null)
{
    camera.Rotation = 180.0;
    camera.AngleOfView = 90.0;
    map.Update(camera);
}

To pull the latest server-side state of a map object back into a local instance, call Map.RefreshMapObject(mapObject). The method returns the refreshed object.

Removing a map object

Pass the map object's Id to Map.Remove:

map.Remove(camera.Id);

Id is the Guid assigned when the map object is added. It identifies the entry within the map and is independent of the linked entity's Guid.

Coordinates on georeferenced and non-georeferenced maps

Map.IsGeoReferenced indicates whether the map's coordinate system represents real geographic positions. On a georeferenced map, MapObject.Latitude and MapObject.Longitude are real coordinates and are validated when you call Add or Update. On a non-georeferenced map (a floor plan or schematic), the same properties are pixel-relative numbers within the image and are not validated.

See also

• For the Web SDK constructor syntax used to call Map.Add over HTTP, see Web SDK under the hood.
• For custom map object visualization in Security Desk and Config Tool, see Workspace SDK map extensions.
• For a runnable example, see the MapObjectsSample in the DAP repository.