FLImaging 7.8.25.3
GUIViewImageWrap.h
1#pragma once
2
10
11#include "GUIViewImageBaseWrap.h"
12
13#include "GUIViewImageLayerWrap.h"
14#include "DefinitionsGUIBroadcast.h"
15
17namespace FLImaging
18{
20 namespace GUI
21 {
23
32 {
33 SupportToDuplicateObject(CGUIViewImageWrap);
34
35 public:
44
53
75 const CResult Create(int32_t i32L, int32_t i32T, int32_t i32R, int32_t i32B, size_t stParentWindowHandle = 0);
76
92 const CResult CreateAndFitParent(size_t stParentWindowHandle, bool bAutoFit = true);
93
106
117
130
148 virtual const CResult Load(const wchar_t* pWcsPath = nullptr, FLImaging::GUI::EViewImageLoadOption eOption = EViewImageLoadOption_Default);
149
169 virtual const CResult LoadAsync(const wchar_t* pWcsPath = nullptr, EViewImageLoadOption eOption = EViewImageLoadOption_Load);
170
189
210
228 virtual const CResult LoadRaw(const wchar_t* pWcsPath = nullptr, FLImaging::GUI::EViewImageLoadOption eOption = EViewImageLoadOption_Load);
229
261 virtual const CResult LoadRaw(const wchar_t* pWcsPath, int64_t i64Width, int64_t i64Height, Base::EPixelFormat ePixelFormat = Base::EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64OffsetByteFromBegin = 0, int64_t i64OffsetByteFromEnd = 0, FLImaging::GUI::EViewImageLoadOption eOption = EViewImageLoadOption_Load);
262
280 virtual const CResult Save(const wchar_t* pWcsFileNameWithPath = nullptr, bool bSaveCurrentPage = false, bool bWithLayers = false);
281
297 virtual const CResult SavePage(int32_t i32PageIndex, const wchar_t* pWcsFileNameWithPath = nullptr);
298
316 virtual const CResult SavePages(Base::CFLArray<int32_t>* pFlaPageIndices, const wchar_t* pWcsFileNameWithPath = nullptr);
317
333 virtual const CResult LoadFigure(const wchar_t* pWcsPath = nullptr, bool bErrorMsgBox = false);
334
352 virtual const CResult LoadFigureGBR(const wchar_t* pWcsPath = nullptr, const wchar_t* pWcsLayerName = nullptr, uint32_t u32Color = -1);
353
372 virtual const CResult LoadFigureGBR(const wchar_t* pWcsPath, int32_t i32LayerNo, bool bClearLayer);
373
389 virtual const CResult LoadFigureDXF(const wchar_t* pWcsPath = nullptr, bool bErrorMsgBox = false);
390
406 virtual const CResult SaveFigure(Foundation::CFLFigure* pFigure, const wchar_t* pWcsPath = nullptr);
407
419 virtual const CResult ClearFile();
420
432 virtual const CResult ClearPage();
433
449 virtual const CResult ClearPages(Base::CFLArray<int32_t>* pFlaPageIndices);
450
468
502 template<typename T>
503 const CResult CreateImage(int64_t i64Width, int64_t i64Height, int32_t i32Channel, int32_t i32Depth, Base::EValueType eType, bool bOptSeparateChannel, const Base::CMultiVar<T>& flmvFillVal, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
504
516
527
540
553
569 virtual const CResult SetImagePtr(Base::CFLImage* pImage);
570
585
600
617
632
647
664
665
680
695
712
727
742
759
774
789
806
821
836
853
861 virtual void ClearAllLayers();
862
886 CGUIViewImageLayerWrap GetLayer(int32_t i32Index) const;
887
911 int32_t GetLayerCount() const;
912
926 CGUIViewImageLayerWrap GetLayerByName(const wchar_t* pWcsLayerName);
927
943 const CResult DeleteLayerByName(const wchar_t* pWcsLayerName);
944
958 bool DoesLayerExist(const wchar_t* pWcsLayerName) const;
959
971 int32_t GetNamedLayerCount() const;
972
986 CGUIViewImageLayerWrap GetNamedLayer(int32_t i32Index) const;
987
1007 virtual const CResult SetLayerAutoClearMode(int32_t i32LayerIndex, ELayerAutoClearMode eMode, bool bSet);
1008
1031
1051 virtual const CResult SetLayerAutoClearMode(ELayerAutoClearMode eMode, bool bSet);
1052
1070 virtual bool GetLayerAutoClearMode(int32_t i32LayerIndex, FLImaging::GUI::ELayerAutoClearMode eMode) const;
1071
1089 virtual bool GetLayerAutoClearMode(const CGUIViewImageLayerWrap* pLayer, ELayerAutoClearMode eMode) const;
1090
1104 virtual const CResult ZoomFitToLayer(int32_t i32LayerIndex);
1105
1121 virtual const CResult ZoomFitToLayer(const CGUIViewImageLayerWrap* pLayer);
1122
1135
1150 const CResult ConvertLayerToFigureObject(int32_t i32LayerIndex);
1151
1170
1186 const CResult ConvertSelectedFigureObjectToLayer(int32_t i32LayerIndex, uint32_t u32Color = -1);
1187
1206
1222 const CResult ConvertAllFigureObjectsToLayer(int32_t i32LayerIndex, uint32_t u32Color = -1);
1223
1241 const CResult ConvertAllFigureObjectsToLayer(CGUIViewImageLayerWrap* pLayer, uint32_t u32Color = -1);
1242
1256 const CResult SelectFigureObject(int32_t i32Index);
1257
1270
1301
1319 const CResult PushFrontFigureObject(Foundation::CFLFigure& flf, bool bEnableAll = true);
1320
1343
1374
1392 const CResult PushFrontFigureObject(Foundation::CFLFigure* pFlf, bool bEnableAll = true);
1393
1416
1447
1468
1499
1517 const CResult PushBackFigureObject(Foundation::CFLFigure& flf, bool bEnableAll = true);
1518
1541
1572
1590 const CResult PushBackFigureObject(Foundation::CFLFigure* pFlf, bool bEnableAll = true);
1591
1614
1638
1659
1673 const CResult DeleteFigureObject(int32_t i32Index);
1674
1688 const CResult DeleteFigureObject(const wchar_t* pWcsObjectName);
1689
1711 Foundation::CFLFigure* GetFigureObject(int32_t i32Index) const;
1712
1735
1759 const CResult UpdateFigureObject(int32_t i32Index);
1760
1788 Foundation::CFLFigure* GetFigureObject(const wchar_t* pWcsObjectName) const;
1789
1812
1835
1858
1883
1913 Foundation::CFLFigure* PopFigureObject(const wchar_t* pWcsObjectName);
1914
1939
1951 bool DoesFigureObjectExist(int32_t i32Index);
1952
1964 bool DoesFigureObjectExist(const wchar_t* pWcsObjectName);
1965
1966
1976 int32_t GetFigureObjectCount() const;
1977
1978
1991
2007 virtual const CResult SetViewCenter(const Foundation::CFLPoint<double>& flpImageCoord);
2008
2026 virtual const CResult SetViewCenterAndScale(const Foundation::CFLPoint<double>& flpImageCoord, double f64Scale);
2027
2041 virtual const CResult ZoomAtCenter(double f64Scale);
2042
2055
2056 virtual const CResult InternalSetOffset(const Foundation::CFLPoint<double>& flpOffset);
2057
2058
2068 virtual double GetScale() const;
2069
2070 virtual const CResult InternalSetScale(double f64Scale);
2071
2085 double GetZoomFitScale(double f64ClientWidth, double f64ClientHeight) const;
2086
2087
2088 virtual const CResult InternalZoomIn(int32_t i32CanvasX, int32_t i32CanvasY, double f64Ratio = 1.25);
2089
2090 virtual const CResult InternalZoomOut(int32_t i32CanvasX, int32_t i32CanvasY, double f64Ratio = 0.8);
2091
2103 virtual const CResult ZoomFit();
2104
2125
2138
2158 virtual const CResult SetAutoZoomFitTolerance(double f64ImageSizeDiffToleranceRatio = 0.);
2159
2169 virtual double GetAutoZoomFitTolerance() const;
2170
2182 virtual const CResult MoveToPrevPage();
2183
2195 virtual const CResult MoveToNextPage();
2196
2210 virtual const CResult MoveToPage(int32_t i32PageNum);
2211
2224
2234 virtual void SetCanvasColor(uint32_t u32Color);
2235
2245 virtual uint32_t GetCanvasColor() const;
2246
2256 virtual void ShowImage(bool bShow);
2257
2267 virtual bool IsImageVisible() const;
2268
2278 virtual void ShowThumbnailView(bool bShow);
2279
2289 virtual bool IsThumbnailViewVisible() const;
2290
2300 virtual void SetFixThumbnailView(bool bFix);
2301
2311 virtual bool IsThumbnailViewFixed() const;
2312
2313
2323 virtual void ShowImageMiniMap(bool bShow);
2324
2334 virtual bool IsImageMiniMapVisible() const;
2335
2345 virtual void ShowPageIndex(bool bShow);
2346
2356 virtual bool IsPageIndexVisible() const;
2357
2358
2368 virtual void ShowGrid(bool bShow);
2369
2379 virtual bool IsGridVisible() const;
2380
2381
2391 virtual void ShowImageCenter(bool bShow);
2392
2402 virtual bool IsImageCenterVisible() const;
2403
2413 virtual void ShowImageBorder(bool bShow);
2414
2424 virtual bool IsImageBorderVisible() const;
2425
2435 virtual void ShowCrosshair(bool bShow);
2436
2446 virtual bool IsCrosshairVisible() const;
2447
2457 virtual void ShowImageCoordinateOnCursor(bool bShow);
2458
2469
2479 virtual void ShowFigureCoordinateOnCursor(bool bShow);
2480
2491
2501 virtual void ShowImagePixelValueOnCursor(bool bShow);
2502
2513
2527 virtual const CResult SetDecimalPlacesOfCoordinate(uint8_t u8DecimalPlaces = 2);
2528
2538 virtual uint8_t GetDecimalPlacesOfCoordinate() const;
2539
2549 virtual void ShowIntensitySpectrum(bool bShow);
2550
2560 virtual bool IsIntensitySpectrumVisible() const;
2561
2562
2572 virtual void ShowPixelValue(bool bShow);
2573
2583 virtual bool IsPixelValueVisible() const;
2584
2597
2610
2626 const CResult SetPixelAccuracy(double f64PixelAccuracyX, double f64PixelAccuracyY);
2627
2643 const CResult GetPixelAccuracy(double* pF64PixelAccuracyX, double* pF64PixelAccuracyY) const;
2644
2660 const CResult GetPixelAccuracy(double& f64PixelAccuracyX, double& f64PixelAccuracyY) const;
2661
2662
2676 const CResult SetPixelAccuracyX(double f64PixelAccuracyX);
2677
2687 double GetPixelAccuracyX() const;
2688
2689
2703 const CResult SetPixelAccuracyY(double f64PixelAccuracyY);
2704
2714 double GetPixelAccuracyY() const;
2715
2716
2733
2746
2762 virtual const CResult SelectMenuItem(EMenuItem eMenuItem);
2763
2780
2797
2814
2829
2846
2863
2877 const CResult SynchronizePointOfView(const CGUIViewImageWrap* pViewImageTarget);
2878
2893
2906
2932 void EnableRatioSyncPointOfView(bool bEnabled);
2933
2944
2958 const CResult SynchronizePageIndex(const CGUIViewImageWrap* pViewImageTarget);
2959
2973 const CResult DesynchronizePageIndex(const CGUIViewImageWrap* pViewImageTarget);
2974
2987
2988
3002 const CResult ShowScrollBar(bool bShow);
3003
3017 const CResult ShowStatusBar(bool bShow);
3018
3037
3052
3071
3088
3106 const CResult GetStatusBarItemElasticMinimumWidth(EViewImageStatusBarItem eItem, int32_t& i32MinimumWidth) const;
3107
3125 const CResult CaptureScreen(Base::CFLImage& fliImage, bool bIncludeFrame = false);
3126
3144 const CResult CaptureScreen(Base::CFLImage* pFliImage, bool bIncludeFrame = false);
3145
3146
3159
3180
3192
3210 const CResult PasteImageAt(int32_t i32PageIndex);
3211
3228
3245
3263 const CResult RearrangePageOrder(int32_t i32OrigPageIndex, int32_t i32TargetPageIndex);
3264
3284 const CResult RearrangePageOrder(Base::CFLArray<int32_t>* pFlaPageIndices, int32_t i32TargetPageIndex);
3285
3301 virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio);
3302
3322 virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio, double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax);
3323
3341 virtual const CResult SetThumbnailViewHeightRange(double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax);
3342
3352 virtual double GetThumbnailViewHeight() const;
3353
3363 virtual double GetThumbnailViewHeightMin() const;
3364
3374 virtual double GetThumbnailViewHeightMax() const;
3375
3393 virtual const CResult SetFloatingImageValueRange(float f32Min, float f32Max);
3394
3412 virtual const CResult GetFloatingImageValueRange(float& f32Min, float& f32Max) const;
3413
3431 virtual const CResult SetFloatingImageValueRange(double f64Min, double f64Max);
3432
3450 virtual const CResult GetFloatingImageValueRange(double& f64Min, double& f64Max) const;
3451
3461 virtual void EnableSelection(bool bEnable);
3462
3472 virtual bool IsSelectionEnabled() const;
3473
3483 virtual void EnableDragAndDrop(bool bEnable);
3484
3494 virtual bool IsDragAndDropEnabled() const;
3495
3496
3509
3522
3535
3548
3558 virtual void SetFigureObjectFillColorAlphaRatio(float f32Ratio);
3559
3570
3581
3592
3604 virtual void SetFigureObjectName(int32_t i32FigureObjectIndex, const wchar_t* pWcsName);
3605
3619 virtual Base::CFLString<wchar_t> GetFigureObjectName(int32_t i32FigureObjectIndex) const;
3620
3651
3664
3677
3690
3703 void AddAvailableViewImageContextMenu(const FLImaging::GUI::EMenuItem* pArrEnum, int64_t i64Count);
3704
3718
3728
3743
3756 void SetAvailableViewImageContextMenu(const FLImaging::GUI::EMenuItem* pArrEnum, int64_t i64Count);
3757
3771
3792
3804 virtual void EnableFigureObjectRotation(int32_t i32FigureObjectIndex, bool bEnable);
3805
3817 virtual bool IsFigureObjectRotationEnabled(int32_t i32FigureObjectIndex) const;
3818
3828 virtual void EnableMouseWheel(bool bEnable);
3829
3839 virtual bool IsMouseWheelEnabled() const;
3840
3850 virtual void EnableMouseWheelButton(bool bEnable);
3851
3861 virtual bool IsMouseWheelButtonEnabled() const;
3862
3874 virtual void ShowFigureObjectInformationText(bool bShow = true, bool bSaveToConfig = true);
3875
3887 static void SetDefaultFigureObjectInformationTextVisible(bool bVisible = true, bool bSaveToConfig = true);
3888
3899
3910
3926 virtual void EnableFigureObjectInformationTextRealSize(bool bEnable = false, bool bSaveToConfig = true);
3927
3943 static void SetDefaultFigureObjectInformationTextRealSizeEnabled(bool bEnable = false, bool bSaveToConfig = true);
3944
3955
3966
3978 virtual void SetFigureObjectInformationTextFontSize(float f32FontSize = Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig = true);
3979
3991 static void SetDefaultFigureObjectInformationTextFontSize(float f32FontSize = Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig = true);
3992
4003
4014
4028 virtual void SetFigureObjectInformationTextOption(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig = true);
4029
4043 static void SetDefaultFigureObjectInformationTextOption(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig = true);
4044
4057
4070
4084 virtual void SetFigureObjectStringDecimalPlaces(uint32_t u32DecimalPlaces = 2, bool bExponentialNotation = false, bool bSaveToConfig = true);
4085
4099 static void SetDefaultFigureObjectStringDecimalPlaces(uint32_t u32DecimalPlaces = 2, bool bExponentialNotation = false, bool bSaveToConfig = true);
4100
4114 virtual void SetFigureObjectStringDecimalPlacesForPixelAccuracy(uint32_t u32DecimalPlaces = 2, bool bExponentialNotationForPixelAccuracy = false, bool bSaveToConfig = true);
4115
4129 static void SetDefaultFigureObjectStringDecimalPlacesForPixelAccuracy(uint32_t u32DecimalPlaces = 2, bool bExponentialNotationForPixelAccuracy = false, bool bSaveToConfig = true);
4130
4140 virtual uint32_t GetFigureObjectStringDecimalPlaces() const;
4141
4152
4163
4174
4185
4196
4207
4218
4232 template<typename T>
4233 FLImaging::Base::CFLString<wchar_t> GetFigureObjectFormatString(bool* pBExponentialNotation = nullptr) const;
4234
4249
4261 virtual void EnableFigureObjectMagnetToImage(bool bEnable, bool bSaveToConfig = true);
4262
4274 static void SetDefaultFigureObjectMagnetToImageEnabled(bool bEnable, bool bSaveToConfig = true);
4275
4286
4297
4309 virtual void EnableFigureObjectAngleMagnet(bool bEnable, bool bSaveToConfig = true);
4310
4322 static void SetDefaultFigureObjectAngleMagnetEnabled(bool bEnable, bool bSaveToConfig = true);
4323
4334
4345
4359 virtual const CResult PopupImageFigure(int32_t i32Idx);
4360
4376 virtual const CResult PopupImageFigure(const Base::CFLArray<int32_t>* pFlaI32Index);
4377
4390
4412 virtual const CResult PopupImageFigureByConditions(const Base::CFLString<wchar_t>& strExpression, const Base::CProcessingUnitBase* pPu = nullptr, bool bFigureArrayAsShape = false);
4413
4429 virtual const CResult RemoveImageFigure(int32_t i32Idx, bool bPopupMsgBox = false);
4430
4448 virtual const CResult RemoveImageFigure(const Base::CFLArray<int32_t>* pFlaI32Index, bool bPopupMsgBox = false);
4449
4473 virtual const CResult RemoveImageFiguresByConditions(const Base::CFLString<wchar_t>& strExpression, const Base::CProcessingUnitBase* pPu = nullptr, bool bFigureArrayAsShape = false, bool bPopupMsgBox = false);
4474
4498 virtual const CResult RemoveImageFiguresByConditionsFromAllPages(const Base::CFLString<wchar_t>& strExpression, const Base::CProcessingUnitBase* pPu = nullptr, bool bFigureArrayAsShape = false, bool bPopupMsgBox = false);
4499
4513 virtual const CResult ClearImageFiguresAll(bool bPopupMsgBox = false);
4514
4528 virtual const CResult ClearImageFiguresAllPages(bool bPopupMsgBox = false);
4529
4545 virtual const CResult SetImageFigureRealSizeText(bool bRealSize = false, bool bSaveToConfig = true);
4546
4556 virtual bool IsImageFigureRealSizeText() const;
4557
4581 virtual const CResult SetImageFigureTextFont(const wchar_t* pStrFontName = nullptr, int32_t i32FontSize = 12, EGUIViewImageFontWeight eFontWeight = EGUIViewImageFontWeight_BOLD, bool bItalic = false, bool bSaveToConfig = true);
4582
4604 virtual const CResult GetImageFigureTextFont(wchar_t** ppStrFontName, int32_t& i32FontSize, EGUIViewImageFontWeight& eFontWeight, bool& bItalic) const;
4605
4621 virtual const CResult SetImageFigureBorderWidth(int32_t i32BorderWidth = 1, bool bSaveToConfig = true);
4622
4632 virtual int32_t GetImageFigureBorderWidth() const;
4633
4649 virtual const CResult SetImageFigureOpacityBorder(float f32Opacity = 1.f, bool bSaveToConfig = true);
4650
4660 virtual float GetImageFigureOpacityBorder() const;
4661
4677 virtual const CResult SetImageFigureOpacityFill(float f32Opacity = 0.3f, bool bSaveToConfig = true);
4678
4688 virtual float GetImageFigureOpacityFill() const;
4689
4705 virtual const CResult SetImageFigureTextOpacityBorder(float f32Opacity = 1.f, bool bSaveToConfig = true);
4706
4716 virtual float GetImageFigureTextOpacityBorder() const;
4717
4733 virtual const CResult SetImageFigureTextOpacityFill(float f32Opacity = 1.f, bool bSaveToConfig = true);
4734
4744 virtual float GetImageFigureTextOpacityFill() const;
4745
4755 virtual void ShowImageFigure(bool bShow);
4756
4766 virtual bool IsImageFigureVisible() const;
4767
4777 virtual void ShowImageFigureText(bool bShow);
4778
4788 virtual bool IsImageFigureTextVisible() const;
4789
4799 virtual void EnableHoverImageFigure(bool bEnable);
4800
4810 virtual bool IsHoverImageFigureEnabled() const;
4811
4822
4832 virtual void EnablePixelSegmentationMode(bool bEnable);
4833
4847 virtual void SetSegmentationLabelText(int32_t i32Channel, double f64Value, const Base::CFLString<wchar_t>& strLabelText);
4848
4866 virtual const CResult GetSegmentationLabelText(int32_t i32Channel, double f64Value, Base::CFLString<wchar_t>& strLabelTextResult) const;
4867
4880
4891
4901 virtual void EnableReductionInterpolation(bool bEnable);
4902
4912 virtual void SetPanningMode(bool bSet);
4913
4923 virtual bool IsPanningMode() const;
4924
4936 virtual void SetZoomMode(EZoomMode eZoomMode);
4937
4949 virtual EZoomMode GetZoomMode() const;
4950
4966 virtual const CResult SetTeachingMode(ETeachingMode eTeachingMode);
4967
4980
4991
5002
5024 virtual const CResult SetFreeDrawOutputMode(EFreeDrawOutputMode eFreeDrawOutputMode);
5025
5040
5062 virtual const CResult SetFreeDrawMergeMode(EFreeDrawMergeMode eFreeDrawMergeMode);
5063
5078
5088 virtual void EnableSystemMenuOnFileDialog(bool bEnable);
5089
5100
5116 virtual const CResult StartAutoPageScroll(int64_t i64PageStep = 1, double f64PeriodMs = 1000.);
5117
5130
5144 virtual const CResult StartAutoSaveImage(double f64PeriodMs = 60000.);
5145
5158
5171
5184
5203
5218
5255
5256
5276 static const CResult EnableDefaultActionConfirmation(EMenuItem eMenuItem, bool bEnable = true);
5277
5297 static const CResult EnableDefaultActionConfirmation(EMenuItemImageFigure eMenuItem, bool bEnable = true);
5298
5318 static const CResult EnableDefaultActionConfirmation(EMenuItemObjectFigure eMenuItem, bool bEnable = true);
5319
5339 static const CResult EnableDefaultActionConfirmation(EMenuItemObjectMeasure eMenuItem, bool bEnable = true);
5340
5358 static const CResult EnableDefaultActionConfirmation(uint32_t u32MenuItem, bool bEnable = true);
5359
5374
5389
5404
5419
5431 static bool IsDefaultActionConfirmationEnabled(uint32_t u32MenuItem);
5432
5452 virtual const CResult EnableActionConfirmation(EMenuItem eMenuItem, bool bEnable = true);
5453
5473 virtual const CResult EnableActionConfirmation(EMenuItemImageFigure eMenuItem, bool bEnable = true);
5474
5494 virtual const CResult EnableActionConfirmation(EMenuItemObjectFigure eMenuItem, bool bEnable = true);
5495
5515 virtual const CResult EnableActionConfirmation(EMenuItemObjectMeasure eMenuItem, bool bEnable = true);
5516
5534 virtual const CResult EnableActionConfirmation(uint32_t u32MenuItem, bool bEnable = true);
5535
5549 virtual bool IsActionConfirmationEnabled(EMenuItem eMenuItem) const;
5592
5604 virtual bool IsActionConfirmationEnabled(uint32_t u32MenuItem) const;
5605
5625
5626 private:
5627 void operator=(const CGUIViewImageWrap& rh);
5629
5630 DeclareGetClassType();
5631 };
5632}
5633}
5634
Template type array class.
Definition FLArray.h:71
FLIMaging's image class.
Definition FLImage.h:35
Template type string class.
Definition FLString.h:34
Multi variable class.
Definition MultiVar.h:31
Processing unit base class.
Definition ProcessingUnitBase.h:27
FLImaging module execution result object.
Definition ResultsDef.h:1704
A base class of classes representing figures.
Definition FLFigure.h:27
A class representing a point.
Definition FLPoint.h:24
A class representing a rectangle.
Definition FLRect.h:24
CGUIViewImageBaseWrap()
Default constructor.
Image view layer C API wrapping class.
Definition GUIViewImageLayerWrap.h:30
Light-weight array wrapper to represent the context menu availability for figure.
Definition GUIViewImageObjectFigureContextMenuFilter.h:31
virtual const CResult PopupImageFigureAll()
Creates figure objects from all figures stored in the current view's image.
virtual bool IsPanningMode() const
Return whether the current mouse drag action is in panning mode.
const CResult ShowStatusBarItem(EViewImageStatusBarItem eItem, bool bShow)
Shows or hides a specific item in the status bar.
static const CResult EnableDefaultActionConfirmation(EMenuItemObjectMeasure eMenuItem, bool bEnable=true)
Sets the default action confirmation state for each popup menu item.
virtual bool IsGridVisible() const
Determines whether the grid on image is shown or hidden.
const CResult ShowScrollBar(bool bShow)
Sets whether to show/hide ScrollBar.
virtual const CResult PopupImageFigure(int32_t i32Idx)
Creates the Figure object for the i32Idx-th figure stored in the current view's image.
virtual const CResult SetImagePtr(Base::CFLImage *pImage)
Sets a pointer to the image to displayed in the image view.
virtual void ShowImageMiniMap(bool bShow)
Sets whether to show/hide the minimap.
static bool IsDefaultActionConfirmationEnabled(EMenuItemObjectMeasure eMenuItem)
Gets the default action confirmation state for each popup menu item.
FLImaging::Base::CFLString< wchar_t > GetFigureObjectFormatString(bool *pBExponentialNotation=nullptr) const
Gets the format string for representing information about the figure object as a string.
virtual double GetScale() const
Returns the current scale of the ImageView.
bool IsStatusBarItemVisible(EViewImageStatusBarItem eItem) const
Checks whether a specific item in the status bar is currently visible.
virtual const CResult SetImageFigureTextFont(const wchar_t *pStrFontName=nullptr, int32_t i32FontSize=12, EGUIViewImageFontWeight eFontWeight=EGUIViewImageFontWeight_BOLD, bool bItalic=false, bool bSaveToConfig=true)
Sets the font for the string in the Image Figure.
virtual Foundation::CFLPoint< double > ConvertClientCoordToImageCoord(const Foundation::CFLPoint< int32_t > &flp)
Convert client coordinates to image coordinates.
static const CResult EnableDefaultActionConfirmation(uint32_t u32MenuItem, bool bEnable=true)
Sets the default action confirmation state for each popup menu item.
const CResult SetPixelAccuracyX(double f64PixelAccuracyX)
Sets the Pixel Accuracy X of the ImageView.
virtual const CResult RemoveImageFiguresByConditionsFromAllPages(const Base::CFLString< wchar_t > &strExpression, const Base::CProcessingUnitBase *pPu=nullptr, bool bFigureArrayAsShape=false, bool bPopupMsgBox=false)
Removes shapes that meet certain conditions (e.g., width is 10 or greater, type is 'rect',...
virtual bool IsActionConfirmationEnabled(EMenuItemObjectMeasure eMenuItem) const
Returns whether action confirmation is enabled for this image view instance.
bool DoesFLImageExist()
Determines whether there is an image in the image view.
bool DoesFigureObjectExist(int32_t i32Index)
Determines whether the figure object exists corresponding to the index passed as a parameter.
void RemoveAvailableViewImageContextMenu(const FLImaging::GUI::EMenuItem *pArrEnum, int64_t i64Count)
Removes specified items from the current available context menu in the Image view.
bool DoesFLImageBufferExist()
Determines whether the image view has an image buffer.
virtual bool IsSystemMenuOnFileDialogEnabled() const
Checks if the system menu on the file dialog is enabled.
virtual void SetFigureObjectName(int32_t i32FigureObjectIndex, const wchar_t *pWcsName)
Set the name of the image view figure object.
const CResult ConvertAllFigureObjectsToLayer(int32_t i32LayerIndex, uint32_t u32Color=-1)
Draws all Figure Objects onto the selected layer. Remove the Figure Object on success.
virtual const CResult PopupImageFigure(const Base::CFLArray< int32_t > *pFlaI32Index)
Creates figure objects from figures of specific indices stored in the current view's image.
double GetPixelAccuracyY() const
Retrieves the Pixel Accuracy X of the ImageView.
virtual bool IsInteractionActionEnabled(EGUIViewImageInteractionAction eAction) const
Checks whether a specific interaction action is enabled for the image view.
const CResult PushFrontFigureObject(Foundation::CFLFigure &flf, EAvailableFigureContextMenu eMenu, EAvailableFigureContextMenu2 eMenu2)
Add Figure to the front.
virtual void EnableFigureObjectInformationTextRealSize(bool bEnable=false, bool bSaveToConfig=true)
Sets whether the information text of image view figure objects should scale according to the image vi...
virtual Foundation::CFLRect< int32_t > ConvertImageCoordToClientCoord(const Foundation::CFLRect< double > &flr)
Convert image coordinates to client coordinates.
virtual const CResult SelectMenuItem(EMenuItemObjectFigure eMenuItem)
Performs a command on the selected menu item.
virtual Foundation::CFLPoint< int32_t > ConvertImageCoordToCanvasCoord(double x, double y)
Convert image coordinates to canvas coordinates.
virtual bool IsFigureObjectInformationTextVisible() const
Returns whether the globally set figure object displays an information string.
virtual Foundation::CFLPoint< int32_t > ConvertImageCoordToClientCoord(double x, double y)
Convert image coordinates to client coordinates.
virtual bool GetLayerAutoClearMode(int32_t i32LayerIndex, FLImaging::GUI::ELayerAutoClearMode eMode) const
Retrieves the auto-clear status of the layer for the specified mode.
static bool GetDefaultFigureObjectInformationTextVisible()
Returns whether newly created figure objects display an information string by default globally.
bool DoesFigureObjectExist(const wchar_t *pWcsObjectName)
Retrieves the existence of a figure object whose figure name matches the string passed as a parameter...
static const CResult EnableDefaultActionConfirmation(EMenuItemObjectFigure eMenuItem, bool bEnable=true)
Sets the default action confirmation state for each popup menu item.
virtual EViewImageFigureObjectMagnetOption GetFigureObjectMagnetOption() const
Get the magnet option of the image view figure object.
virtual const CResult SetImageFigureOpacityFill(float f32Opacity=0.3f, bool bSaveToConfig=true)
Sets the default fill opacity applied when drawing a Figure stored in an image.
virtual const CResult SetAutoZoomFitTolerance(double f64ImageSizeDiffToleranceRatio=0.)
Sets the tolerance ratio used to determine whether the current viewport is preserved when the image s...
const CResult SynchronizePageIndex(const CGUIViewImageWrap *pViewImageTarget)
Synchronizes the parameter's view with the selected page index of the current view.
const CResult UpdateFigureObject(int32_t i32Index)
Updates the figure object and its rendering state after modification.
static void SetDefaultFigureObjectMagnetOption(EViewImageFigureObjectMagnetOption eOption)
Set the default magnet options of newly created image view figure objects globally.
virtual const CResult ZoomFitToLayer(int32_t i32LayerIndex)
Adjusts the scale and offset so that the shapes and text drawn over the selected layer fill the scree...
virtual EZoomMode GetZoomMode() const
Return the current zoom mode set for the left mouse button click action.
CGUIViewImageLayerWrap GetLayer(int32_t i32Index) const
Retrieves a user-accessible layer by index.
virtual void ClearAllLayers()
Clear the drawing objects above vctDrawingLayers, MeasureLayer, and FigureLayer.
const CResult SetStatusBarItemElasticMinimumWidth(EViewImageStatusBarItem eItem, int32_t i32MinimumWidth)
Sets the elastic minimum width of a specific item in the status bar. This defines the minimum width t...
virtual const CResult SelectMenuItem(EMenuItemObjectMeasure eMenuItem)
Performs a command on the selected menu item.
virtual const CResult SetLayerAutoClearMode(int32_t i32LayerIndex, ELayerAutoClearMode eMode, bool bSet)
Sets the automatic clear mode of the layer.
virtual bool IsFigureObjectInformationTextRealSizeEnabled() const
Returns whether the information text of image view figure objects scales according to the image view'...
const CResult PushBackFigureObject(Foundation::CFLFigure *pFlf, const FLImaging::GUI::EMenuItemObjectFigure *pArrEnum, int64_t i64Count)
Add Figure to the back, making only the given menu items available.
virtual const CResult SetFloatingImageValueRange(double f64Min, double f64Max)
Specifies the maximum and minimum value for the pixel value of the floating point image....
virtual const CResult LoadRaw(const wchar_t *pWcsPath=nullptr, FLImaging::GUI::EViewImageLoadOption eOption=EViewImageLoadOption_Load)
Load .raw image file into the view. Calling this function activates a dialog that sets the width,...
virtual bool IsReductionInterpolationEnabled() const
Returns whether interpolation is performed when the image is reduced.
virtual float GetFigureObjectFillColorAlphaRatio() const
Returns the globally configured fill alpha ratio for figure objects.
const CResult SetPixelAccuracyY(double f64PixelAccuracyY)
Sets the Pixel Accuracy Y of the ImageView.
virtual const CResult SetDecimalPlacesOfCoordinate(uint8_t u8DecimalPlaces=2)
Sets the number of decimal places displayed when showing image coordinates at the mouse cursor positi...
const CResult SelectFigureObject(int32_t i32Index)
Select the Figure Object in the Image View.
virtual const CResult LoadAsync(const FLImaging::Base::CFLArray< FLImaging::Base::CFLString< wchar_t > > *pFlaStrPath, EViewImageLoadOption eOption=EViewImageLoadOption_Load)
Load image files into the view asynchronously.
virtual void SetSegmentationLabelText(int32_t i32Channel, double f64Value, const Base::CFLString< wchar_t > &strLabelText)
Sets the label for a specific pixel value in the image view.
virtual uint32_t GetFigureObjectStringDecimalPlacesForPixelAccuracy() const
Retrieves the number of decimal places displayed when representing the information of a figure object...
virtual const CResult GetImageFigureTextFont(wchar_t **ppStrFontName, int32_t &i32FontSize, EGUIViewImageFontWeight &eFontWeight, bool &bItalic) const
Gets the font for the string in the image Figure.
virtual void EnableMouseWheelButton(bool bEnable)
Sets whether to enable mouse wheel button(MButton).
virtual void EnableDragAndDrop(bool bEnable)
Sets whether to enable or disable to load files with drag and drop.
const CResult DeleteFigureObject(int32_t i32Index)
Removes a Figure.
const CResult Create(int32_t i32L, int32_t i32T, int32_t i32R, int32_t i32B, size_t stParentWindowHandle=0)
Create an image view window.
const CResult PushFrontFigureObject(Foundation::CFLFigure *pFlf, EAvailableFigureContextMenu eMenu, EAvailableFigureContextMenu2 eMenu2)
Add Figure to the front.
virtual void SetZoomMode(EZoomMode eZoomMode)
Set or unset the Zoom mode for the left mouse button click action.
virtual const CResult LoadFigureGBR(const wchar_t *pWcsPath, int32_t i32LayerNo, bool bClearLayer)
Load a file with a .gbr extension into the view.
const CResult PushBackFigureObject(Foundation::CFLFigure &flf, bool bEnableAll=true)
Add Figure to the back.
void GetAvailableViewImageContextMenu(Base::CFLArray< int32_t > &flaEnum) const
Retrieves the current available context menu items in the Image view.
virtual void SetFigureObjectStringDecimalPlaces(uint32_t u32DecimalPlaces=2, bool bExponentialNotation=false, bool bSaveToConfig=true)
Sets the format string globally when representing information about a figure object as a string....
const CResult PasteImage()
Paste the most recent copied image from the other views or the bitmap copied to the clipboard....
virtual const CResult ClearPage()
Clears the selected page of the image displayed in the view on the GUI interface.
virtual const CResult EnableActionConfirmation(EMenuItem eMenuItem, bool bEnable=true)
Enables or disables action confirmation for this image view instance.
virtual bool IsThumbnailViewFixed() const
Determines whether the preview thumbnail pane for the image page is pinned.
virtual double GetThumbnailViewHeightMax() const
Get the maximum value of the ratio of thumbnail view height to image view height.
virtual const CResult SetImageFigureTextOpacityFill(float f32Opacity=1.f, bool bSaveToConfig=true)
Sets the default fill opacity for label text when drawing a Figure stored in an image.
static bool GetDefaultFigureObjectStringExponentialFlag()
Gets the default format string for representing information about newly created figure objects as a s...
const CResult DeleteFigureObject(const wchar_t *pWcsObjectName)
Removes figure objects.
bool DoesLayerExist(const wchar_t *pWcsLayerName) const
Returns whether a layer with the specified name exists.
FLImaging::Base::CFLString< wchar_t > GetFigureObjectFormatStringForPixelAccuracy(bool *pBExponentialNotation=nullptr) const
Retrieves the format string used to represent the information of a figure object as a string with app...
virtual const CResult Save(const wchar_t *pWcsFileNameWithPath=nullptr, bool bSaveCurrentPage=false, bool bWithLayers=false)
Save the image.
virtual bool IsPixelSegmentationModeEnabled() const
Returns whether the feature is enabled or not, which can be viewed by coloring the Pixel value in the...
static bool IsDefaultActionConfirmationEnabled(EMenuItem eMenuItem)
Gets the default action confirmation state for each popup menu item.
virtual Base::CFLImage * GetIntrinsicImage()
Retrieves the image pointer embedded in the image view.
virtual bool IsDragAndDropEnabled() const
Determines whether to load files with drag and drop.
virtual void ShowPageIndex(bool bShow)
Sets whether to show/hide the image page index.
static bool IsDefaultActionConfirmationEnabled(EMenuItemObjectFigure eMenuItem)
Gets the default action confirmation state for each popup menu item.
int32_t GetLayerCount() const
Returns the number of user-accessible layers.
const CResult ConvertLayerToFigureObject(int32_t i32LayerIndex)
Puts the figure drawn on the selected layer onto the view as a CGUIViewImageObjectFigure object....
virtual void ShowImageBorder(bool bShow)
Sets whether to show/hide the border of image.
Foundation::CFLFigure * GetAllFigureObject() const
Retrieves duplicated copies of all figure objects.
virtual const CResult SetAutoZoomFitTriggerFlags(FLImaging::GUI::EGUIViewImageAutoZoomFitTriggerFlags eMode)
Sets the trigger flags used to determine when ZoomFit() may be automatically performed.
virtual void SetAvailableViewImageContextMenuDeprecated(FLImaging::GUI::EAvailableViewImageContextMenu eMenu)
Sets an available context menu in the Image view.
static const CResult EnableDefaultActionConfirmation(EMenuItemImageFigure eMenuItem, bool bEnable=true)
Sets the default action confirmation state for each popup menu item.
virtual void EnableReductionInterpolation(bool bEnable)
Sets whether interpolation is performed when the image is reduced.
const CResult RearrangePageOrder(Base::CFLArray< int32_t > *pFlaPageIndices, int32_t i32TargetPageIndex)
This is a function to change the page order.
virtual bool GetFigureObjectStringExponentialFlag() const
Gets the format string for representing information about the figure object as a string.
virtual const CResult Load(const FLImaging::Base::CFLArray< FLImaging::Base::CFLString< wchar_t > > *pFlaStrPath, FLImaging::GUI::EViewImageLoadOption eOption=EViewImageLoadOption_Default)
Load image files included in the list.
virtual bool GetLayerAutoClearMode(const CGUIViewImageLayerWrap *pLayer, ELayerAutoClearMode eMode) const
Retrieves the auto-clear status of the layer for the specified mode.
static EViewImageFigureObjectMagnetOption GetDefaultFigureObjectMagnetOption()
Get the default magnet option of newly created image view figure objects globally.
virtual bool IsFigureCoordinateOnCursorVisible() const
Determines whether the figure coordinates are displayed at the mouse cursor position when hovering ov...
static void SetDefaultFigureObjectInformationTextFontSize(float f32FontSize=Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig=true)
Sets the default global font size for the information text displayed by newly created image view figu...
virtual bool IsThumbnailViewVisible() const
Determines whether the preview thumbnail window is shown or hidden.
static bool IsDefaultFigureObjectInformationTextRealSizeEnabled()
Returns whether the default information text of newly created image view figure objects scales accord...
const CResult PushFrontFigureObject(Foundation::CFLFigure &flf, const FLImaging::GUI::CGUIViewImageObjectFigureContextMenuFilter &viofCmFilter)
Add Figure to the front. This is the most flexible overload: start from CGUIViewImageObjectFigureCont...
virtual bool IsActionConfirmationEnabled(EMenuItemImageFigure eMenuItem) const
Returns whether action confirmation is enabled for this image view instance.
virtual void EnableSelection(bool bEnable)
Sets whether to enable or disable selection when a mouse drag event occurs.
virtual void EnableHoverImageFigure(bool bEnable)
Sets whether to highlight the Figure stored in the image when the mouse touches it.
virtual uint8_t GetDecimalPlacesOfCoordinate() const
Retrieves the number of decimal places displayed for the image coordinates at the mouse cursor positi...
const CResult SetPixelAccuracy(double f64PixelAccuracyX, double f64PixelAccuracyY)
Sets the Pixel Accuracy X, Y of the ImageView.
virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio)
Set the ratio of thumbnail view height to image view height.
const CResult PushBackFigureObject(Foundation::CFLFigure *pFlf, const FLImaging::GUI::CGUIViewImageObjectFigureContextMenuFilter &viofCmFilter)
Add Figure to the back.
virtual bool IsImageCenterVisible() const
Indicates whether center of image view is drawn.
virtual void ShowGrid(bool bShow)
Sets whether to show/hide the grid on image.
virtual const CResult LoadFigureDXF(const wchar_t *pWcsPath=nullptr, bool bErrorMsgBox=false)
Load a file with a .dxf extension into the view.
virtual const CResult SelectMenuItem(EMenuItem eMenuItem)
Performs a command on the selected menu item.
virtual void SetFigureObjectInformationTextFontSize(float f32FontSize=Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig=true)
Sets the global font size for the information text displayed by image view figure objects....
virtual void ShowImageFigureText(bool bShow)
Shows or hides the labels (names) of the figures stored in the image.
const CResult SetPixelAccuracyUnit(FLImaging::Foundation::ELengthUnit eLenUnit)
Sets the units for the Pixel Accuracy of the ImageView.
virtual EViewImageMouseCapturePolicy GetMouseCapturePolicy() const
Returns the currently set mouse capture policy.
Foundation::CFLFigure * PopBackFigureObject()
Retrieves and removes the last figure object as a duplicated object.
virtual const CResult GetFloatingImageValueRange(float &f32Min, float &f32Max) const
Get the maximum and minimum value for the pixel value of the floating point image.
virtual const CResult Load(const wchar_t *pWcsPath=nullptr, FLImaging::GUI::EViewImageLoadOption eOption=EViewImageLoadOption_Default)
Load image files into the view.
virtual const CResult SetImageFigureRealSizeText(bool bRealSize=false, bool bSaveToConfig=true)
Sets the mode for drawing text with real size when displaying a string of Image Figure.
virtual bool IsImageFigureTextVisible() const
Checks whether the labels (names) of the figures stored in the image are visible.
const CResult CopyImage()
Copies the current image for pasting into another view.
virtual const CResult SetFloatingImageValueRange(float f32Min, float f32Max)
Specifies the maximum and minimum value for the pixel value of the floating point image....
static void SetDefaultFigureObjectInformationTextRealSizeEnabled(bool bEnable=false, bool bSaveToConfig=true)
Sets the default option globally for whether the information text of newly created image view figure ...
const CResult RotateImage(FLImaging::GUI::EImageRotateAngle eAngle)
Rotate the image 90, 180, 270 degrees.
virtual const CResult SetViewCenterAndScale(const Foundation::CFLPoint< double > &flpImageCoord, double f64Scale)
Sets the view center to the specified coordinate flpImageCoord, then sets the image view scale to f64...
virtual const CResult MoveToPrevPage()
Move to the previous page if the image displayed in the image view is a multi-page image.
virtual const CResult ClearImageFiguresAll(bool bPopupMsgBox=false)
Clear all Figures within the selected page.
int32_t GetFigureObjectCount() const
Retrieves the number of figure objects.
virtual Foundation::CFLRect< int32_t > ConvertCanvasCoordToClientCoord(const Foundation::CFLRect< int32_t > &flr)
Convert canvas coordinates to client coordinates.
virtual const CResult SetImageFigureOpacityBorder(float f32Opacity=1.f, bool bSaveToConfig=true)
Sets the default border opacity applied when drawing a Figure stored in an image.
const CResult PushFrontFigureObject(Foundation::CFLFigure *pFlf, const FLImaging::GUI::EMenuItemObjectFigure *pArrEnum, int64_t i64Count)
Add Figure to the front, making only the given menu items available.
virtual const CResult LoadRaw(const wchar_t *pWcsPath, int64_t i64Width, int64_t i64Height, Base::EPixelFormat ePixelFormat=Base::EPixelFormat_C1_U8, int32_t i32AlignByte=4, int64_t i64OffsetByteFromBegin=0, int64_t i64OffsetByteFromEnd=0, FLImaging::GUI::EViewImageLoadOption eOption=EViewImageLoadOption_Load)
Load .raw image file into the view.
CGUIViewImageWrap()
Default constructor.
virtual ~CGUIViewImageWrap()
Default destructor.
virtual uint32_t GetFigureObjectStringDecimalPlaces() const
Gets the format string for representing information about the figure object as a string.
Foundation::CFLFigure * PopFrontFigureObject()
Retrieves and removes the first figure object as a duplicated object.
virtual const CResult LoadAsync(const wchar_t *pWcsPath=nullptr, EViewImageLoadOption eOption=EViewImageLoadOption_Load)
Load image files into the view asynchronously.
const CResult PushBackFigureObject(Foundation::CFLFigure *pFlf, EAvailableFigureContextMenu eMenu, EAvailableFigureContextMenu2 eMenu2)
Add Figure to the back.
virtual const CResult StartAutoPageScroll(int64_t i64PageStep=1, double f64PeriodMs=1000.)
Starts automatic page scrolling at specified intervals.
static void SetDefaultFigureObjectFillColorAlphaRatio(float f32Ratio)
Sets the default fill alpha ratio for newly created figure objects globally.
virtual Foundation::CFLPoint< int32_t > ConvertClientCoordToCanvasCoord(int32_t x, int32_t y)
Convert client coordinates to canvas coordinates.
virtual const CResult SetFreeDrawOutputMode(EFreeDrawOutputMode eFreeDrawOutputMode)
Sets the merge behavior for pen-based drawing modes (ETeachingMode_Figure_FreeDraw or ETeachingMode_F...
virtual void SetCanvasColor(uint32_t u32Color)
Sets the image view's background color.
virtual const CResult RedrawImageFigures()
Updates and redraws image figure objects in the viewer.
virtual void SetFigureObjectInformationTextOption(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig=true)
Sets the information string display option for an image view figure object globally....
virtual Foundation::CFLPoint< int32_t > ConvertClientCoordToCanvasCoord(const Foundation::CFLPoint< int32_t > &flp)
Convert client coordinates to canvas coordinates.
virtual const CResult MoveToPage(int32_t i32PageNum)
Move to the specific page if the image displayed in the image view is a multi-page image.
virtual void ShowPixelValue(bool bShow)
Sets whether to show/hide the image pixel value.
static void SetDefaultFigureObjectMagnetToImageEnabled(bool bEnable, bool bSaveToConfig=true)
Sets the default magnet option (the option that sticks to the edge if the figure object is located ne...
virtual const CResult SetLayerAutoClearMode(ELayerAutoClearMode eMode, bool bSet)
Sets the auto clear mode for all layers at once.
virtual const CResult StopAutoPageScroll()
Stops the automatic page scrolling.
virtual void ShowImageCoordinateOnCursor(bool bShow)
Sets whether image coordinates are displayed at the mouse cursor position in Image View.
virtual void SetFixThumbnailView(bool bFix)
Sets whether to show/hide the preview thumbnail window for the page when multiple images are displaye...
virtual void SetAvailableViewImageContextMenuImageFigureDeprecated(EAvailableViewImageContextMenuImageFigure eMenu)
Sets available context menu for Image Figure in this image view.
virtual FLImaging::GUI::EGUIViewImageAutoZoomFitTriggerFlags GetAutoZoomFitTriggerFlags() const
Gets the trigger flags used to determine when ZoomFit() may be automatically performed.
const CResult CopyPages(Base::CFLArray< int32_t > *pFlaPageIndices)
Copy the selected pages to the clipboard.
const CResult RearrangePageOrder(int32_t i32OrigPageIndex, int32_t i32TargetPageIndex)
Rearrange the order of the page. If you move the third page to the 7th page, the existing 4-7 pages w...
virtual const CResult SavePage(int32_t i32PageIndex, const wchar_t *pWcsFileNameWithPath=nullptr)
Save the selected page in the image.
const CResult DesynchronizePointOfView(const CGUIViewImageWrap *pViewImageTarget)
Turn off viewpoint synchronization for the parameter's view.
virtual Foundation::CFLPoint< double > GetOffset() const
Retrieves the current offset of the image view. When panning or changing the scale,...
virtual EAvailableViewImageContextMenuImageFigure GetAvailableViewImageContextMenuImageFigureDeprecated() const
Retrieves available context menu for Image Figure in this image view.
virtual const CResult ClearImageFiguresAllPages(bool bPopupMsgBox=false)
Removes all Figures from all pages of image.
virtual int32_t GetImageFigureBorderWidth() const
Gets the default border width applied when drawing a Figure stored in an image.
virtual EPixelNumberMode GetPixelNumberMode() const
Retrieves the pixel value representation mode of the image.
static void SetDefaultFigureObjectAngleMagnetEnabled(bool bEnable, bool bSaveToConfig=true)
Sets the default angle magnet option for newly created figure objects globally (the option to have a ...
virtual const CResult EnableActionConfirmation(EMenuItemObjectMeasure eMenuItem, bool bEnable=true)
Enables or disables action confirmation for this image view instance.
static bool IsDefaultActionConfirmationEnabled(uint32_t u32MenuItem)
Gets the default action confirmation state for each popup menu item.
virtual void EnableFigureObjectRotation(int32_t i32FigureObjectIndex, bool bEnable)
Enables the rotation function of the image view figure object.
static bool IsDefaultFigureObjectMagnetToImageEnabled()
Returns the default magnet option for globally set newly created figure objects (the option that stic...
virtual bool IsActionConfirmationEnabled(EMenuItem eMenuItem) const
Returns whether action confirmation is enabled for this image view instance.
virtual const CResult EnableInteractionAction(EGUIViewImageInteractionAction eAction, bool bEnable)
Enables or disables a specific interaction action for the image view.
Foundation::CFLFigure * PopFigureObject(const wchar_t *pWcsObjectName)
Retrieves and removes figure objects whose name matches the specified string as duplicated object(s).
virtual bool IsCrosshairVisible() const
Determines whether the crosshair is shown or hidden.
virtual Foundation::CFLPoint< double > ConvertCanvasCoordToImageCoord(int32_t x, int32_t y)
Convert canvas coordinates to image coordinates.
Foundation::CFLFigure * GetFigureObject(int32_t i32Index) const
Retrieves a duplicated figure corresponding to the specified index.
virtual const CResult EnableActionConfirmation(uint32_t u32MenuItem, bool bEnable=true)
Enables or disables action confirmation for this image view instance.
static bool IsDefaultFigureObjectAngleMagnetEnabled()
Returns the default angle magnet option for a globally set newly created figure object (the option to...
virtual void SetPanningMode(bool bSet)
Set or unset the mouse drag action to panning mode.
virtual float GetImageFigureTextOpacityBorder() const
Gets the default border opacity for label text when drawing a Figure stored in an image.
virtual void ShowThumbnailView(bool bShow)
Sets whether to show/hide the preview thumbnail window for the page when multiple images are displaye...
virtual void EnableFigureObjectAngleMagnet(bool bEnable, bool bSaveToConfig=true)
Sets the angle magnet option for the figure object globally (the option to have a multiples value of ...
virtual const CResult LoadFigureGBR(const wchar_t *pWcsPath=nullptr, const wchar_t *pWcsLayerName=nullptr, uint32_t u32Color=-1)
Load a file with a .gbr extension into the view.
CGUIViewImageWrap * GetRootSyncView(FLImaging::GUI::EViewImageSyncOption eViewImageSyncOption) const
Retrieves the root view synchronized with the current image view for a specific option.
CGUIViewImageLayerWrap GetLayerByName(const wchar_t *pWcsLayerName)
Retrieves the layer pointer whose the name is same as the parameter pWcsLayerName.
const CResult PushBackFigureObject(Foundation::CFLFigure &flf, const FLImaging::GUI::EMenuItemObjectFigure *pArrEnum, int64_t i64Count)
Add Figure to the back, making only the given menu items available.
virtual double GetThumbnailViewHeight() const
Get the ratio of thumbnail view height to image view height.
const CResult DeleteLayerByName(const wchar_t *pWcsLayerName)
Deletes the layer object with the specified name and releases its memory.
void EnableAvailableViewImageContextMenuAll(bool bEnable)
Enables or disables all items in the available context menu in the Image view.
virtual const CResult ClearSegmentationLabelText()
Removes all labels set for a particular pixel value.
virtual const CResult RemoveImageFiguresByConditions(const Base::CFLString< wchar_t > &strExpression, const Base::CProcessingUnitBase *pPu=nullptr, bool bFigureArrayAsShape=false, bool bPopupMsgBox=false)
Removes figures stored in the current view's image that match conditions (e.g., width greater than 10...
virtual const CResult MoveToNextPage()
Move to the next page if the image displayed in the image view is a multi-page image.
virtual void SetMouseCapturePolicy(EViewImageMouseCapturePolicy ePolicy=EViewImageMouseCapturePolicy_All)
Sets the mouse capture policy for the image view. The specified policy determines in which situations...
const CResult PushFrontFigureObject(Foundation::CFLFigure &flf, bool bEnableAll=true)
Add Figure to the front.
const CResult ConvertAllFigureObjectsToLayer(CGUIViewImageLayerWrap *pLayer, uint32_t u32Color=-1)
Draws all Figure Objects onto the selected layer. Remove the Figure Object on success.
virtual bool IsSelectionEnabled() const
Determines whether selection is enabled or disabled.
const CResult FlipImage(FLImaging::GUI::EImageFlipDirection eDirection)
It flips the image vertically, horizontally, vertically and horizontally.
virtual const CResult SetLayerAutoClearMode(CGUIViewImageLayerWrap *pLayer, ELayerAutoClearMode eMode, bool bSet)
Sets the automatic clear mode of the layer.
virtual const CResult SetImageFigureBorderWidth(int32_t i32BorderWidth=1, bool bSaveToConfig=true)
Sets the default border width applied when drawing a Figure stored in an image.
virtual void ShowImagePixelValueOnCursor(bool bShow)
Sets whether pixel values are displayed at the mouse cursor position in Image View.
virtual EFigureObjectInformationText GetFigureObjectInformationTextOption() const
Returns the information string display option for globally set figure objects.
virtual Foundation::CFLPoint< double > ConvertCanvasCoordToImageCoord(const Foundation::CFLPoint< int32_t > &flp)
Convert canvas coordinates to image coordinates.
const CResult CreateAndFitParent(size_t stParentWindowHandle, bool bAutoFit=true)
After creating the image view window, adjust the size of the image view to match the size of the pare...
const CResult ResignRootSyncView(FLImaging::GUI::EViewImageSyncOption eViewImageSyncOption)
If the root view of the synchronized views for a specific option is the current image view,...
const CResult PushBackFigureObject(Foundation::CFLFigure *pFlf, bool bEnableAll=true)
Add Figure to the back.
const CResult ConvertLayerToFigureObject(CGUIViewImageLayerWrap *pLayer)
Puts the figure drawn on the selected layer onto the view as a Figure Object. If there are more than ...
const CResult PushFrontFigureObject(Foundation::CFLFigure &flf, const FLImaging::GUI::EMenuItemObjectFigure *pArrEnum, int64_t i64Count)
Add Figure to the front, making only the given menu items available.
virtual bool IsIntensitySpectrumVisible() const
Determines whether the pixel value text color is determined by the intensity of the pixel value of th...
virtual bool IsImageFigureVisible() const
Checks whether the figures stored in the image are visible.
virtual Foundation::CFLRect< double > ConvertClientCoordToImageCoord(const Foundation::CFLRect< int32_t > &flr)
Convert client coordinates to image coordinates.
virtual bool IsImagePixelValueOnCursorVisible() const
Determines whether the pixel values are displayed at the mouse cursor position in the image view.
virtual const CResult StopAutoSaveImage()
Stops the automatic image saving.
static float GetDefaultFigureObjectFillColorAlphaRatio()
Returns the default fill alpha ratio for newly created figure objects configured globally.
const CResult GetStatusBarItemElasticMinimumWidth(EViewImageStatusBarItem eItem, int32_t &i32MinimumWidth) const
Retrieves the elastic minimum width value of a specific status bar item. This value determines the mi...
int32_t GetNamedLayerCount() const
Returns the number of layers defined by name.
const CResult ShowStatusBar(bool bShow)
Sets whether to show/hide StatusBar.
static bool GetDefaultFigureObjectStringExponentialFlagForPixelAccuracy()
Retrieves whether the default exponential notation is used when representing the information of newly...
void AddAvailableViewImageContextMenu(const FLImaging::GUI::EMenuItem *pArrEnum, int64_t i64Count)
Adds specified items to the current available context menu in the Image view.
virtual const CResult ZoomFitToLayer(const CGUIViewImageLayerWrap *pLayer)
Adjusts the scale and offset so that the shapes and text drawn over the selected layer fill the scree...
static void SetDefaultFigureObjectInformationTextOption(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig=true)
Sets the default information string display option for newly created image view figure objects global...
virtual const CResult GetSegmentationLabelText(int32_t i32Channel, double f64Value, Base::CFLString< wchar_t > &strLabelTextResult) const
Gets a label for the pixel values set in the image view.
virtual float GetFigureObjectInformationTextFontSize() const
Returns the global font size used for the information text displayed by image view figure objects.
const CResult Destroy()
Destroy the image view window.
virtual bool IsPageIndexVisible() const
Determines whether the image page index is shown or hidden.
virtual Foundation::CFLRect< int32_t > ConvertClientCoordToCanvasCoord(const Foundation::CFLRect< int32_t > &flr)
Convert client coordinates to canvas coordinates.
const CResult PushFrontFigureObject(Foundation::CFLFigure *pFlf, bool bEnableAll=true)
Add Figure to the front.
const CResult CaptureScreen(Base::CFLImage &fliImage, bool bIncludeFrame=false)
Capture the current screen.
virtual void EnableSystemMenuOnFileDialog(bool bEnable)
Enables or disables the system menu on the file dialog.
virtual void SetFigureObjectStringDecimalPlacesForPixelAccuracy(uint32_t u32DecimalPlaces=2, bool bExponentialNotationForPixelAccuracy=false, bool bSaveToConfig=true)
Sets the format string used to represent the information of a figure object as a string with applied ...
virtual const CResult SetThumbnailViewHeightRange(double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax)
Set the minimum and maximum value of ratio of thumbnail view height to image view height.
virtual float GetImageFigureOpacityBorder() const
Gets the default border opacity applied when drawing a Figure stored in an image.
static uint32_t GetDefaultFigureObjectStringDecimalPlaces()
Gets the default format string for representing information about newly created figure objects as a s...
virtual const CResult SetTeachingMode(ETeachingMode eTeachingMode)
Set or unset the current view to a mode for teaching shapes, measurements, etc.
virtual const CResult ClearFile()
Close the image file on the GUI interface.
virtual bool IsMouseWheelButtonEnabled() const
Determines whether to enable mouse wheel button(MButton).
bool IsRatioSyncPointOfViewEnabled() const
Check whether normalized ratio-based synchronization for point of view is enabled.
const CResult DesynchronizePointOfViewAll()
Desynchronize the current view's viewpoint.
void SetAvailableViewImageContextMenu(const FLImaging::GUI::EMenuItem *pArrEnum, int64_t i64Count)
Clears the current available context menu items and sets the specified items in the Image view.
virtual const CResult EnableActionConfirmation(EMenuItemImageFigure eMenuItem, bool bEnable=true)
Enables or disables action confirmation for this image view instance.
virtual EAvailableViewImageContextMenu GetAvailableViewImageContextMenuDeprecated() const
Retrieves the available context menu for the image view.
virtual const CResult EnableActionConfirmation(EMenuItemObjectFigure eMenuItem, bool bEnable=true)
Enables or disables action confirmation for this image view instance.
virtual const CResult SetViewCenter(const Foundation::CFLPoint< double > &flpImageCoord)
Sets the view center to the specified coordinate flpImageCoord.
virtual Foundation::CFLPoint< int32_t > ConvertCanvasCoordToClientCoord(const Foundation::CFLPoint< int32_t > &flp)
Convert canvas coordinates to client coordinates.
virtual void ShowIntensitySpectrum(bool bShow)
Sets to determine the pixel value text color according to the intensity of the pixel value of the ima...
static void GetViewImageContextMenuChildren(EMenuItem eMenu, Base::CFLArray< int32_t > &flaEnum)
Retrieves child menu items of the specified parent context menu item. If eMenu is a parent menu item ...
static uint32_t GetDefaultFigureObjectStringDecimalPlacesForPixelAccuracy()
Retrieves the default number of decimal places displayed when representing the information of newly c...
virtual bool IsMouseWheelEnabled() const
Determines whether to enable mouse wheel.
const CResult GetPixelAccuracy(double *pF64PixelAccuracyX, double *pF64PixelAccuracyY) const
Retrieves the Pixel Accuracy X, Y of the ImageView.
virtual const CResult SetInteractionRule(EGUIViewGesture eGesture, EGUIViewImageInteractionAction eAction, EGUIViewImageHitArea eHitTarget=EGUIViewImageHitArea_None, EGUIViewImageMouseInteractionMode eMouseMode=EGUIViewImageMouseInteractionMode_None, EModifierMatch eCtrlKey=EModifierMatch_Any, EModifierMatch eShiftKey=EModifierMatch_Any, EModifierMatch eAltKey=EModifierMatch_Any)
Sets the interaction rule for the image view by mapping a gesture to an action under specific conditi...
double GetZoomFitScale(double f64ClientWidth, double f64ClientHeight) const
Retrieves the scale in zoom fit state according to the width and height of the image and the width an...
virtual const CResult PopupImageFigureByConditions(const Base::CFLString< wchar_t > &strExpression, const Base::CProcessingUnitBase *pPu=nullptr, bool bFigureArrayAsShape=false)
Creates figure objects from figures stored in the current view's image that match conditions (e....
size_t GetWindowHandle()
Returns the window handle of the image view.
virtual void SetFigureObjectFillColorAlphaRatio(float f32Ratio)
Sets the fill alpha ratio for figure objects globally. After calling this function,...
void EnableRatioSyncPointOfView(bool bEnabled)
Enable or disable normalized ratio-based synchronization for point of view.
virtual double GetThumbnailViewHeightMin() const
Get the minimum value of the ratio of thumbnail view height to image view height.
virtual const CResult SaveFigure(Foundation::CFLFigure *pFigure, const wchar_t *pWcsPath=nullptr)
Save the CFLFigure object as a file with a .fig extension.
virtual const CResult LoadFigure(const wchar_t *pWcsPath=nullptr, bool bErrorMsgBox=false)
Load a file with a .fig extension into the view.
virtual bool IsFigureObjectRotationEnabled(int32_t i32FigureObjectIndex) const
Gets whether the rotation function of the image view figure object is enabled.
static void SetDefaultFigureObjectStringDecimalPlacesForPixelAccuracy(uint32_t u32DecimalPlaces=2, bool bExponentialNotationForPixelAccuracy=false, bool bSaveToConfig=true)
Sets the default format string used to represent the information of newly created figure objects as a...
virtual void ShowImageCenter(bool bShow)
Sets whether to show/hide the center of image.
const CResult PushFrontFigureObject(Foundation::CFLFigure *pFlf, const FLImaging::GUI::CGUIViewImageObjectFigureContextMenuFilter &viofCmFilter)
Add Figure to the front.
bool IsContinuousFigureCreationModeEnabled() const
Check whether the continuous creation mode for ObjectFigure is enabled.
const CResult DesynchronizePageIndex(const CGUIViewImageWrap *pViewImageTarget)
Turn off page index synchronization for the parameter's view.
virtual Foundation::CFLPoint< int32_t > ConvertImageCoordToCanvasCoord(const Foundation::CFLPoint< double > &flp)
Convert image coordinates to canvas coordinates.
virtual void EnableFigureObjectMagnetToImage(bool bEnable, bool bSaveToConfig=true)
Sets the magnet option (the option that sticks to the edge if the figure object is located near the e...
const CResult ConvertSelectedFigureObjectToLayer(CGUIViewImageLayerWrap *pLayer, uint32_t u32Color=-1)
Draws the selected Figure Object onto the selected layer. Remove the Figure Object on success.
virtual const CResult ZoomAtCenter(double f64Scale)
Sets the image view scale to f64Scale while maintaining the current center coordinates.
virtual bool IsFigureObjectMagnetToImageEnabled() const
Returns the magnet option for globally set figure objects (the option that sticks to the edge if the ...
const CResult PushBackFigureObject(Foundation::CFLFigure &flf, const FLImaging::GUI::CGUIViewImageObjectFigureContextMenuFilter &viofCmFilter)
Add Figure to the back. See PushFrontFigureObject(Foundation::CFLFigure&, const CGUIViewImageObjectFi...
virtual void EnableMouseWheel(bool bEnable)
Sets whether to enable mouse wheel.
virtual bool IsImageCoordinateOnCursorVisible() const
Determines whether the image coordinates are displayed at the mouse cursor position in the image view...
virtual EFreeDrawOutputMode GetFreeDrawOutputMode() const
Retrieves the current merge behavior used in pen-based drawing modes (ETeachingMode_Figure_FreeDraw o...
virtual const CResult SetFreeDrawMergeMode(EFreeDrawMergeMode eFreeDrawMergeMode)
Sets the merge behavior for pen-based drawing modes (ETeachingMode_Figure_FreeDraw or ETeachingMode_F...
bool IsViewImageContextMenuAvailable(FLImaging::GUI::EMenuItem eMenu) const
Checks whether the specified context menu item is currently available in the Image view.
virtual const CResult GetFloatingImageValueRange(double &f64Min, double &f64Max) const
Get the maximum and minimum value for the pixel value of the floating point image.
virtual bool IsActionConfirmationEnabled(uint32_t u32MenuItem) const
Returns whether action confirmation is enabled for this image view instance.
virtual void ShowImageFigure(bool bShow)
Shows or hides the figures stored in the image.
Foundation::CFLFigure * GetFigureObjectRef(int32_t i32Index) const
Retrieves a reference to the internally managed figure corresponding to the specified index.
static void SetDefaultFigureObjectStringDecimalPlaces(uint32_t u32DecimalPlaces=2, bool bExponentialNotation=false, bool bSaveToConfig=true)
Sets the default format string globally when representing information about a newly created figure ob...
virtual const CResult StartAutoSaveImage(double f64PeriodMs=60000.)
Starts automatic image saving at specified intervals.
const CResult DesynchronizePageIndexAll()
Desynchronize the page index of the current view.
virtual const CResult SetImageFigureTextOpacityBorder(float f32Opacity=1.f, bool bSaveToConfig=true)
Sets the default border opacity for label text when drawing a Figure stored in an image.
virtual void SetFigureObjectMagnetOption(EViewImageFigureObjectMagnetOption eOption)
Set the magnet options of the image view figure object.
virtual bool IsImageFigureRealSizeText() const
Returns whether or not the string in the image Figure is displayed in its real size.
virtual bool IsFigureObjectAngleMagnetEnabled() const
Returns the angle magnet option for a globally set figure object (the option to have a multiples valu...
virtual bool GetFigureObjectStringExponentialFlagForPixelAccuracy() const
Retrieves whether exponential notation is used when representing the information of a figure object a...
const CResult GetPixelAccuracy(double &f64PixelAccuracyX, double &f64PixelAccuracyY) const
Retrieves the Pixel Accuracy X, Y of the ImageView.
Foundation::CFLRect< int32_t > GetImageRect() const
Returns the image area of the image view.
bool IsSynchronized(FLImaging::GUI::EViewImageSyncOption eViewImageSyncOption)
Returns whether the current image view is synchronized with another image view for a particular optio...
virtual void ShowCrosshair(bool bShow)
Sets whether to show/hide the crosshair.
virtual bool IsPixelValueVisible() const
Determines whether the pixel value is shown or hidden.
virtual double GetAutoZoomFitTolerance() const
Gets the tolerance ratio used to determine whether the current viewport is preserved when the image s...
const CResult CaptureScreen(Base::CFLImage *pFliImage, bool bIncludeFrame=false)
Capture the current screen.
virtual const CResult ClearPages(Base::CFLArray< int32_t > *pFlaPageIndices)
Clear the selected pages in the image.
virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio, double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax)
Set the ratio of thumbnail view height to image view height.
virtual const CResult SavePages(Base::CFLArray< int32_t > *pFlaPageIndices, const wchar_t *pWcsFileNameWithPath=nullptr)
Save the selected pages in the image.
Foundation::CFLFigure * PopFigureObject(int32_t i32Index)
Retrieves and removes the figure corresponding to the specified index as a duplicated object.
const CResult ClearStatusBarItemElasticMinimumWidth(EViewImageStatusBarItem eItem)
Clears the elastic minimum width constraint of a specific status bar item. After clearing,...
virtual void ShowImage(bool bShow)
Sets whether to show/hide the image.
void EnableContinuousFigureCreationMode(bool bEnable)
Enable or disable the continuous creation mode for ObjectFigure.
virtual uint32_t GetCanvasColor() const
Retrieves the background color of the image view.
const CResult ClearFigureObject()
Removes all CGUIViewImageObjectFigure objects in the image view.
const CResult SynchronizePointOfView(const CGUIViewImageWrap *pViewImageTarget)
Synchronizes the view point of the parameter and the current view.
Foundation::CFLFigure * PopAllFigureObject()
Retrieves and removes all figure objects as duplicated object(s).
Foundation::ELengthUnit GetPixelAccuracyUnit() const
Retrieves the units for Pixel Accuracy of the ImageView.
virtual Foundation::CFLRect< double > ConvertCanvasCoordToImageCoord(const Foundation::CFLRect< int32_t > &flr)
Convert canvas coordinates to image coordinates.
virtual const CResult CreatePage(FLImaging::GUI::EViewImageCreatePageOption eOption=EViewImageCreatePageOption_Append)
Creates a new page in the image displayed in the view.
virtual bool IsActionConfirmationEnabled(EMenuItemObjectFigure eMenuItem) const
Returns whether action confirmation is enabled for this image view instance.
virtual const CResult ZoomFit()
Scales the image view so that the image is sized to fit the image view.
static EFigureObjectInformationText GetDefaultFigureObjectInformationTextOption()
Returns the default information string display option for globally set newly created figure objects.
virtual void EnablePixelSegmentationMode(bool bEnable)
Sets whether to enable features that can be viewed by coloring the pixel values in the image view.
static bool IsDefaultActionConfirmationEnabled(EMenuItemImageFigure eMenuItem)
Gets the default action confirmation state for each popup menu item.
virtual Base::CFLImage * GetImagePtr()
Retrieves an image pointer displayed in the image view.
virtual bool IsImageMiniMapVisible() const
Determines whether the minimap is shown or hidden.
virtual void ShowFigureCoordinateOnCursor(bool bShow)
Sets whether figure coordinates are displayed at the mouse cursor position when hovering over a figur...
double GetPixelAccuracyX() const
Returns the Pixel Accuracy for the X coordinate of the ImageView.
virtual float GetImageFigureOpacityFill() const
Gets the default fill opacity applied when drawing a Figure stored in an image.
const CResult PushBackFigureObject(Foundation::CFLFigure &flf, EAvailableFigureContextMenu eMenu, EAvailableFigureContextMenu2 eMenu2)
Add Figure to the back.
virtual bool IsImageVisible() const
Determines whether the image is shown or hidden.
virtual const CResult RemoveImageFigure(const Base::CFLArray< int32_t > *pFlaI32Index, bool bPopupMsgBox=false)
Clear figure objects from figures of specific indices stored in the current view's image.
Foundation::CFLFigure * GetFigureObject(const wchar_t *pWcsObjectName) const
Retrieves a duplicated figure whose name matches the specified string.
virtual void ShowFigureObjectInformationText(bool bShow=true, bool bSaveToConfig=true)
Sets the global option for whether image view figure objects display an information string....
CGUIViewImageLayerWrap GetNamedLayer(int32_t i32Index) const
Retrieves the layer defined by name using its index. The index is defined in the order the layers are...
virtual const CResult RemoveImageFigure(int32_t i32Idx, bool bPopupMsgBox=false)
Clear the Figure object for the i32Idx-th figure stored in the current view's image.
virtual bool IsImageBorderVisible() const
Indicates whether border of image view is drawn.
static void SetDefaultFigureObjectInformationTextVisible(bool bVisible=true, bool bSaveToConfig=true)
Sets the default global option for whether newly created image view figure objects display an informa...
const CResult ClearMeasurement()
Removes all Measurement objects in the ImageView.
virtual bool IsHoverImageFigureEnabled() const
A function that returns whether the figure is highlighted when the mouse touches the figure stored in...
virtual Foundation::CFLPoint< double > ConvertClientCoordToImageCoord(int32_t i32X, int32_t i32Y)
Convert client coordinates to image coordinates.
virtual float GetImageFigureTextOpacityFill() const
Gets the default fill opacity for label text when drawing a Figure stored in an image.
virtual ETeachingMode GetTeachingMode() const
Return the teaching mode set for the current view.
static const CResult EnableDefaultActionConfirmation(EMenuItem eMenuItem, bool bEnable=true)
Sets the default action confirmation state for each popup menu item.
virtual void SetPixelNumberMode(EPixelNumberMode eMode)
Sets the pixel value display mode of the image.
virtual const CResult SelectMenuItem(EMenuItemImageFigure eMenuItem)
Performs a command on the selected menu item.
virtual Foundation::CFLPoint< double > GetViewCenterImageCoord() const
Returns the image coordinates corresponding to the center position of the image view.
EGUIViewImageHitArea GetHitArea() const
Retrieves the Hit area for the current mouse position in the ImageView.
const CResult ConvertSelectedFigureObjectToLayer(int32_t i32LayerIndex, uint32_t u32Color=-1)
Draws the selected Figure Object onto the selected layer. Remove the Figure Object on success.
static float GetDefaultFigureObjectInformationTextFontSize()
Returns the default global font size used for the information text displayed by newly created image v...
virtual Foundation::CFLPoint< int32_t > ConvertCanvasCoordToClientCoord(int32_t x, int32_t y)
Convert canvas coordinates to client coordinates.
virtual EFreeDrawMergeMode GetFreeDrawMergeMode() const
Retrieves the current merge behavior used in pen-based drawing modes (ETeachingMode_Figure_FreeDraw o...
virtual Base::CFLString< wchar_t > GetFigureObjectName(int32_t i32FigureObjectIndex) const
Get the name of the image view figure object.
const CResult CreateImage(int64_t i64Width, int64_t i64Height, int32_t i32Channel, int32_t i32Depth, Base::EValueType eType, bool bOptSeparateChannel, const Base::CMultiVar< T > &flmvFillVal, int32_t i32AlignByte=4, int64_t i64WidthStepByte=0)
Creates a new image in the view.
const CResult PasteImageAt(int32_t i32PageIndex)
Paste the most recent copied images from the other views or the bitmaps copied to the clipboard....
virtual Foundation::CFLRect< int32_t > ConvertImageCoordToCanvasCoord(const Foundation::CFLRect< double > &flr)
Convert image coordinates to canvas coordinates.
virtual Foundation::CFLPoint< int32_t > ConvertImageCoordToClientCoord(const Foundation::CFLPoint< double > &flp)
Convert image coordinates to client coordinates.
EPixelFormat
Pixel format.
Definition DefinitionsBase.h:109
@ EPixelFormat_C1_U8
Definition DefinitionsBase.h:146
EValueType
Value type.
Definition DefinitionsBase.h:71
ELengthUnit
Indicates a unit of length.
Definition DefinitionsFoundation.h:77
Definition D2DObject.h:12
EGUIViewImageHitArea
The area where the mouse is located on the image view.
Definition DefinitionsGUI.h:8431
@ EGUIViewImageHitArea_None
None.
Definition DefinitionsGUI.h:8439
EViewImageMouseCapturePolicy
Flags that control under which conditions mouse capture is enabled for the image view.
Definition DefinitionsGUI.h:519
@ EViewImageMouseCapturePolicy_All
Enables mouse capture for all supported mouse operations.
Definition DefinitionsGUI.h:574
EViewImageStatusBarItem
Status Bar Item of CGUIViewImage.
Definition DefinitionsGUI.h:15753
EFreeDrawOutputMode
Defines the output mode (contour polygon or rasterized grid pixel) for pen-based drawing modes (ETeac...
Definition DefinitionsGUI.h:16104
EImageRotateAngle
Available image rotation angle in image view.
Definition DefinitionsGUI.h:7292
EAvailableViewImageContextMenu
Available context menu for image view.
Definition DefinitionsGUI.h:7384
EModifierMatch
Specifies how a modifier key (Ctrl, Shift, Alt) should be matched when evaluating an interaction rule...
Definition DefinitionsGUI.h:11574
@ EModifierMatch_Any
The modifier key state is ignored.
Definition DefinitionsGUI.h:11597
EFigureObjectInformationText
Text options representing information for a figure object.
Definition DefinitionsGUI.h:11334
EGUIViewImageMouseInteractionMode
Enumeration for the current mouse interaction mode of the image view.
Definition DefinitionsGUI.h:435
@ EGUIViewImageMouseInteractionMode_None
None.
Definition DefinitionsGUI.h:442
ETeachingMode
Teaching mode.
Definition DefinitionsGUI.h:9056
EGUIViewImageFontWeight
Font thickness of image view.
Definition DefinitionsGUI.h:9235
@ EGUIViewImageFontWeight_BOLD
Bold thickness.
Definition DefinitionsGUI.h:9305
ELayerAutoClearMode
In auto clear mode of the image view layer, lists cases in which auto clear of the layer is applied a...
Definition DefinitionsGUI.h:9839
EMenuItemObjectFigure
Menu items related to manipulatable Figure objects in the image view.
Definition DefinitionsGUI.h:5000
EFreeDrawMergeMode
Defines whether strokes of the same class drawn in pen-based modes (ETeachingMode_Figure_FreeDraw or ...
Definition DefinitionsGUI.h:16136
EGUIViewGesture
Defines the types of user interface gestures and input events in the GUI view.
Definition DefinitionsGUI.h:127
EGUIViewImageAutoZoomFitTriggerFlags
Enumerates the conditions under which ZoomFit() is automatically invoked without an explicit call to ...
Definition DefinitionsGUI.h:9643
EGUIViewImageInteractionAction
Interaction actions for the image view.
Definition DefinitionsGUI.h:281
EViewImageSyncOption
Image view synchronization options.
Definition DefinitionsGUI.h:9599
EAvailableViewImageContextMenuImageFigure
Available context menu for figure objects stored in the image.
Definition DefinitionsGUI.h:11126
EViewImageFigureObjectMagnetOption
Magnet Options for Image View Figure Objects.
Definition DefinitionsGUI.h:13784
EMenuItem
Image view menu item.
Definition DefinitionsGUI.h:827
EViewImageCreatePageOption
An option of page creation in image view.
Definition DefinitionsGUI.h:766
@ EViewImageCreatePageOption_Append
Append page.
Definition DefinitionsGUI.h:773
EZoomMode
Zoom in and out mode.
Definition DefinitionsGUI.h:9565
EMenuItemImageFigure
Menu item of image figure stored in the image.
Definition DefinitionsGUI.h:4751
EMenuItemObjectMeasure
Menu items related to measurement tool objects in the image view.
Definition DefinitionsGUI.h:7153
EViewImageLoadOption
Image View Load Options Example. The following code will load folder with recursive....
Definition DefinitionsGUI.h:662
@ EViewImageLoadOption_Load
Default Load.
Definition DefinitionsGUI.h:677
@ EViewImageLoadOption_Default
기본
Definition DefinitionsGUI.h:669
EImageFlipDirection
Direction of flip.
Definition DefinitionsGUI.h:7338
EAvailableFigureContextMenu
Available Context Menu for Figure Objects.
Definition DefinitionsGUI.h:10105
EAvailableFigureContextMenu2
Available Context Menu for Figure Objects.
Definition DefinitionsGUI.h:10755
EPixelNumberMode
Pixel value display options in image view.
Definition DefinitionsGUI.h:792