mcBrushToolCommandFlags Enumeration |
|
Legal values for the McBrushTool's
IMcGraphToolServer.CommandFlags property.
Namespace: MediaCy.IQL.Display.Overlays
Assembly: MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcBrushToolCommandFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mcbtcfNoFlags | 0 | No flags | |
| mcbtcfPushResultMcRegionsOntoUndoStack | 1 | Action flag: Thecurrent state of the results McRegions (see mcbtcfSetResultMcRegions) and other tool state information is pushed onto the backspace key Undo stack and the Redo stack is cleared. You would use this action flag before making some change (e.g., removing all features) to the results McRegions that you wanted to be undoable in the same way that changes made with the tool are undoable. | |
| mcbtcfDoUndo | 2 | Action flag: Onelevel of Undo is performed, if possible. This is equivalent to pressing the Backspace key. The mcbtcfCanUndo CommandFlags bit will be set if an undo is possible. | |
| mcbtcfDoRedo | 3 | Action flag: Onelevel of Redo is performed, if possible. This is equivalent to pressing the Shift-backspace key. The mcbtcfCanRedo CommandFlags bit will be set if a redo is possible. | |
| mcbtcfCaptureUndoState | 4 | Action flag: Thecurrent state of the tool is captured for the next push onto the undo stack. | |
| mcbtcfSetResultMcRegions | 16 | Action flag: CommandDatais cast to an McRegions instance and used as the McRegions into which the results will be brushed. If this McRegions is not set, then by default it the ancestor McRegions, if any, or else the ancestor McImage.Aoi of the McGraphOverlay on which the McBrushTool has been invoked (via a call to McGraphOverlay.SelectTool). Once the CommandData is accessed, it is cleared. | |
| mcbtcfGetResultMcRegions | 17 | Action flag: Get, intoCommandData, the McRegions instance that is used as the McRegions into which the results will be brushed. Unless the mcbtcfSetResultMcRegions action flag has been used to change it, this McRegions instance will be the ancestor McRegions, if any, or else the ancestor McImage.Aoi of the McGraphOverlay on which the McBrushTool has been invoked (via a call to McGraphOverlay.SelectTool). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetBrushSize | 19 | Action flag: The integralvalue in CommandData is used to establish the brush width (diameter) in screen pixels. By default the width is 20 pixels. The result is silently clipped to the range 10 through 150, inclusive. A user needing a brush smaller than the minimum can use the mousewheel to zoom in on the image. | |
| mcbtcfGetBrushSize | 20 | Action flag: CommandDatais filled with the current brush width (diameter) in screen pixels. (see mcbtcfSetBrushSize). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetBrushColor | 21 | Action flag: The integralvalue in CommandData is used to establish the brush color as a 3 byte BGR value (Red is the low order byte). This just sets the color of the brush, not the color of the Assigning a color with this action flag will clear the mcbtcfAutoBrushColor static flag. | |
| mcbtcfGetBrushColor | 22 | Action flag: CommandDatais filled with the current brush (see mcbtcfAutoBrushColor and mcbtcfSetBrushColor). If the mcbtcfAutoBrushColor flag is clear and no color has been assigned with the mcbtcfSetBrushColor Action Flag, then the default color is red (0000FF hex). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetBrushShape | 23 | Action flag: The integralvalue in CommandData is taken as one of the mcBrushShapes enum values and immediately sets the current brush shape. | |
| mcbtcfGetBrushShape | 24 | Action flag: CommandDatais filled with the current brush shape as a mcBrushShapes enum value (see mcbtcfSetBrushShape). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetBrushOpacity | 25 | Action flag: The integralvalue in CommandData is used to establish the brush result opacity as a percentage. By default the opacity is 70. The result is silently clipped to the range 10 through 100, inclusive. | |
| mcbtcfGetBrushOpacity | 26 | Action flag: CommandDatais filled with the current brush opacity percentage, a value that will be between 10 and 100. (see mcbtcfSetBrushOpacity). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetMinResultArea | 27 | Action flag: The integralvalue in CommandData is used to set the minimum result region apparent feature area. When the tool is shut down, any region features with an apparent area (when seen at the highest brushing magnification) that are smaller than this are removed. By default the value is zero, so no test is applied. The result is silently forced to be non-negative. | |
| mcbtcfGetMinResultArea | 28 | Action flag: CommandDatais filled with the currentminimum result region apparent feature area, a value that will be non-negative and is zero by default. (see mcbtcfSetMinResultArea). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetMinResultHoleArea | 29 | Action flag: The integralvalue in CommandData is used to set the minimum result region apparent hole area. When the tool is shut down, any holes in region features with an apparent area (when seen at the highest brushing magnification) that are smaller than this are removed. By default the value is zero, so no test is applied. The result is silently forced to be non-negative. | |
| mcbtcfGetMinResultHoleArea | 30 | Action flag: CommandDatais filled with the current minimum result region apparent hole area, a value that will be non-negative and is zero by default. (see mcbtcfSetMinResultHoleArea). Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetPersistStateGroup | 31 | Action flag: The stringvalue in CommandData is used to establish a name for the state that will be used to persist the brush Size and Shape. By default this string is an empty string ("") in which case, the state is not persisted when the tool is shut down. Assigning the persist state group string will immediately load any previously saved state with the assigned group string. Normally the persist group would be set immediately after starting the tool if persistence is desired at all. | |
| mcbtcfGetPersistStateGroup | 32 | Action flag: CommandDatawill be filled with the string previously assigned with the mcbtcfSetPersistStateGroup action flag; this string is used to establish a name for the state that will be persisted when the tool is shut down. By default this string is an empty string, in which case no peristing is done. Once the CommandData is gotten to retrieve the result, it is cleared. | |
| mcbtcfSetUndoStack | 256 | Action flag: On entryCommandData should be set to an instance McUndoStack or empty. If given an instance of McUndoStack, then irrespective of the state of the mcbtcfUseImageUndoStack flag, this McUndoStack instance will be used when pushing undo/redo states. | |
| mcbtcfFlushUndoStack | 257 | Action flag: The currently usedundo stack is flushed, emptying it of all undo/redo states associated with this tool. | |
| mcbtcfAutoBrushColor | 4096 | Static flag: If set (thedefault), the brush color is taken from the McGraphObjBitmap.BorderColor auto display template of the result McRegions.AutoDisplayOverlay. The effect is that the brush color will be the same as the bitmap area(s) being brushed into. This flag will be sutomatically cleared if the mcbtcfSetBrushColor Action Flag is applied. If this flag is clear and no color has been assigned with the mcbtcfSetBrushColor Action Flag then the default color is red (0000FF hex). | |
| mcbtcfDisableShapeKey | 8192 | Static flag: If set, the 'S'key used to cycle through the brush shapes is disabled. This flag is clear by default; normally this flag would be set immediately after starting the tool if it is desired at all. | |
| mcbtcfDisableMouseWheel | 16384 | Static flag: If set, theCtrl-MouseWheel that can be used change the brush size is disabled. This flag is clear by default; normally this flag would be set immediately after starting the tool if it is desired at all. | |
| mcbtcfMarkHolesAtShutdown | 32768 | Static flag: If set, when thetool is shut down if the target McRegions needs to be switched back into non-union mode and there are holes in the union bitmap, then after switching back, the holes are marked with dashed borders. This flag is clear by default; normally this flag would be set immediately after starting the tool if it is desired at all. | |
| mcbtcfUseImageUndoStack | 65536 | Static flag: If set,undo/redo information is placed on the UndoStack of the McImage ancestor of the results McRegions (see mcbtcfSetResultMcRegions), and is left there when the tool is shut down. If clear (the default), undo/redo information is kept on an internal UndoStack. Changing the state of this flag must be done before any actions are placed on the undo stack (i.e., immediately after starting the tool). | |
| mcbtcfBrushMerging | 1048576 | Read-Only static flag: If setand mcbtcfBrushMasking is not set, the tool is merging (adding to the target McRegions) wherever the mouse moves it. Generally, this indicates that the tool is active, the left mouse button is down and the Shift key is not down. When this flag changes, an ObjectPropertyChanged event is fired on the active McGraphOverlay with the propertyID argument set to mcMcOvrLibPropertyIDs.mcmolpidActiveToolStatusChanged. If both mcbtcfBrushMerging and mcbtcfBrushMasking are set in the CommandFlags when the event is fired, it indicates that an Undo or Redo has just been performed. This bit cannot be set by assignment. | |
| mcbtcfBrushMasking | 2097152 | Read-Only static flag: If setand mcbtcfBrushMerging is not set, the tool is in erase mode: the left mouse button is down and the Shift key is pressed so that the target region is masked off wherever the mouse moves the brush. When this flag changes, an ObjectPropertyChanged event is fired on the active McGraphOverlay with the propertyID argument set to mcMcOvrLibPropertyIDs.mcmolpidActiveToolStatusChanged. If both mcbtcfBrushMerging and mcbtcfBrushMasking are set in the CommandFlags when the event is fired, it indicates that an Undo or Redo has just been performed. This bit cannot be set by assignment. | |
| mcbtcfCanUndo | 4194304 | Read-Only static flag: Ifset, a backspace Undo operation is available. This bit cannot be set by assignment. | |
| mcbtcfCanRedo | 8388608 | Read-Only static flag: Ifset, a Shift-backspace Redo operation is available. This bit cannot be set by assignment. | |
| mcbtcfSettableStaticFlagsMask | 1044480 | Settable static flags are masked by this. | |
| mcbtcfReadOnlyFlagsMask | 15728640 | Read-only static flags are masked by this. | |
| mcbtcfModeStateFlagsMask | 3145728 | The mode state read-only static flags are masked by this. |
See Also