Best practices for using dynamic display

In this topic

• Using the dynamic display to enable the dynamic map
• Drawing in dynamic mode
• Drawing options
• Drawing marker symbols using the dynamic display API
• Direct OpenGL API
• Dynamic layers
• Drawing a dynamic layer
• Draw cycle sequence (including DynamicMapEvents)
• Drawing objects API
• Working with dynamic symbols
• Dynamic glyph factory
• Draw rates
• In conclusion

Using the dynamic display to enable the dynamic map

 

//Cast the dynamic map from the focus map.
IDynamicMap dynamicMap = m_hookHelper.FocusMap as IDynamicMap;
//Switch into dynamic mode.
if (!dynamicMap.DynamicMapEnabled)
    dynamicMap.DynamicMapEnabled = true;

' Cast the dynamic map from the focus map.
Dim dynamicMap As IDynamicMap = CType(m_hookHelper.FocusMap, IDynamicMap)
' Switch into dynamic mode.
If (Not dynamicMap.DynamicMapEnabled) Then
    dynamicMap.DynamicMapEnabled = True
End If

Drawing in dynamic mode

• Implementation of IDynamicLayer using IDynamicLayer.DrawDynamicLayer
• Listen to dynamic display events:  
• IDynamicMapEvents.BeforeDynamicDraw
• IDynamicMapEvents.AfterDynamicDraw

Drawing options

• Using dynamic display application programming interface (API)
• Direct OpenGL API

Drawing marker symbols using the dynamic display API

//Set the marker symbol.
m_dynamicSymbolProps.set_DynamicGlyph(esriDynamicSymbolType.esriDSymbolMarker,
    m_markerGlyphs[2]);

//Draw a marker symbol.
DynamicDisplay.DrawMarker(m_point);

'Set the marker symbol.
m_dynamicSymbolProps.DynamicGlyph(esriDynamicSymbolType.esriDSymbolMarker) = m_markerGlyphs(2)

'Draw a marker symbol.
DynamicDisplay.DrawMarker(m_point)

//Draw the item as a compound marker. This means that you do not have to draw the items and its
//accompanying labels separately, thus allowing you to write less code and better set
//the marker symbol.
m_dynamicSymbolProps.set_DynamicGlyph(esriDynamicSymbolType.esriDSymbolMarker,
    m_markerGlyphs[2]);

//Drawing a compound marker symbol using six strings.
m_dynamicCompoundMarker.DrawCompoundMarker6(m_point, "TOP", "BOTTOM", "Item " +
    Convert.ToString(r[0]), heading.ToString("###.##"), m_point.X.ToString(
    "###.#####"), m_point.Y.ToString("###.#####"));

'Draw the item as a compound marker. This means that you do not have to draw the items and its
'accompanying labels separately, thus allowing you to write less code and better set
'the marker symbol.
m_dynamicSymbolProps.DynamicGlyph(esriDynamicSymbolType.esriDSymbolMarker) = m_markerGlyphs(2)

'Drawing a compound marker symbol using six strings.
m_dynamicCompoundMarker.DrawCompoundMarker6
(m_point,
"TOP",
"BOTTOM",
"Item " & Convert.ToString(r(0)),
heading.ToString("###.##"),
m_point.X.ToString("###.#####"), m_point.Y.ToString("###.#####"))

Direct OpenGL API

GL.glDisable(GL.GL_TEXTURE_2D);
GL.glPushMatrix();
GL.glLoadIdentity();

// Draw a simple point.
GL.glBegin(GL.GL_POINTS);
GL.glColor3f(1.0f, 1.0f, 0.0f); //Yellow
GL.glVertex2f((float)x, (float)y);
GL.glEnd();

GL.glPopMatrix();
GL.glEnable(GL.GL_TEXTURE_2D);

GL.glDisable(GL.GL_TEXTURE_2D)
GL.glPushMatrix()
GL.glLoadIdentity()

' Draw a simple point.
GL.glBegin(GL.GL_POINTS)
GL.glColor3f(1.0F, 1.0F, 0.0F)
GL.glVertex2f(CType(x, Single), CType(y, Single))
GL.glEnd()

GL.glPopMatrix()
GL.glEnable(GL.GL_TEXTURE_2D)

Dynamic layers

	DrawDynamicLayer	Draws the layer to the specified display for the given draw phase.
	DynamicLayerDirty	Indicates if the dynamic layer has changed since last drawn for the specified draw phase.
	DynamicRecompileRate	Recompile Rate is the interval in milliseconds by which the dynamic layer draw method will be called, with the compiled draw phase.

Drawing a dynamic layer

• Immediate—Does not store draw commands. The draw commands of the immediate draw phase are immediately drawn.
• Compiled—Stores draw commands in a list. Dynamic display uses this list to draw the commands.  The list is recreated when the dirty flag has been set.

• Checks if recompile is needed by checking the DynamicLayerDirty with the immediate phase. If any dynamic layer has set the dirty flag for the immediate phase, all dynamic layers DrawDynamicLayer method will be called with the immediate draw phase.
• Draws the immediate phase and calls the DrawDynamicLayer method with the immediate phase.
• Checks if recompile is needed by checking the DynamicLayerDirty (with the compiled phase) and the DynamicRecompileRate property.
• If needed, recompiles the dynamic layer by calling the DrawDynamicLayer method with the compiled phase.
• Draws the compiled phase by drawing the display list.

/// <summary>
/// The dynamic layer draw method.
/// </summary>
/// <param name="DynamicDrawPhase">The current draw phase of the dynamic drawing.</param>
/// <param name="Display">The ActiveView's display.</param>
/// <param name="DynamicDisplay">The ActiveView's dynamic display.</param>
public void DrawDynamicLayer(ESRI.ArcGIS.Display.esriDynamicDrawPhase
    DynamicDrawPhase, ESRI.ArcGIS.Display.IDisplay Display,
    ESRI.ArcGIS.Display.IDynamicDisplay DynamicDisplay)
{
    //Make sure the current draw phase is immediate. In this example, there is no use of the
    //compiled draw phase. Use the esriDDPCompiled draw phase to draw semi-static items (items
    //whose update rate is lower than the display update rate).
    if (esriDynamicDrawPhase.esriDDPImmediate != DynamicDrawPhase)
        return ;

    //Actual drawing to take place here.          

    //Set the dirty flag to true to let the dynamic display that the layer needs to be redrawn.
    base.m_bIsImmediateDirty = true;
}

''' <summary>
''' The dynamic layer draw method.
''' </summary>
''' <param name="DynamicDrawPhase">The current draw phase of the dynamic drawing.</param>
''' <param name="Display">The ActiveView's display.</param>
''' <param name="DynamicDisplay">The ActiveView's dynamic display.</param>
Public Overrides Sub DrawDynamicLayer(ByVal DynamicDrawPhase As ESRI.ArcGIS.Display.esriDynamicDrawPhase, ByVal Display As ESRI.ArcGIS.Display.IDisplay, ByVal DynamicDisplay As ESRI.ArcGIS.Display.IDynamicDisplay)

'Make sure the current draw phase is immediate. In this example, there is no use of the
'compiled draw phase. Use the esriDDPCompiled draw phase in to draw semi-static items (items
'whose update rate is lower than the display update rate).
If esriDynamicDrawPhase.esriDDPImmediate <> DynamicDrawPhase Then
    Return
End If

'Actual drawing to take place here.

'Set the dirty flag to true to let the dynamic display that the layer needs to be redrawn.
m_bIsImmediateDirty = True
End Sub

• DynamicLayerDirty property is set to true
• DynamicRecompileRate time from the previous recompile time has elapsed

• Compiled phase—When the layer needs to be recompiled
• Immediate phase—When the layer needs to be redrawn

Draw cycle sequence (including DynamicMapEvents)

1. BeforeDynamicDraw(esriDMDPLayers) event is being fired
2. Layers are drawn; these are the layers that do not support IDynamicLayers (static layers)
3. AfterDynamicDraw(esriDMDPLayers) event is fired
4. BeforeDynamicDraw(esriDMDPDynamicLayers) event is fired
5. Dynamic layers are drawn
6. Immediate phase (esriDDPImmediate)
7. Compiled phase (esriDDPCompiled)
8. AfterDynamicDraw(esriDMDPDynamicLayers) event is fired

//Wire the DynamicMap after draw events.
((IDynamicMapEvents_Event)m_dynamicMap).AfterDynamicDraw += new
    IDynamicMapEvents_AfterDynamicDrawEventHandler(OnAfterDynamicDraw);

/// <summary>
/// DynamicMap AfterDynamicDraw event handler method.
/// </summary>
/// <param name="DynamicMapDrawPhase"></param>
/// <param name="Display"></param>
/// <param name="dynamicDisplay"></param>
void OnAfterDynamicDraw(esriDynamicMapDrawPhase DynamicMapDrawPhase, IDisplay
    Display, IDynamicDisplay dynamicDisplay)
{
    if (esriDynamicMapDrawPhase.esriDMDPDynamicLayers != DynamicMapDrawPhase)
        return ;

    //Do the drawings in here.
}

'Wire the DynamicMap after draw events.
AddHandler (CType(m_dynamicMap, IDynamicMapEvents_Event)).AfterDynamicDraw, AddressOf OnAfterDynamicDraw

''' <summary>
''' DynamicMap AfterDynamicDraw event handler method.
''' </summary>
''' <param name="DynamicMapDrawPhase"></param>
''' <param name="Display"></param>
''' <param name="dynamicDisplay"></param>

Private Sub OnAfterDynamicDraw(ByVal DynamicMapDrawPhase As esriDynamicMapDrawPhase, ByVal Display As IDisplay, ByVal dynamicDisplay As IDynamicDisplay)
    
    'Make sure the display is valid and that the layer is visible.
    If Nothing Is dynamicDisplay OrElse Nothing Is Display Then
        Return
    End If
    
    'Do the drawings in here.
    
End Sub

Drawing objects API

• IDynamicLayer.DrawDynamicLayer
• IDynamicMapEvents.BeforeDynamicDraw
• IDynamicMapEvents.AfterDynamicDraw

• Use the IDynamicDisplay interface to draw objects in map coordinates. Use the IDynamicCompoundMarkerSymbol interface as an additional option for drawing character marker symbols with surrounding attribute text.
• Use the IDynamicScreenDisplay interface to draw objects in screen coordinates. This origin uses the DisplayTransformation.DeviceFrame. In this case, it uses the upper left of the screen.
• Use the IDynamicGlyphFactory interface to create and delete dynamic glyphs. To get the interface to IDynamicGlyphFactory, use IDynamicDisplay. 
• Use the IDynamicSymbolProperties interface to control the dynamic symbols properties (dynamic marker, line, text, and fill). 
• Use the IDynamicGlyph interface to access properties of dynamic glyphs. A dynamic glyph is a handle to a resource. 
• Use the IDynamicMap interface to set the IDynamicMap.UseSubPixelRendering property. 

Working with dynamic symbols

• Symbol is a state of drawing:
• Controls the symbol through IDynamicSymbolProperties
• Needs to be synthesized through DynamicGlyph:
• DynamicGlyph provides resource for symbol
• DynamicSymbol types:
• esriDSymbolMarker
• esriDSymbolLine
• esriDSymbolText
• esriDSymbolFill
• DynamicGlyph types:
• esriDGlyphMarker
• esriDGlyphLine
• esriDGlyphText

• Get IDynamicGlyphFactory from the DynamicDisplay
• Create marker
• Load from bitmap (BMP)
• PictureMarker.CreateFromFile
• Create line
• Create text

	DynamicGlyph	Indicates the dynamic glyph for the specified dynamic symbol.
	GetColor	Indicates the color for the specified dynamic symbol.
	GetScale	Scales the dynamic symbol.
	Heading	Indicates the heading for the specified dynamic symbol. Only valid if dynamic symbol rotation alignment is a heading and for text and marker.
	RotationAlignment	Indicates the rotation alignment for the specified dynamic symbol. Only valid for text and marker.
	SetColor	Indicates the color for the specified dynamic symbol.
	SetScale	Scales the dynamic symbol.
	Smooth	Indicates whether the specified dynamic symbol will be smooth. Only valid for text, line, and marker.
	TextHorizontalAlignment	Indicates the horizontal alignment for the text dynamic symbol.
	TextVerticalAlignment	Indicates the vertical alignment for the text dynamic symbol.

Dynamic glyph factory

• Image of a typographical sign
• Image used in the visual representation of characters; how a character looks. A font is a set of glyphs
• A single unit of display in a font (Microsoft). It can be defined by the following:
• Outline (in OpenType)
• Bitmap
• Set of graphic commands
• DynamicGlyph:
• Glyph used in the dynamic display environment
• Handle of the resource for rendering dynamic symbols

	CreateDynamicGlyph	Creates a dynamic glyph from a symbol.
	CreateDynamicGlyphFromFile	Creates a dynamic glyph from a file.
	DeleteDynamicGlyph	Deletes a dynamic glyph from a symbol.
	DynamicGlyph	Retrieves a dynamic glyph from a glyph group.
	Init	Initializes the dynamic glyph factory.
	LoadDynamicGlyphsGroup	Loads an external dynamic glyph group from a file.
	UnloadDynamicGlyphsGroup	Unloads an external dynamic glyph group from a file.

General guidelines for drawing dynamic layers

public override void DrawDynamicLayer(ESRI.ArcGIS.Display.esriDynamicDrawPhase
    DynamicDrawPhase, ESRI.ArcGIS.Display.IDisplay Display,
    ESRI.ArcGIS.Display.IDynamicDisplay DynamicDisplay)
{
    ... if (m_bOnce)
    {
        //Cast the dynamic display into dynamic glyph factory.
        m_dynamicGlyphFactory = DynamicDisplay.DynamicGlyphFactory;
        //Cast the dynamic display into dynamic symbol properties.
        m_dynamicSymbolProps = DynamicDisplay as IDynamicSymbolProperties;
        //Cast the compound marker symbol.
        m_dynamicCompoundMarker = DynamicDisplay as IDynamicCompoundMarker;

        //Do other initializations in here.

        m_bOnce = false;
    }
    ...
}

Public Overrides Sub DrawDynamicLayer(ByVal DynamicDrawPhase As ESRI.ArcGIS.Display.esriDynamicDrawPhase, ByVal Display As ESRI.ArcGIS.Display.IDisplay, ByVal DynamicDisplay As ESRI.ArcGIS.Display.IDynamicDisplay)
...
If m_bOnce Then
    'Cast the dynamic display into dynamic glyph factory.
    m_dynamicGlyphFactory = DynamicDisplay.DynamicGlyphFactory
    'Cast the dynamic display into dynamic symbol properties.
    m_dynamicSymbolProps = TryCast(DynamicDisplay, IDynamicSymbolProperties)
    'Cast the compound marker symbol.
    m_dynamicCompoundMarker = TryCast(DynamicDisplay, IDynamicCompoundMarker)
    
    'Do other initializations in here.
    
    m_bOnce = False
End If

...

End Sub

Draw rates

• DynamicMapStarted and DynamicMapFinished—Fired on start and end of each dynamic map heart beat
• BeforeDynamicDraw and AfterDynamicDraw—Fired on before and after the dynamic display drawing

In conclusion

See Also: