Click or drag to resize

mcImageUndoOperationFlags Enumeration

Flags to be passed to the McImage[Set].UndoStack.Push Operation argument. Theseflags are passed to the Backup method of the McUndoable object exposed by McImage and IMcImageSet objects.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcImageUndoOperationFlags
Members
  Member nameValueDescription
mciuofDefault0No flags, backupsource is the Context argument rectangle, if one is given, else it is the whole image. The Aoi is also captured as part of the backup. All frames are saved.
mciuofBackupIsWholeImage1Backup is of wholeimage unless a Context argument rectangle is supplied. This is the default
mciuofBackupIsAoi2Backup is of the Aoibounds only, unless a Context argument rectangle is supplied.
mciuofDoNotSaveTheAoi4If set, the Aoi isnot saved on the stack, nor will the existing Aoi be changed when an Undo or Redo is done using this Backup.
mciuofSaveActiveFrameOnly8If set, only theActiveFrame is saved. Otherwise either all frames or the ActiveFrameRange are saved (depending on whether the mciuofSaveActiveFrameRange flag is set).
mciuofSaveActiveFrameRange16If set, theActiveFrameRange is saved so long as UseActiveFrameRange is TRUE.
mciuofDoNotChangeModify32If set, theMcImage.Modified property is not restored across an undo. This flag may also be passed as the Operation argument for McFeatures or McGraphOverlay McUndoable objects.
mciuofStandardBackup18Standard backup for most operations. Backup source is the Context argument rectangle if one is given, else it is the Aoi. The ActiveFrameRange or ActiveFrame only are saved (depending on the state of UseActiveFrameRange). The Aoi is also captured as part of the backup.
mcioufForceLimitMask12288A mask for a 4-statevalue, one of mciuofForceXxxxxx values, that controls whether and how the normal limits on creating backed up images and whether they are created with discardable memory are determined. These values are only honored if neither the mcCommonUndoStackOperationFlags.mccusofDiscardedInfo nor mciuofSourceTooBig flags are set in the Operation argument (either of these flags being set during a Redo Backup call indicates that the undo state has already been discarded).
mciuofForceNormalLimits0Normal limits areapplied based backed up image size and on the McResourceManager.ImageUndoLimits properties (see mcImageUndoLimits for the various properties). This is the default.
mciuofForceDiscardable4096Force the created backupimage to have immediately discardable image memory should memory become tight. When value is given, then the backup image will not be created at all if it would force memory to be discarded or swapped out.
mciuofForceConditionallDiscardable8192Force the created backupimage to have conditionally discardable image memory. The time-out before the memory becomes discardable is set the McResourceManager.ImageUndoLimits(mciulConditionallyKeepUndoTimeoutSec) property.
mciuofForceKeep12288Force the createdbackup image, no matter its size, to have non-discardable image memory. Should memory become tight then this image's memory will be spooled out to a temporary swap file.
mciuofSourceHadAnAoi65536For internal use. Do not set.
mciuofSourceWasModified131072For internal use. Do not set.
mciuofSourceTooBig262144For internal use. Do not set.
mciuofUndoOperationActionMask15728640Mask for operationaction codes.
mciuofAboutToRemoveFrames1048576Operation actioncode: We are about to remove one or more frames via a McImage.RemoveFrames call. The Context argument holds a length-3 array giving the starting frame, the number of frames about to be removed and the total number of frames expected before removal. The image data itself (except for the frames that will be removed) are not backed up, so only the mciuofDoNotChangeModify and mcCommonUndoStackOperationFlags may be OR'ed in with this code. The Restore operation assumes that the anticipated frame operation was performed, so if it was not, you must pop the state off of the stack.
mciuofAboutToAddFrames2097152We are about to addone or more blank frames via McImage.AddFrames call. The Context argument holds a length-3 array giving the starting frame nsertion point (that is the current frame index before which the new frames will be inserted), the number of frames about to be inserted and the total number of frames expected before insertion. The image data itself is not backed up, so only the mciuofDoNotChangeModify and mcCommonUndoStackOperationFlags may be OR'ed in with this code. The Restore operation assumes that the anticipated frame operation was performed, so if it was not, you must pop the state off of the stack.
mciuofAboutToReorderFrames3145728We are about toreorder the frames with a call to the McImage.ReorderFrames method with the mciffType argument set to mcrffFrameList. The Context argument holds a copy of the McImage.ReorderFrames ReorderFrom argument that will be used. The image data itself is not backed up, so only the mciuofDoNotChangeModify and mcCommonUndoStackOperationFlags may be OR'ed in with this code. The Restore operation assumes that the anticipated frame operation was performed, so if it was not, you must pop the state off of the stack.
See Also