FLImaging 6.12.24.4
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 {
30 {
31 SupportToDuplicateObject(CGUIViewImageWrap);
32
33 public:
42
51
73 const CResult Create(int32_t i32L, int32_t i32T, int32_t i32R, int32_t i32B, size_t stParentWindowHandle = 0);
74
90 const CResult CreateAndFitParent(size_t stParentWindowHandle, bool bAutoFit = true);
91
104
115
128
146 virtual const CResult Load(const wchar_t* pWcsPath = nullptr, FLImaging::GUI::EViewImageLoadOption eOption = EViewImageLoadOption_Default);
147
166
184 virtual const CResult LoadRaw(const wchar_t* pWcsPath = nullptr, FLImaging::GUI::EViewImageLoadOption eOption = EViewImageLoadOption_Load);
185
217 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);
218
236 virtual const CResult Save(const wchar_t* pWcsFileNameWithPath = nullptr, bool bSaveCurrentPage = false, bool bWithLayers = false);
237
253 virtual const CResult SavePage(int32_t i32PageIndex, const wchar_t* pWcsFileNameWithPath = nullptr);
254
272 virtual const CResult SavePages(Base::CFLArray<int32_t>* pFlaPageIndices, const wchar_t* pWcsFileNameWithPath = nullptr);
273
289 virtual const CResult LoadFigure(const wchar_t* pWcsPath = nullptr, bool bErrorMsgBox = false);
290
308 virtual const CResult LoadFigureGBR(const wchar_t* pWcsPath = nullptr, const wchar_t* pWcsLayerName = nullptr, uint32_t u32Color = -1);
309
328 virtual const CResult LoadFigureGBR(const wchar_t* pWcsPath, int32_t i32LayerNo, bool bClearLayer);
329
345 virtual const CResult LoadFigureDXF(const wchar_t* pWcsPath = nullptr, bool bErrorMsgBox = false);
346
362 virtual const CResult SaveFigure(Foundation::CFLFigure* pFigure, const wchar_t* pWcsPath = nullptr);
363
375 virtual const CResult ClearFile();
376
388 virtual const CResult ClearPage();
389
405 virtual const CResult ClearPages(Base::CFLArray<int32_t>* pFlaPageIndices);
406
424
458 template<typename T>
459 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);
460
472
483
496
509
525 virtual const CResult SetImagePtr(Base::CFLImage* pImage);
526
541
556
573
588
603
620
621
636
651
668
683
698
715
730
745
762
777
792
809
817 virtual void ClearAllLayers();
818
842 CGUIViewImageLayerWrap GetLayer(int32_t i32Index) const;
843
867 int32_t GetLayerCount() const;
868
882 CGUIViewImageLayerWrap GetLayerByName(const wchar_t* pWcsLayerName);
883
899 const CResult DeleteLayerByName(const wchar_t* pWcsLayerName);
900
914 bool DoesLayerExist(const wchar_t* pWcsLayerName) const;
915
927 int32_t GetNamedLayerCount() const;
928
942 CGUIViewImageLayerWrap GetNamedLayer(int32_t i32Index) const;
943
963 virtual const CResult SetLayerAutoClearMode(int32_t i32LayerIndex, ELayerAutoClearMode eMode, bool bSet);
964
987
1007 virtual const CResult SetLayerAutoClearMode(ELayerAutoClearMode eMode, bool bSet);
1008
1026 virtual bool GetLayerAutoClearMode(int32_t i32LayerIndex, FLImaging::GUI::ELayerAutoClearMode eMode) const;
1027
1045 virtual bool GetLayerAutoClearMode(const CGUIViewImageLayerWrap* pLayer, ELayerAutoClearMode eMode) const;
1046
1060 virtual const CResult ZoomFitToLayer(int32_t i32LayerIndex);
1061
1077 virtual const CResult ZoomFitToLayer(const CGUIViewImageLayerWrap* pLayer);
1078
1091
1106 const CResult ConvertLayerToFigureObject(int32_t i32LayerIndex);
1107
1126
1142 const CResult ConvertSelectedFigureObjectToLayer(int32_t i32LayerIndex, uint32_t u32Color = -1);
1143
1162
1178 const CResult ConvertAllFigureObjectsToLayer(int32_t i32LayerIndex, uint32_t u32Color = -1);
1179
1197 const CResult ConvertAllFigureObjectsToLayer(CGUIViewImageLayerWrap* pLayer, uint32_t u32Color = -1);
1198
1212 const CResult SelectFigureObject(int32_t i32Index);
1213
1226
1251
1276
1277
1291 const CResult DeleteFigureObject(int32_t i32Index);
1292
1306 const CResult DeleteFigureObject(const wchar_t* pWcsObjectName);
1307
1308
1322 Foundation::CFLFigure* GetFigureObject(int32_t i32Index) const;
1323
1337 Foundation::CFLFigure* GetFigureObject(const wchar_t* pWcsObjectName) const;
1338
1351
1364
1377
1392
1408 Foundation::CFLFigure* PopFigureObject(const wchar_t* pWcsObjectName);
1409
1422
1434 bool DoesFigureObjectExist(int32_t i32Index);
1435
1447 bool DoesFigureObjectExist(const wchar_t* pWcsObjectName);
1448
1449
1459 int32_t GetFigureObjectCount() const;
1460
1461
1474
1490 virtual const CResult SetViewCenter(const Foundation::CFLPoint<double>& flpImageCoord);
1491
1509 virtual const CResult SetViewCenterAndScale(const Foundation::CFLPoint<double>& flpImageCoord, double f64Scale);
1510
1524 virtual const CResult ZoomAtCenter(double f64Scale);
1525
1538
1539 virtual const CResult InternalSetOffset(const Foundation::CFLPoint<double>& flpOffset);
1540
1541
1551 virtual double GetScale() const;
1552
1553 virtual const CResult InternalSetScale(double f64Scale);
1554
1568 double GetZoomFitScale(double f64ClientWidth, double f64ClientHeight) const;
1569
1570
1571 virtual const CResult InternalZoomIn(int32_t i32CanvasX, int32_t i32CanvasY, double f64Ratio = 1.25);
1572
1573 virtual const CResult InternalZoomOut(int32_t i32CanvasX, int32_t i32CanvasY, double f64Ratio = 0.8);
1574
1586 virtual const CResult ZoomFit();
1587
1599 virtual const CResult MoveToPrevPage();
1600
1612 virtual const CResult MoveToNextPage();
1613
1627 virtual const CResult MoveToPage(int32_t i32PageNum);
1628
1641
1651 virtual void SetCanvasColor(uint32_t u32Color);
1652
1662 virtual uint32_t GetCanvasColor() const;
1663
1673 virtual void ShowImage(bool bShow);
1674
1684 virtual bool IsImageVisible() const;
1685
1695 virtual void ShowThumbnailView(bool bShow);
1696
1706 virtual bool IsThumbnailViewVisible() const;
1707
1717 virtual void SetFixThumbnailView(bool bFix);
1718
1728 virtual bool IsThumbnailViewFixed() const;
1729
1730
1740 virtual void ShowImageMiniMap(bool bShow);
1741
1751 virtual bool IsImageMiniMapVisible() const;
1752
1762 virtual void ShowPageIndex(bool bShow);
1763
1773 virtual bool IsPageIndexVisible() const;
1774
1775
1785 virtual void ShowGrid(bool bShow);
1786
1796 virtual bool IsGridVisible() const;
1797
1798
1808 virtual void ShowImageCenter(bool bShow);
1809
1819 virtual bool IsImageCenterVisible() const;
1820
1830 virtual void ShowImageBorder(bool bShow);
1831
1841 virtual bool IsImageBorderVisible() const;
1842
1852 virtual void ShowCrosshair(bool bShow);
1853
1863 virtual bool IsCrosshairVisible() const;
1864
1874 virtual void ShowImageCoordinateOnCursor(bool bShow);
1875
1886
1896 virtual void ShowFigureCoordinateOnCursor(bool bShow);
1897
1908
1918 virtual void ShowImagePixelValueOnCursor(bool bShow);
1919
1930
1944 virtual const CResult SetDecimalPlacesOfCoordinate(uint8_t u8DecimalPlaces = 2);
1945
1955 virtual uint8_t GetDecimalPlacesOfCoordinate() const;
1956
1966 virtual void ShowIntensitySpectrum(bool bShow);
1967
1977 virtual bool IsIntensitySpectrumVisible() const;
1978
1979
1989 virtual void ShowPixelValue(bool bShow);
1990
2000 virtual bool IsPixelValueVisible() const;
2001
2014
2027
2043 const CResult SetPixelAccuracy(double f64PixelAccuracyX, double f64PixelAccuracyY);
2044
2060 const CResult GetPixelAccuracy(double* pF64PixelAccuracyX, double* pF64PixelAccuracyY) const;
2061
2077 const CResult GetPixelAccuracy(double& f64PixelAccuracyX, double& f64PixelAccuracyY) const;
2078
2079
2093 const CResult SetPixelAccuracyX(double f64PixelAccuracyX);
2094
2104 double GetPixelAccuracyX() const;
2105
2106
2120 const CResult SetPixelAccuracyY(double f64PixelAccuracyY);
2121
2131 double GetPixelAccuracyY() const;
2132
2133
2150
2163
2164
2181
2196
2213
2230
2244 const CResult SynchronizePointOfView(const CGUIViewImageWrap* pViewImageTarget);
2245
2260
2273
2299 void EnableRatioSyncPointOfView(bool bEnabled);
2300
2311
2325 const CResult SynchronizePageIndex(const CGUIViewImageWrap* pViewImageTarget);
2326
2340 const CResult DesynchronizePageIndex(const CGUIViewImageWrap* pViewImageTarget);
2341
2354
2355
2369 const CResult ShowScrollBar(bool bShow);
2370
2384 const CResult ShowStatusBar(bool bShow);
2385
2404
2419
2438
2455
2473 const CResult GetStatusBarItemElasticMinimumWidth(EViewImageStatusBarItem eItem, int32_t& i32MinimumWidth) const;
2474
2492 const CResult CaptureScreen(Base::CFLImage& fliImage, bool bIncludeFrame = false);
2493
2511 const CResult CaptureScreen(Base::CFLImage* pFliImage, bool bIncludeFrame = false);
2512
2513
2526
2547
2559
2577 const CResult PasteImageAt(int32_t i32PageIndex);
2578
2595
2612
2630 const CResult RearrangePageOrder(int32_t i32OrigPageIndex, int32_t i32TargetPageIndex);
2631
2651 const CResult RearrangePageOrder(Base::CFLArray<int32_t>* pFlaPageIndices, int32_t i32TargetPageIndex);
2652
2668 virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio);
2669
2689 virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio, double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax);
2690
2708 virtual const CResult SetThumbnailViewHeightRange(double f64ThumbnailViewRatioMin, double f64ThumbnailViewRatioMax);
2709
2719 virtual double GetThumbnailViewHeight() const;
2720
2730 virtual double GetThumbnailViewHeightMin() const;
2731
2741 virtual double GetThumbnailViewHeightMax() const;
2742
2760 virtual const CResult SetFloatingImageValueRange(float f32Min, float f32Max);
2761
2779 virtual const CResult GetFloatingImageValueRange(float& f32Min, float& f32Max) const;
2780
2798 virtual const CResult SetFloatingImageValueRange(double f64Min, double f64Max);
2799
2817 virtual const CResult GetFloatingImageValueRange(double& f64Min, double& f64Max) const;
2818
2828 virtual void EnableSelection(bool bEnable);
2829
2839 virtual bool IsSelectionEnabled() const;
2840
2850 virtual void EnableDragAndDrop(bool bEnable);
2851
2861 virtual bool IsDragAndDropEnabled() const;
2862
2875
2888
2900 virtual void SetFigureObjectName(int32_t i32FigureObjectIndex, const wchar_t* pWcsName);
2901
2915 virtual Base::CFLString<wchar_t> GetFigureObjectName(int32_t i32FigureObjectIndex) const;
2916
2929
2942
2955
2968
2980 virtual void EnableFigureObjectRotation(int32_t i32FigureObjectIndex, bool bEnable);
2981
2993 virtual bool IsFigureObjectRotationEnabled(int32_t i32FigureObjectIndex) const;
2994
3004 virtual void EnableMouseWheel(bool bEnable);
3005
3015 virtual bool IsMouseWheelEnabled() const;
3016
3026 virtual void EnableMouseWheelButton(bool bEnable);
3027
3037 virtual bool IsMouseWheelButtonEnabled() const;
3038
3050 virtual void ShowFigureObjectInformationTextGlobal(bool bShow = true, bool bSaveToConfig = true);
3051
3062
3078 virtual void EnableFigureObjectInformationTextRealSizeGlobal(bool bEnable = false, bool bSaveToConfig = true);
3079
3090
3102 virtual void SetFigureObjectInformationTextFontSizeGlobal(float f32FontSize = Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig = true);
3103
3114
3128 virtual void SetFigureObjectInformationTextOptionGlobal(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig = true);
3129
3142
3156 virtual void SetFigureObjectStringDecimalPlacesGlobal(uint32_t u32DecimalPlaces = 2, bool bExponentialNotation = false, bool bSaveToConfig = true);
3157
3171 virtual void SetFigureObjectStringDecimalPlacesForPixelAccuracyGlobal(uint32_t u32DecimalPlaces = 2, bool bExponentialNotationForPixelAccuracy = false, bool bSaveToConfig = true);
3172
3183
3194
3205
3216
3230 template<typename T>
3232
3247
3259 virtual void EnableFigureObjectMagnetToImageGlobal(bool bEnable, bool bSaveToConfig = true);
3260
3271
3283 virtual void EnableFigureObjectAngleMagnetGlobal(bool bEnable, bool bSaveToConfig = true);
3284
3295
3309 virtual const CResult PopupImageFigure(int32_t i32Idx);
3310
3326 virtual const CResult PopupImageFigure(const Base::CFLArray<int32_t>* pFlaI32Index);
3327
3340
3357
3373 virtual const CResult RemoveImageFigure(int32_t i32Idx, bool bPopupMsgBox = false);
3374
3392 virtual const CResult RemoveImageFigure(const Base::CFLArray<int32_t>* pFlaI32Index, bool bPopupMsgBox = false);
3393
3411 virtual const CResult RemoveImageFiguresByConditions(const Base::CFLString<wchar_t>& strExpression, bool bPopupMsgBox = false);
3412
3430 virtual const CResult RemoveImageFiguresByConditionsFromAllPages(const Base::CFLString<wchar_t>& strExpression, bool bPopupMsgBox = false);
3431
3445 virtual const CResult ClearImageFiguresAll(bool bPopupMsgBox = false);
3446
3460 virtual const CResult ClearImageFiguresAllPages(bool bPopupMsgBox = false);
3461
3477 virtual const CResult SetImageFigureRealSizeText(bool bRealSize = false, bool bSaveToConfig = true);
3478
3488 virtual bool IsImageFigureRealSizeText() const;
3489
3513 virtual const CResult SetImageFigureTextFont(const wchar_t* pStrFontName = nullptr, int32_t i32FontSize = 12, EGUIViewImageFontWeight eFontWeight = EGUIViewImageFontWeight_BOLD, bool bItalic = false, bool bSaveToConfig = true);
3514
3536 virtual const CResult GetImageFigureTextFont(wchar_t** ppStrFontName, int32_t& i32FontSize, EGUIViewImageFontWeight& eFontWeight, bool& bItalic) const;
3537
3553 virtual const CResult SetImageFigureBorderWidth(int32_t i32BorderWidth = 1, bool bSaveToConfig = true);
3554
3564 virtual int32_t GetImageFigureBorderWidth() const;
3565
3581 virtual const CResult SetImageFigureOpacityBorder(float f32Opacity = 1.f, bool bSaveToConfig = true);
3582
3592 virtual float GetImageFigureOpacityBorder() const;
3593
3609 virtual const CResult SetImageFigureOpacityFill(float f32Opacity = 0.3f, bool bSaveToConfig = true);
3610
3620 virtual float GetImageFigureOpacityFill() const;
3621
3637 virtual const CResult SetImageFigureTextOpacityBorder(float f32Opacity = 1.f, bool bSaveToConfig = true);
3638
3648 virtual float GetImageFigureTextOpacityBorder() const;
3649
3665 virtual const CResult SetImageFigureTextOpacityFill(float f32Opacity = 1.f, bool bSaveToConfig = true);
3666
3676 virtual float GetImageFigureTextOpacityFill() const;
3677
3687 virtual void ShowImageFigure(bool bShow);
3688
3698 virtual bool IsImageFigureVisible() const;
3699
3709 virtual void ShowImageFigureText(bool bShow);
3710
3720 virtual bool IsImageFigureTextVisible() const;
3721
3731 virtual void EnableHoverImageFigure(bool bEnable);
3732
3742 virtual bool IsHoverImageFigureEnabled() const;
3743
3754
3764 virtual void EnablePixelSegmentationMode(bool bEnable);
3765
3779 virtual void SetSegmentationLabelText(int32_t i32Channel, double f64Value, const Base::CFLString<wchar_t>& strLabelText);
3780
3798 virtual const CResult GetSegmentationLabelText(int32_t i32Channel, double f64Value, Base::CFLString<wchar_t>& strLabelTextResult) const;
3799
3812
3823
3833 virtual void EnableReductionInterpolation(bool bEnable);
3834
3844 virtual void SetPanningMode(bool bSet);
3845
3855 virtual bool IsPanningMode() const;
3856
3868 virtual void SetZoomMode(EZoomMode eZoomMode);
3869
3881 virtual EZoomMode GetZoomMode() const;
3882
3898 virtual const CResult SetTeachingMode(ETeachingMode eTeachingMode);
3899
3912
3934 virtual const CResult SetFreeDrawMergeMode(EFreeDrawMergeMode eFreeDrawMergeMode);
3935
3950
3960 virtual void EnableSystemMenuOnFileDialog(bool bEnable);
3961
3972
3988 virtual const CResult StartAutoPageScroll(int64_t i64PageStep = 1, double f64PeriodMs = 1000.);
3989
4002
4016 virtual const CResult StartAutoSaveImage(double f64PeriodMs = 60000.);
4017
4030
4043
4056
4057 private:
4058 void operator=(const CGUIViewImageWrap& rh);
4060
4061 DeclareGetClassType();
4062 };
4063}
4064}
4065
Template type array class.
Definition FLArray.h:53
FLIMaging's image class.
Definition FLImage.h:35
Template type string class.
Definition FLString.h:34
Multi variable class.
Definition MultiVar.h:31
FLImaging module execution result object.
Definition ResultsDef.h:1640
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
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.
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 bool IsFigureObjectAngleMagnetGlobalEnabled() const
Returns the angle magnet option for a globally set figure object (the option to have a multiples valu...
virtual void ShowImageMiniMap(bool bShow)
Sets whether to show/hide the minimap.
virtual double GetScale() const
Returns the current scale of the ImageView.
virtual float GetFigureObjectInformationTextFontSizeGlobal() const
Returns the global font size used for the information text displayed by image view figure objects.
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.
const CResult SetPixelAccuracyX(double f64PixelAccuracyX)
Sets the Pixel Accuracy X of the ImageView.
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.
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 Foundation::CFLRect< int32_t > ConvertImageCoordToClientCoord(const Foundation::CFLRect< double > &flr)
Convert image coordinates to client coordinates.
virtual Foundation::CFLPoint< int32_t > ConvertImageCoordToCanvasCoord(double x, double y)
Convert image coordinates to canvas coordinates.
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.
bool DoesFigureObjectExist(const wchar_t *pWcsObjectName)
Retrieves the existence of a figure object whose figure name matches the string passed as a parameter...
virtual bool IsFigureObjectMagnetToImageGlobalEnabled() const
Returns the magnet option for globally set figure objects (the option that sticks to the edge if the ...
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.
const CResult SynchronizePageIndex(const CGUIViewImageWrap *pViewImageTarget)
Synchronizes the parameter's view with the selected page index of the current view.
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.
virtual void SetFigureObjectStringDecimalPlacesForPixelAccuracyGlobal(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 ...
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 SetLayerAutoClearMode(int32_t i32LayerIndex, ELayerAutoClearMode eMode, bool bSet)
Sets the automatic clear mode of the layer.
virtual void ShowFigureObjectInformationTextGlobal(bool bShow=true, bool bSaveToConfig=true)
Sets the global option for whether image view figure objects display an information string....
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 void SetFigureObjectInformationTextOptionGlobal(EFigureObjectInformationText eFigureObjectInformationText, bool bSaveToConfig=true)
Sets the information string display option for an image view figure object globally....
virtual bool IsReductionInterpolationEnabled() const
Returns whether interpolation is performed when the image is reduced.
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 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 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 const CResult SelectMenuItem(FLImaging::GUI::EMenuItem eMenuItem)
Performs a command on the selected menu item.
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.
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 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 bool IsThumbnailViewFixed() const
Determines whether the preview thumbnail pane for the image page is pinned.
virtual const CResult Load(Base::CFLArray< FLImaging::Base::CFLString< wchar_t > > *pFlaStrPath, FLImaging::GUI::EViewImageLoadOption eOption=EViewImageLoadOption_Default)
Load image files included in the list.
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.
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.
virtual uint32_t GetFigureObjectStringDecimalPlacesForPixelAccuracyGlobal() const
Retrieves the number of decimal places displayed when representing the information of a figure object...
virtual void SetFigureObjectInformationTextFontSizeGlobal(float f32FontSize=Foundation::g_f32GlobalDefaultDrawingFigureTextFontSize, bool bSaveToConfig=true)
Sets the global font size for the information text displayed by image view figure objects....
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...
virtual FLImaging::GUI::EViewImageFigureObjectMagnetOption GetFigureObjectMagnetOption() const
Get the magnet option of the image view figure object.
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.
FLImaging::Base::CFLString< wchar_t > GetFigureObjectFormatStringGlobal(bool *pBExponentialNotation=nullptr) const
Gets the format string for representing information about the figure object as a string.
virtual void ShowPageIndex(bool bShow)
Sets whether to show/hide the image page index.
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 all of the figures.
FLImaging::Base::CFLString< wchar_t > GetFigureObjectFormatStringForPixelAccuracyGlobal(bool *pBExponentialNotation=nullptr) const
Retrieves the format string used to represent the information of a figure object as a string with app...
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 GetLayerAutoClearMode(const CGUIViewImageLayerWrap *pLayer, ELayerAutoClearMode eMode) const
Retrieves the auto-clear status of the layer for the specified mode.
virtual bool IsFigureCoordinateOnCursorVisible() const
Determines whether the figure coordinates are displayed at the mouse cursor position when hovering ov...
const CResult PushBackFigureObject(Foundation::CFLFigure *pFigure, FLImaging::GUI::EAvailableFigureContextMenu eMenu=FLImaging::GUI::EAvailableFigureContextMenu_All, FLImaging::GUI::EAvailableFigureContextMenu2 eMenu2=FLImaging::GUI::EAvailableFigureContextMenu2_All)
Add Figure to the back.
virtual void SetAvailableViewImageContextMenuImageFigure(EAvailableViewImageContextMenuImageFigure eMenu)
Sets available context menu for Image Figure in this image view.
virtual bool IsThumbnailViewVisible() const
Determines whether the preview thumbnail window is shown or hidden.
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 void SetFigureObjectMagnetOption(FLImaging::GUI::EViewImageFigureObjectMagnetOption eOption)
Set the magnet options of the image view figure object.
virtual const CResult SetThumbnailViewHeight(double f64ThumbnailViewRatio)
Set the ratio of thumbnail view height to image view height.
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 void ShowImageFigureText(bool bShow)
Shows or hides the labels (names) of the figures stored in the image.
virtual bool IsFigureObjectInformationTextRealSizeEnabledGlobal() const
Returns whether the information text of image view figure objects scales according to the image view'...
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 the last object in the figure objects list and removes it.
virtual void SetAvailableViewImageContextMenu(EAvailableViewImageContextMenu eMenu)
Sets the available context menu for the image view.
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....
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.
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.
Foundation::CFLFigure * PopFrontFigureObject()
Retrieves the first object in the figure objects list and removes it.
virtual const CResult StartAutoPageScroll(int64_t i64PageStep=1, double f64PeriodMs=1000.)
Starts automatic page scrolling at specified intervals.
virtual Foundation::CFLPoint< int32_t > ConvertClientCoordToCanvasCoord(int32_t x, int32_t y)
Convert client coordinates to canvas coordinates.
virtual void SetCanvasColor(uint32_t u32Color)
Sets the image view's background color.
virtual EFigureObjectInformationText GetFigureObjectInformationTextOptionGlobal() const
Returns the information string display option for globally set figure objects.
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.
virtual const CResult RemoveImageFiguresByConditionsFromAllPages(const Base::CFLString< wchar_t > &strExpression, bool bPopupMsgBox=false)
Removes shapes that meet certain conditions (e.g., width is 10 or greater, type is 'rect',...
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...
const CResult CopyPages(Base::CFLArray< int32_t > *pFlaPageIndices)
Copy the selected pages to the clipboard.
virtual void EnableFigureObjectAngleMagnetGlobal(bool bEnable, bool bSaveToConfig=true)
Sets the angle magnet option for the figure object globally (the option to have a multiples value of ...
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 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.
virtual void EnableFigureObjectRotation(int32_t i32FigureObjectIndex, bool bEnable)
Enables the rotation function of the image view figure object.
const CResult PushFrontFigureObject(Foundation::CFLFigure *pFigure, FLImaging::GUI::EAvailableFigureContextMenu eMenu=FLImaging::GUI::EAvailableFigureContextMenu_All, FLImaging::GUI::EAvailableFigureContextMenu2 eMenu2=FLImaging::GUI::EAvailableFigureContextMenu2_All)
Add Figure to the front.
Foundation::CFLFigure * PopFigureObject(const wchar_t *pWcsObjectName)
Returns a figure object with the same name as the string passed as a parameter and removes it from th...
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 the figure corresponding to the index passed as a parameter.
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 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.
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.
virtual const CResult ClearSegmentationLabelText()
Removes all labels set for a particular pixel value.
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 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 uint32_t GetFigureObjectStringDecimalPlacesGlobal() const
Gets the format string for representing information about the figure object as a string.
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 ConvertLayerToFigureObject(CGUIViewImageLayerWrap *pLayer)
Puts the figure drawn on the selected layer onto the view as a Figure Object. If there are more than ...
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.
virtual EAvailableViewImageContextMenuImageFigure GetAvailableViewImageContextMenuImageFigure() const
Retrieves available context menu for Image Figure in this image view.
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.
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...
virtual bool GetFigureObjectStringExponentialFlagGlobal() const
Gets the format string for representing information about the figure object as a string.
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 void EnableFigureObjectMagnetToImageGlobal(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 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 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 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.
virtual const CResult RemoveImageFiguresByConditions(const Base::CFLString< wchar_t > &strExpression, bool bPopupMsgBox=false)
Removes figures stored in the current view's image that match conditions (e.g., width greater than 10...
virtual EAvailableViewImageContextMenu GetAvailableViewImageContextMenu() const
Retrieves the available context menu for the image view.
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).
virtual void EnableFigureObjectInformationTextRealSizeGlobal(bool bEnable=false, bool bSaveToConfig=true)
Sets whether the information text of image view figure objects should scale according to the image vi...
bool IsRatioSyncPointOfViewEnabled() const
Check whether normalized ratio-based synchronization for point of view is enabled.
const CResult DesynchronizePointOfViewAll()
Desynchronize the current view's viewpoint.
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...
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.
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...
size_t GetWindowHandle()
Returns the window handle of the image view.
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.
virtual void ShowImageCenter(bool bShow)
Sets whether to show/hide the center of image.
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.
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 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 const CResult SetFreeDrawMergeMode(EFreeDrawMergeMode eFreeDrawMergeMode)
Sets the merge behavior for pen-based drawing modes (ETeachingMode_Figure_FreeDraw or ETeachingMode_F...
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 GetFigureObjectStringExponentialFlagForPixelAccuracyGlobal() const
Retrieves whether exponential notation is used when representing the information of a figure object a...
virtual void ShowImageFigure(bool bShow)
Shows or hides the figures stored in the image.
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 bool IsImageFigureRealSizeText() const
Returns whether or not the string in the image Figure is displayed in its real size.
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.
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.
virtual bool IsFigureObjectInformationTextVisibleGlobal() const
Returns whether the globally set figure object displays an information string.
Foundation::CFLFigure * PopFigureObject(int32_t i32Index)
Returns the figure object corresponding to the index passed as a parameter and removes it from the fi...
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.
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()
Return all figure objects and clear the figure object list.
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 const CResult ZoomFit()
Scales the image view so that the image is sized to fit the image view.
virtual void EnablePixelSegmentationMode(bool bEnable)
Sets whether to enable features that can be viewed by coloring the pixel values in the image view.
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.
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 the figure whose figure name matches the string passed as a parameter.
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 void SetFigureObjectStringDecimalPlacesGlobal(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....
virtual bool IsImageBorderVisible() const
Indicates whether border of image view is drawn.
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 const CResult PopupImageFigureByConditions(const Base::CFLString< wchar_t > &strExpression)
Creates figure objects from figures stored in the current view's image that match conditions (e....
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.
virtual void SetPixelNumberMode(EPixelNumberMode eMode)
Sets the pixel value display mode of the image.
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.
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:88
@ EPixelFormat_C1_U8
Definition DefinitionsBase.h:125
EValueType
Value type.
Definition DefinitionsBase.h:50
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:4529
EViewImageMouseCapturePolicy
Flags that control under which conditions mouse capture is enabled for the image view.
Definition DefinitionsGUI.h:127
@ EViewImageMouseCapturePolicy_All
Enables mouse capture for all supported mouse operations.
Definition DefinitionsGUI.h:182
EViewImageStatusBarItem
Status Bar Item of CGUIViewImage.
Definition DefinitionsGUI.h:11404
EImageRotateAngle
Available image rotation angle in image view.
Definition DefinitionsGUI.h:3453
EAvailableViewImageContextMenu
Available context menu for image view.
Definition DefinitionsGUI.h:3545
EFigureObjectInformationText
Text options representing information for a figure object.
Definition DefinitionsGUI.h:7210
ETeachingMode
Teaching mode.
Definition DefinitionsGUI.h:5118
EGUIViewImageFontWeight
Font thickness of image view.
Definition DefinitionsGUI.h:5297
@ EGUIViewImageFontWeight_BOLD
Bold thickness.
Definition DefinitionsGUI.h:5367
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:5787
EFreeDrawMergeMode
Defines whether strokes of the same class drawn in pen-based modes (ETeachingMode_Figure_FreeDraw or ...
Definition DefinitionsGUI.h:11749
EViewImageSyncOption
Image view synchronization options.
Definition DefinitionsGUI.h:5661
EAvailableViewImageContextMenuImageFigure
Available context menu for figure objects stored in the image.
Definition DefinitionsGUI.h:7002
EViewImageFigureObjectMagnetOption
Magnet Options for Image View Figure Objects.
Definition DefinitionsGUI.h:9570
EMenuItem
Image view menu item.
Definition DefinitionsGUI.h:435
EViewImageCreatePageOption
An option of page creation in image view.
Definition DefinitionsGUI.h:374
@ EViewImageCreatePageOption_Append
Append page.
Definition DefinitionsGUI.h:381
EZoomMode
Zoom in and out mode.
Definition DefinitionsGUI.h:5627
EViewImageLoadOption
Image View Load Options Example. The following code will load folder with recursive....
Definition DefinitionsGUI.h:270
@ EViewImageLoadOption_Load
Default Load.
Definition DefinitionsGUI.h:285
@ EViewImageLoadOption_Default
기본
Definition DefinitionsGUI.h:277
EImageFlipDirection
Direction of flip.
Definition DefinitionsGUI.h:3499
EAvailableFigureContextMenu
Available Context Menu for Figure Objects.
Definition DefinitionsGUI.h:6045
@ EAvailableFigureContextMenu_All
All menu.
Definition DefinitionsGUI.h:6590
EAvailableFigureContextMenu2
Available Context Menu for Figure Objects.
Definition DefinitionsGUI.h:6631
@ EAvailableFigureContextMenu2_All
All menu.
Definition DefinitionsGUI.h:6961
EPixelNumberMode
Pixel value display options in image view.
Definition DefinitionsGUI.h:400