Click or drag to resize

mcPickSpotsToolCommandFlags Enumeration

Legal values for the McPickSpotsTool'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
Syntax
VB
Public Enumeration mcPickSpotsToolCommandFlags
Members
  Member nameValueDescription
mcpscfSpotIsCircle1Option flag: the picked spot is acircle. This is the default spot shape. Spot size is set via the mcpscfSetSpotSize action flag or by user +/- keypresses and represents the circle diameter; it is 10 pixels by default. When this shape is selected, holding down the ctrl key turns the shape into a square.
mcpscfSpotIsSquare2Option flag: the picked spot is asquare. Spot size is set via the mcpscfSetSpotSize action flag or by user +/- keypresses and represents the length of each side of the square; it is 10 pixels by default. When this shape is selected, holding down the ctrl key turns the shape into a circle.
mcpscfKeepEntireSpotOnImage4Option flag: if set then aspot cannot be placed if any part of the spot will go out of the image. If clear (the default) then a spot can be placed as long as the center of the spot is inside the image. A spot can never be placed with its center outside the image.
mcpscfSetResultMcRegions16Action flag: CommandData is castto an McRegions instance and used as the McRegions into which the picked spots will be appended as new sub-region features. See the mcpscfGetResultMcRegions flag for how the default is determined.. Once the CommandData is accessed, it is cleared.
mcpscfGetResultMcRegions32Action flag: Get, intoCommandData, the McRegions instance that is used as the McRegions into which the results will be appended as new sub-region features. If this McRegions has not been set via the mcpscfSetResultMcRegions flag, then by default it is the ancestor McRegions, if any, of the McGraphOverlay on which the McPickSpotsTool has been invoked (via a call to McGraphOverlay.SelectTool). If there is no ancestor McRegions, then the Aoi of the ancestor image of the McGraphOverlay is used as the default. Once the CommandData is gotten to retrieve the result, it is cleared.
mcpscfSetSpotSize256Action flag: CommandData is castto a double value and used as the size of the circle or square used for a picked spot. A lower limit of 1 pixel is silently enforced.
mcpscfGetSpotSize512Action flag: Get, intoCommandData, a double value that is the current size of the circle or square used for a picked spot. Unless changed via the mcpscfSetSpotSize flag or user +/- keypresses, the spot size is 10 pixels. The user may increase the spot size by 25% by pressing the plus (+) key and decrease it by 25% by pressing the minus (-) key.
mcpscfGetSpotsCount513Action flag: Get, intoCommandData, the current count of placed spots, exclusive of the working spot.
mcpscfIsWorkingSpotShowing514Action flag: Get, intoCommandData, True if the working spot is currently showing, False if it is not.
mcpscfAbortPicking16384Action flag and information flag:Abort spot picking and shut down the McPickSpotsTool as if the Escape key were pressed. At the time that the ToolDeselected notify is sent, this bit will be on in the CommandFlags property. This flag must be assigned alone.
mcpscfEndPicking32768Action flag and information flag:End spot picking and shut down the McPickSpotsTool as if the Enter key were pressed (or left mouse button double-clicked). At the time that the ToolDeselected notify is sent, this bit will be on in the CommandFlags property. This flag must be assigned alone.
See Also