IMcViewSequenceFrameRange Property

Property Value

Type: Object

All sequence operations are limited to the frames in the SequenceFrameRange. That is, while the FrameToDisplay property may be directly set to any frame index from 0 through ImageToDisplay.FrameCount-1, SequencePlayForward, SequencePlayBackward, SequenceStepForward and SequenceStepBackward will set the FrameToDisplay only from the SequenceFrameRange. Of course, by default the SequenceFrameRange is all ImageToDisplay frames. The SequenceFrameRange property is exposed as VARIANT which may contain a 1D array of the FrameIndex values of the selected frames. If all frames are selected (because an Empty, Missing or scalar -1 VARIANT was assigned as the SequenceFrameRange), then a scalar -1 is returned to indicate that all frames are selected for processing in their natural order. On assignment, you specify the frames to be active by supplying an IMcFrames collection, by supplying one or more IMcFrame instances or by supplying FrameIndex values of the frames to be active. The source selector for an SequenceFrameRange assignment can be Empty or Missing VARIANT or a scalar value of -1 indicating that all frames are active. The selector may be an array of VARIANT, in which case the contents of each VARIANT are added to the SequenceFrameRange. Each VARIANT may be a single scalar index value (if negative, then all frames are added), or it may be a single scalar LONGRANGE giving Start and End frame indices, or it may be an array of index values or an array of LONGRANGE index ranges. In addition, it may be an IMcFrame object instance or an array of them; each of these IMcFrame instances must one of the frames in this IMcImage's frame list (see the Frame property). Finally, the assigning selector may be an IMcFrames collection (or an array of them) with a ParentImage the same as this the ImageToDisplay. In this case the entire contents of the IMcFrames collection(s) are added to the SequenceFrameRange. If this McView instance is the McWindow.View property of the McApplication.ActiveWindow, then the ImageToDisplay.ActiveFrameRange will follow an assignment to SequenceFrameRange (see Example 1). Likewise (see Example 2), an assignment to ThisApplication.ActiveImage.ActiveFrameRange will set the ActiveWindow.View.SequenceFrameRange (but not that of any other McWindow's showing the ActiveImage).

'Example 1 - Set SequenceFrameRange to frames 1,2,3,6,5 in that order
Dim rngA As LONGRANGE
rngA.Start = 1
rngA.End = 3
Dim rngB As LONGRANGE
rngB.Start = 6
rngB.End = 5
Dim rngArray(0 To 1) As LONGRANGE
rngArray(0) = rngA
rngArray(1) = rngB
Dim wnd As McWindow=ThisApplication.ActiveWindow
wnd.ImageView.SequenceFrameRange = rngArray
Debug.Print "AFR= " & ThisApplication.GlobalTools.McToText(ThisApplication.ActiveImage.ActiveFrameRange).Value & _
" AW.SFR= " & ThisApplication.GlobalTools.McToText(wnd.ImageView.SequenceFrameRange).Value
'Note that ThisApplication.ActiveImage.ActiveFrameRange gets set too
'Example 2 - Set ActiveFrameRange to frames 10 to 20
Dim rngC As LONGRANGE
rngC.Start = 10
rngC.End = 20
ThisApplication.ActiveImage.ActiveFrameRange = rngC
Debug.Print "AFR= " & ThisApplication.GlobalTools.McToText(ThisApplication.ActiveImage.ActiveFrameRange).Value & _
" AW.SFR= " & ThisApplication.GlobalTools.McToText(wnd.ImageView.SequenceFrameRange).Value
'Note that ThisApplication.ActiveWindow.View.SequenceFrameRange gets set too