 |
SAGA API
v9.2
|
Go to the documentation of this file.
53 #ifndef HEADER_INCLUDED__SAGA_API__tool_H
54 #define HEADER_INCLUDED__SAGA_API__tool_H
208 bool Reset (
bool bManager =
true);
219 bool Delete_Manager (
bool bDetachData =
false,
bool bReset =
true);
225 bool Settings_Pop (
void);
229 virtual bool needs_GUI (
void)
const {
return(
false ); }
230 bool has_GUI (
void)
const;
232 virtual bool is_Grid (
void)
const {
return(
false ); }
237 void Set_Show_Progress (
bool bOn =
true);
242 bool Execute (
bool bAddHistory =
false);
260 void Set_Description (
const CSG_String &String);
275 bool Dlg_Parameters (
const CSG_String &Identifier);
279 virtual bool Set_Progress (
int Position,
int Range )
const;
280 virtual bool Set_Progress (
sLong Position,
sLong Range )
const;
281 virtual bool Set_Progress (
double Position,
double Range = 1.)
const;
283 bool Stop_Execution (
bool bDialog =
true);
286 bool Message_Dlg_Confirm (
const CSG_String &Text,
const SG_Char *Caption = NULL);
288 void Message_Add (
const CSG_String &Text,
bool bNewLine =
true);
289 void Message_Fmt (
const char *Format, ...);
290 void Message_Fmt (
const wchar_t *Format, ...);
294 bool Error_Fmt (
const char *Format, ...);
295 bool Error_Fmt (
const wchar_t *Format, ...);
298 bool DataObject_Add (
CSG_Data_Object *pDataObject,
bool bUpdate =
false);
300 void DataObject_Update_All (
void);
309 static bool Process_Get_Okay (
bool bBlink =
false);
310 static void Process_Set_Text (
const CSG_String &Text);
311 static void Process_Set_Text (
const char *Format, ...);
312 static void Process_Set_Text (
const wchar_t *Format, ...);
337 bool m_bExecutes, m_bError_Ignore, m_bShow_Progress, m_bWithGUI;
345 CSG_String m_ID, m_Library, m_Library_Menu, m_File_Name, m_Author, m_Version, m_Execution_Info;
348 bool _Synchronize_DataObjects (
void);
353 CSG_String _Get_Script_Python (
bool bHeader,
bool bAllParameters);
356 CSG_String _Get_Script_Python_Wrap (
bool bHeader,
bool bName,
bool bCall);
360 void _Set_Output_History (
void);
364 static int _On_Parameter_Changed (
CSG_Parameter *pParameter,
int Flags);
391 virtual bool is_Grid (
void)
const {
return(
true ); }
396 virtual bool Set_Progress_Cells (
sLong Cell)
const;
397 virtual bool Set_Progress_Rows (
int Row)
const;
400 int Get_NX (
void)
const {
return( Get_System().Get_NX () ); }
401 int Get_NY (
void)
const {
return( Get_System().Get_NY () ); }
403 double Get_XMin (
void)
const {
return( Get_System().Get_XMin () ); }
404 double Get_YMin (
void)
const {
return( Get_System().Get_YMin () ); }
405 double Get_XMax (
void)
const {
return( Get_System().Get_XMax () ); }
406 double Get_YMax (
void)
const {
return( Get_System().Get_YMax () ); }
410 double Get_Length (
int i)
const {
return( Get_System().Get_Length (i) ); }
421 void Lock_Create (
void);
422 void Lock_Destroy (
void);
424 bool is_Locked (
int x,
int y) {
return( Lock_Get(x, y) != 0 ); }
425 char Lock_Get (
int x,
int y) {
return( m_pLock && x >= 0 && x < Get_NX() && y >= 0 && y < Get_NY() ? m_pLock->asChar(x, y) : 0 ); }
429 if( m_pLock && x >= 0 && x < Get_NX() && y >= 0 && y < Get_NY() )
431 m_pLock->Set_Value(x, y, Value);
480 #define TOOL_INTERACTIVE_KEY_LEFT 0x01
481 #define TOOL_INTERACTIVE_KEY_MIDDLE 0x02
482 #define TOOL_INTERACTIVE_KEY_RIGHT 0x04
483 #define TOOL_INTERACTIVE_KEY_SHIFT 0x08
484 #define TOOL_INTERACTIVE_KEY_ALT 0x10
485 #define TOOL_INTERACTIVE_KEY_CTRL 0x20
535 int m_Keys, m_Drag_Mode;
598 bool Get_Grid_Pos (
int &x,
int &y)
const;
600 int Get_xGrid (
void)
const;
601 int Get_yGrid (
void)
const;
630 typedef CSG_Tool * (* TSG_PFNC_TLB_Create_Tool) (
int i);
645 int Get_Count (
void);
648 CSG_Tool * Create_Tool (
int i,
bool bWithGUI =
false);
650 bool Delete_Tools (
void);
664 #define SYMBOL_TLB_Initialize "TLB_Initialize"
667 #define SYMBOL_TLB_Finalize "TLB_Finalize"
670 #define SYMBOL_TLB_Get_Interface "TLB_Get_Interface"
674 #define TLB_INTERFACE_SKIP_TOOL ((CSG_Tool *)0x1)
677 #define TLB_INTERFACE_INITIALIZE CSG_Tool_Library_Interface TLB_Interface;\
679 extern "C" _SAGA_DLL_EXPORT CSG_Tool_Library_Interface * TLB_Get_Interface (void)\
681 return( &TLB_Interface );\
684 extern "C" _SAGA_DLL_EXPORT bool TLB_Initialize (const SG_Char *TLB_Path)\
686 return( TLB_Interface.Create(SAGA_VERSION, TLB_Path, Get_Info, Create_Tool) );\
690 #define TLB_INTERFACE_FINALIZE extern "C" _SAGA_DLL_EXPORT bool TLB_Finalize (void)\
696 #define TLB_INTERFACE TLB_INTERFACE_INITIALIZE TLB_INTERFACE_FINALIZE
703 #endif // #ifdef SWIG
713 #endif // #ifndef HEADER_INCLUDED__SAGA_API__tool_H
static int Get_xTo(int Direction, int x=0)
bool SG_UI_Process_Get_Okay(bool bBlink)
static int Get_yTo(int Direction, int y=0)
CSG_Grid_Collection * Get_Grid_System(size_t i) const
@ SG_UI_DATAOBJECT_UPDATE
@ PARAMETER_TYPE_Undefined
#define SAGA_API_DLL_EXPORT
static int Get_yFrom(int Direction, int y=0)
static int Get_xFrom(int Direction, int x=0)
int(* TSG_PFNC_Parameter_Changed)(CSG_Parameter *pParameter, int Flags)