From: asl Date: Mon, 16 Nov 2015 12:11:39 +0000 (+0300) Subject: refs #676: repairing of the documentation system and help X-Git-Tag: v1.5~38^2~4 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=8e1076996a0228d8b5d16bec8ee13a318d57d01b;p=modules%2Fhydro.git refs #676: repairing of the documentation system and help --- diff --git a/doc/salome/gui/HYDRO/CMakeLists.txt b/doc/salome/gui/HYDRO/CMakeLists.txt index 7e2fc082..48bf6ef9 100644 --- a/doc/salome/gui/HYDRO/CMakeLists.txt +++ b/doc/salome/gui/HYDRO/CMakeLists.txt @@ -17,7 +17,11 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -SET(docdir ${CMAKE_INSTALL_PREFIX}/share/doc/salome) -FILE(GLOB files "${CMAKE_CURRENT_SOURCE_DIR}/html/*.*") -INSTALL(FILES ${files} DESTINATION ${docdir}/gui/HYDRO) +SALOME_CONFIGURE_FILE(doxyfile.in doxyfile) + +ADD_CUSTOM_TARGET(usr_docs ${DOXYGEN_EXECUTABLE}) +INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)") +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/HYDRO DESTINATION ${SALOME_INSTALL_DOC}/gui) + +SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES HYDRO) diff --git a/doc/salome/gui/HYDRO/HYDROGUI.doxygen b/doc/salome/gui/HYDRO/HYDROGUI.doxygen deleted file mode 100644 index f07f517e..00000000 --- a/doc/salome/gui/HYDRO/HYDROGUI.doxygen +++ /dev/null @@ -1,1719 +0,0 @@ -# Doxyfile 1.7.3 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = HYDROGUI - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = 1.4 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "HYDROGUI module" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = . - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.for \ - *.vhd \ - *.vhdl - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = ./images - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. - -FILTER_SOURCE_PATTERNS = - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [0,1..20]) -# that doxygen will group on one line in the generated HTML documentation. -# Note that a value of 0 will completely suppress the enum values from -# appearing in the overview section. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = YES - -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. - -USE_MATHJAX = NO - -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition that -# overrules the definition found in the source code. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all references to function-like macros -# that are alone on a line, have an all uppercase name, and do not end with a -# semicolon, because these will confuse the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to -# install and use dot, since it yields more powerful graphs. - -CLASS_DIAGRAMS = YES - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. - -DOT_NUM_THREADS = 0 - -# By default doxygen will write a font called Helvetica to the output -# directory and reference it in all dot files that doxygen generates. -# When you want a differently looking font you can specify the font name -# using DOT_FONTNAME. You need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will generate a graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, svg, gif or svg. -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the -# \mscfile command). - -MSCFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES diff --git a/doc/salome/gui/HYDRO/bathymetry.h b/doc/salome/gui/HYDRO/bathymetry.h deleted file mode 100644 index 626b395c..00000000 --- a/doc/salome/gui/HYDRO/bathymetry.h +++ /dev/null @@ -1,37 +0,0 @@ - -/** - @file - \brief Help for the bathymetry -*/ - -/** - \page bathymetry Bathymetry - - Back to Main page. - - Bathymetry is an altitude object. It associates an altitude value to each point on the 2D plane. - - Import bathymetry input panel can be opened via:
    -
  1. The main menu HYDRO => Import bathymetry; -
  2. Context menu of BATHYMETRIES in Object browser => Import bathymetry; -
  3. CTRL + B buttons combination; -
  4. Import bathymetry toolar button.\image html import_bathymetry_toolbar_button.png "Import bathymetry toolbar button" -
- - Arguments of the input panel: - - \image html import_bathymetry_input_panel.png "Import bathymetry input panel" - -File name - field to select file to import. Supported format: .XYZ(Bathymetry files);
-Name - field to define bathymetry object name;
-Invert altitude object - if this checkbox is ON, Z-coordinates of imported bathymetry become inverted. If checkbox is OFF, file is imported without modification.
-Apply - button to create bathymetry object;
-Apply and Close - button to create bathymetry object and close input panel;
-Close - button to close input panel. - -Example:
- -\image html bathymetry_example.png "Bathymetry zone example" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/box_obstacle.h b/doc/salome/gui/HYDRO/box_obstacle.h deleted file mode 100644 index 0b192630..00000000 --- a/doc/salome/gui/HYDRO/box_obstacle.h +++ /dev/null @@ -1,44 +0,0 @@ - -/** - @file - \brief Help for the box obstacle -*/ - -/** - \page box_obstacle Box obstacle - - Back to Main page. - - - In the HYDROGUI module box obstacle is a geometrical primitive Box. - - - The obstacle can be created via:
    -
  1. The main menu HYDRO => Obstacle => Create box;
    2. -
  2. Context menu of OBSTACLES in Object browser - Create box;
    3. -
  3. Create box obstacle toolbar button
    4. -
- -\image html box_toolbar_button.png "Create box obstacle toolbar button" - - Box construction dialog box from Geometry module appears - \image html box_dialog.png "Box construction dialog box" - -User sets necesssary arguments and clicks Apply and Close button. - -Box construction dialog box is closed and a new geometrical object box appears in the Geometry module with defined by user name and dimensions. - -Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Box. - - - Import GEOM object as obstacle input panel appears. - - - - \ref import_obstacle_GEOM "Import GEOM object as obstacle" - - The box obstacle is presented as the face and 3D object. - \image html box_presentation.png "Box obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/calculation_case.h b/doc/salome/gui/HYDRO/calculation_case.h deleted file mode 100644 index b05b4ad2..00000000 --- a/doc/salome/gui/HYDRO/calculation_case.h +++ /dev/null @@ -1,13 +0,0 @@ -/** - @file - \brief Help for the calculation case -*/ - -/** - \page calculation_case Calculation case - - Back to Main page. - - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/change_layer_order.h b/doc/salome/gui/HYDRO/change_layer_order.h deleted file mode 100644 index 01642f92..00000000 --- a/doc/salome/gui/HYDRO/change_layer_order.h +++ /dev/null @@ -1,43 +0,0 @@ - -/** - @file - \brief Help for the change layer order -*/ - -/** - \page change_layer_order Change layer order - - Back to Main page. - - The HYDROGUI module allows the user to define priority of visibility 2d objects.
- This feature is executed with help of Change layer order dialog box, which can be called via according command in context menu, called in OCC viewer.
- -Change layer order dialog box looks like: - - \image html change_layer_order_dialog_box.png "Change layer order dialog box" - - Only shown objects are presented in the dialog box.
- - Controls of the dialog box:
- - Move the item(s) on top - button to move selected in the list objects on top, i.e. set for them the highest visibility priority;
- \image html move_item_on_top_button.png "Move the item(s) on top button" - Move the item(s) up - button to move selected in the list objects up, i.e. increase visibility priority on one point;
- \image html move_item_up_button.png "Move the item(s) up button" - Move the item(s) down - button to move selected in the list objects down, i.e. decrease visibility priority on one point;
- \image html move_item_down_button.png "Move the item(s) down button" - Move the item(s) on bottom - button to move selected in the list objects on bottom, i.e. set for them least visibility priority;
- \image html move_item_on_bottom_button.png "Move the item(s) on bottom button" - All objects - check-box to show all objects(even hidden) in the list;
- Apply - button to apply modifications done;
- Apply and Close - button to apply modifications done and close dialog box;
- Close - button to close dialog box. - - Example: - \image html example_change_layer_order_before.png "Before changing layer order" - - \image html example_change_layer_order_after.png "After changing layer order" - -Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/channel.h b/doc/salome/gui/HYDRO/channel.h deleted file mode 100644 index df4c9ce6..00000000 --- a/doc/salome/gui/HYDRO/channel.h +++ /dev/null @@ -1,55 +0,0 @@ - -/** - @file - \brief Help for the channel -*/ - -/** - \page art_channel Channel - - Back to Main page. - - The channel is an artificial object. - - In the HYDROGUI module channel is created using the extrusion operation of profile along the provided path (guide line). - - The channel 3d shape is shell. - - Each profile vertex is extruded into channel edge. - - Each profile edge is extruded into channel face. - - All sections of channel should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane. - - Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell. - - - The channel can be created via:
    - -
  1. The main menu HYDRO => Create channel; -
  2. Context menu of Artificial objects in Object browser - Create channel; -
  3. Create channel toolbar button -
- -\image html channel_toolbar_button.png "Channel construction toolbar button" - - Channel input panel appears. - - \image html channel_input_panel.png " Channel input panel" - - Arguments of the input panel: - -Name - field to define the channel name;
-Guide line - combo - box to select the polyline 3D defining the channel guide line;
-Profile - combo - box to select the profile object describing channel cross-section. -Apply - button to generate digue;
-Apply and Close - button to generate digue and close input panel;
-Close - button to close input panel. - - - The channel is presented as the face and 3D object. - \image html channel_presentation.png "channel example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/color.h b/doc/salome/gui/HYDRO/color.h deleted file mode 100644 index fc3e0fb3..00000000 --- a/doc/salome/gui/HYDRO/color.h +++ /dev/null @@ -1,43 +0,0 @@ - -/** - @file - \brief Help for the color object -*/ - -/** - \page color Color object(s) - - Back to Main page. - - The HYDROGUI module supports changing object's color. This operation is available for all objects except images, bathymetries and strickler tables.
- - To change color of the object, it's necessary to select it and call Color command from context menu.
- - Set color dialog box looks like: - - \image html set_color_dialog_box.png "Set color dialog box" - - Controls inside the dialog: - - Transparent - radio button to make object transparent;
- Color - radio button to color the object with selected color;
- Border - check-box to define any color for object's border;
- OK - button to apply modifications;
- Cancel - button to reject color changing.
- - To change color it's necessary to check Color radio button and double click on the colored field near it.
- - To change border color it's necessary to check Border check box and double click on the colored field near it.
- - Appearing Select color dialog box looks like: - - \image html select_color.png "Select color dialog box" - - Example: - - \image html color_example.png "Color example" - - Back to Main page. - - -*/ diff --git a/doc/salome/gui/HYDRO/copy_paste.h b/doc/salome/gui/HYDRO/copy_paste.h deleted file mode 100644 index fd572242..00000000 --- a/doc/salome/gui/HYDRO/copy_paste.h +++ /dev/null @@ -1,29 +0,0 @@ - -/** - @file - \brief Help for the copy/paste -*/ - -/** - \page copy_paste Copy/Paste object(s) - - Back to Main page. - - It is possible to copy and paste objects in HYDROGUI module. - - To copy any object it's necessary to select it and use one of the following ways:
    -
  1. The main menu Edit => Copy;
    2. -
  2. CTRL + C buttons combination;
    3. -
  3. Call context menu of object(s) and Copy command
    4. -
- - When objects have been copied, they can be pasted into the study. To paste them use one of the following ways:
    -
  1. The main menu Edit => Paste;
    2. -
  2. CTRL + V buttons combination;
    3. -
- - Paste operation creates new objects, identical to copied and adds them to according branch: polyline - in POLYLINES branch, stream - in NATURAL OBJECTS branch, etc. - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/copy_position.h b/doc/salome/gui/HYDRO/copy_position.h deleted file mode 100644 index 89d10fa8..00000000 --- a/doc/salome/gui/HYDRO/copy_position.h +++ /dev/null @@ -1,18 +0,0 @@ - -/** - @file - \brief Help for the copy_position -*/ - -/** - \page copy_position Copy position - - Back to Main page. - - It is possible to copy local coordinates of any position in OCC view.
- - For this it is necessary to put the mouse on interesting position in OCC view, call context menu and select Copy position command.
- - Local coordinates become remembered and ready for pasting. - -*/ diff --git a/doc/salome/gui/HYDRO/create_profile.h b/doc/salome/gui/HYDRO/create_profile.h deleted file mode 100644 index 77b54d41..00000000 --- a/doc/salome/gui/HYDRO/create_profile.h +++ /dev/null @@ -1,95 +0,0 @@ - -/** - @file - \brief Help for profile -*/ - -/** - \page create_profile "Create/Edit profile" - - Back to Main page. - - The profile can be created via:
    -
  1. The main menu HYDRO => Profile => Create profile; -
  2. Context menu of PROFILES in Object browser => Create profile; -
  3. Create profile toolbar button. -
- -\image html create_profile_toolbar_button.png "Create profile toolbar button" - - The profile can be edited via Context menu of existing profile in Object browser => Edit profile. - - -Create/Edit profile input panel appears. - - - \image html create_profile_input_panel.png "Create profile input panel" - - \image html profile_edit.png "Edit profile input panel" - -Arguments of the input panel: - - Name - field to define the profile name;
- Apply - button to create profile;
- Apply and Close - button to create profile and close input panel;
- Close - button to close input panel.
- - - The profile contains only one open section. Double click on section activates Edit element panel. - - \image html edit_element_panel.png "Edit element panel" - - Name - field to define the section name. This name is not saved into data model and is lost after closing input panel. Note, that figure in the end of name indicates number of points in section as shown in figure Edit profile input panel;
- Type - combo-box to define type of section: Polyline or Spline;
- OK - button to validate changes in section and close Edit element panel;
- Cancel - button to cancel changes in section and close Edit element panel.
- - Section curve is defined by a list of points through which it passes. - - 2 modes are available for work with points:
    - -
  1. Addition mode

    2. - In this mode only point’s creation is available. Can be activated by Addition mode button clicking.
    \image html addition_mode_button.png "Addition mode toolbar button" - Each time when user clicks left mouse button in the input panel built-in viewer a new point is created in a 2D space (U, Z). The point is added always between neighbor points according to coordinate U. - - \image html profile_addition_points.png "Profile built-in viewer" - -
  2. Modification mode

    3. - In this mode the user can edit points of the profile curve. Can be activated by Modification mode button clicking.
    \image html modification_mode_button.png "Modification mode toolbar button" -
      -
    • When user selects a point (or several points) in viewer, its (their) coordinates are shown in the the table of input panel. - -The user can change coordinates directly using table cell widgets;
      • - - \image html prof_modif_mode_table.png "Table with coordinates" - -
    • When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position;
      • -
    • When user selects one or several points in viewer, he can activate the “drag-n-drop” mode (holding the mouse left button) to move all selected points inside the plane U, Z;
      • -
    • The rectangular and additive (holding Ctrl button) selections should be available for points;
      • -
    • User can remove points selecting one or several points and pressing “Delete” on keyboard or calling the popup menu and clicking on operation “Delete” or clicking Remove button.
      • - \image html remove_button.png "Remove toolbar button" -
    - -
- - Other operations are available during creation/edition of profile:
    -
  • Undo

    • - Undoes last action. - \image html undo_button.png "Undo toolbar button" -
  • Redo

    • - Redoes last undoing. - \image html redo_button.png "Redo toolbar button" -
  • Clear all

    • - Can be called only if modification mode is activated from section context menu.
    - Remove all points. -
  • Set polyline

    • - Can be called only if modification mode is activated from section context menu.
    - Modifies selected section into polyline. -
  • Set spline

    • - Can be called only if modification mode is activated from section context menu.
    - Modifies selected section into spline. -
- - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/cut_images.h b/doc/salome/gui/HYDRO/cut_images.h deleted file mode 100644 index 1ea0807d..00000000 --- a/doc/salome/gui/HYDRO/cut_images.h +++ /dev/null @@ -1,34 +0,0 @@ - -/** - @file - \brief Help for the cut images -*/ - -/** - \page cutimages Cut images - - Back to Main page. - -The user can start Cut images operation via:
    -
  1. The main menu HYDRO - Cut images; -
  2. Context menu of any image in Object browser - Cut images; -
  3. Cut images toolbar button.\image html cut_images_toolbar_button.png "Cut images toolbar button" -
- Arguments of the input panel: - - \image html cut_images_input_panel.png "Cut images input panel(TO BE UPDATED)" - -Name - field for defining the name of image after cut;
-Image 1 - field for defining the image which will be cut;
-Image 2 - field for defining the image which will cut;
-Apply - button to create cut image object;
-Apply and Close - button to create cut image object and close input panel;
-Close - button to close input panel.
-It's necessary to select 2 pictures to be cut with help of Image 1 and Image 2 fields.
-
Also, it's possible to change background color of cut image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. - - \image html select_color.png "Select color dialog box" - -Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/cylinder_obstacle.h b/doc/salome/gui/HYDRO/cylinder_obstacle.h deleted file mode 100644 index 319e9673..00000000 --- a/doc/salome/gui/HYDRO/cylinder_obstacle.h +++ /dev/null @@ -1,43 +0,0 @@ - -/** - @file - \brief Help for the cylinder obstacle -*/ - -/** - \page cylinder_obstacle Cylinder obstacle - - Back to Main page. - - In the HYDROGUI module cylinder obstacle is a geometrical primitive cylinder. - - - The cylinder obstacle can be created via:
    -
  1. The main menu HYDRO => Obstacle => Create cylinder;
    2. -
  2. Context menu of OBSTACLES in Object browser - Create cylinder;
    3. -
  3. Create cylinder obstacle toolbar button
    4. -
- -\image html cylinder_toolbar_button.png "Create cylinder obstacle toolbar button" - - Cylinder construction dialog box from Geometry module appears - \image html cylinder_dialog.png "Cylinder construction dialog box" - -User sets necesssary arguments and clicks Apply and Close button. - -Cylinder construction dialog box is closed and a new geometrical object cylinder appears in the Geometry module with defined by user name and dimensions. - -Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Cylinder. - - - Import GEOM object as obstacle input panel appears. - - - - \ref import_obstacle_GEOM "Import GEOM object as obstacle" - - The cylinder obstacle is presented as the face and 3D object. - \image html cylinder_presentation.png "Cylinder obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/delete.h b/doc/salome/gui/HYDRO/delete.h deleted file mode 100644 index 2856e1d4..00000000 --- a/doc/salome/gui/HYDRO/delete.h +++ /dev/null @@ -1,29 +0,0 @@ - -/** - @file - \brief Help for the delete object(s) -*/ - -/** - \page delete Delete object(s) - - Back to Main page. - - It is possible to delete one or more objects in HYDROGUI module.
- Following ways are available for beginning this action:
    -
  1. Select object(s) and push Delete button;
    2. -
  2. Select object(s), call context menu and call Delete button;
    3. -
- - Further 2 possible ways are possible:
    -
  1. If deleting objects are not used as references for another objects, Delete objects dialog box appears:
    - - \image html delete_objects_dialog_box.png "Delete objects dialog box"
    2. -
  2. If removing objects are used as references for another objects, Delete objects warning appears:
    - - \image html delete_objects_warning.png "Delete objects warning" - In this case, firstly, it's necessary to remove objects which have been created basing on deleting objects. After that first case will be available.
    3. -
- - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/digue.h b/doc/salome/gui/HYDRO/digue.h deleted file mode 100644 index 5f641f81..00000000 --- a/doc/salome/gui/HYDRO/digue.h +++ /dev/null @@ -1,54 +0,0 @@ - -/** - @file - \brief Help for the digue -*/ - -/** - \page art_digue Digue - - Back to Main page. - - The digue is an artificial object. - - In the HYDROGUI module digue is created using the extrusion operation of profile along the provided path (guide line). - - The digue 3d shape is shell. - - Each profile vertex is extruded into digue edge. - - Each profile edge is extruded into digue face. - - All sections of digue should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane. - - Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell. - - - The digue can be created via:
    - -
  1. The main menu HYDRO => Create digue; -
  2. Context menu of Artificial objects in Object browser - Create digue; -
  3. Create digue toolbar button -
- -\image html digue_toolbar_button.png "Create digue toolbar button" - - Digue input panel appears. - - \image html digue_input_panel.png " Digue input panel" - -Arguments of the input panel: - -Name - field to define the digue name;
-Guide line - combo - box to select the polyline 3D defining the digue guide line;
-Profile - combo - box to select the profile object describing digue cross-section;
-Apply - button to generate digue;
-Apply and Close - button to generate digue and close input panel;
-Close - button to close input panel. - - The digue is presented as the face and 3D object. - \image html digue_presentation.png " Digue example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/doxyfile.in b/doc/salome/gui/HYDRO/doxyfile.in new file mode 100644 index 00000000..951ba1bf --- /dev/null +++ b/doc/salome/gui/HYDRO/doxyfile.in @@ -0,0 +1,72 @@ +# Copyright (C) 2014-2015 EDF-R&D +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "HYDROGUI" +OUTPUT_DIRECTORY = hydro +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +TAB_SIZE = 5 + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES + +#--------------------------------------------------------------------------- +#Input related options +#--------------------------------------------------------------------------- +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/input +FILE_PATTERNS = *.doc +IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images \ + +#--------------------------------------------------------------------------- +#HTML related options +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = . +HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/static/header.html +HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css +TOC_EXPAND = YES +DISABLE_INDEX = NO +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 300 + +#--------------------------------------------------------------------------- +#SORT related options +#--------------------------------------------------------------------------- +SORT_GROUP_NAMES = NO + +#--------------------------------------------------------------------------- +#LaTeX related option +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO + +#--------------------------------------------------------------------------- +#RTF related options +#--------------------------------------------------------------------------- +GENERATE_RTF = NO + +#--------------------------------------------------------------------------- +#Search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO diff --git a/doc/salome/gui/HYDRO/dump_study.h b/doc/salome/gui/HYDRO/dump_study.h deleted file mode 100644 index cc08d9f4..00000000 --- a/doc/salome/gui/HYDRO/dump_study.h +++ /dev/null @@ -1,32 +0,0 @@ - -/** - @file - \brief Help for the dump study -*/ - -/** - \page dump_study Dump study - - Back to Main page. - - The HYDROGUI module supports dumping documents into Python scripts. This operation can be called via:
    -
  1. The main menu File => Dump study;
    2. -
  2. CTRL + D buttons combination;
    3. -
- - - Dump study dialog box looks like: - - \image html dump_study_dialog_box.png "Dump study dialog box" - - Controls inside Dump study dialog box:
    -
  • Publish in study - check-box to
    • -
  • Multi file dump - check-box to
    • -
  • Save GUI state - check-box to
    • -
- - In case if the user tries to save file with the name already used, warning appears, suggested overwriting existing file : - \image html warning_dump.png "Warning" - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/export_polyline.h b/doc/salome/gui/HYDRO/export_polyline.h deleted file mode 100644 index 2917bcfb..00000000 --- a/doc/salome/gui/HYDRO/export_polyline.h +++ /dev/null @@ -1,19 +0,0 @@ - -/** - @file - \brief Help for the export polyline -*/ - -/** - \page export_polyline Export polyline - - Back to Main page. - - It is possible to export polylines from HYDROGUI module. This operation can be called from context menu of selected polylines in Object browser. - - Export polyline dialog box appears: - \image html export_polyline_dialog_box.png "Export polyline dialog box" - - Supported format - .SHP(shape files). - -*/ diff --git a/doc/salome/gui/HYDRO/export_strickler_table.h b/doc/salome/gui/HYDRO/export_strickler_table.h deleted file mode 100644 index 0f006c3d..00000000 --- a/doc/salome/gui/HYDRO/export_strickler_table.h +++ /dev/null @@ -1,28 +0,0 @@ - -/** - @file - \brief Help for the export strickler table -*/ - -/** - \page export_strickler_table Export strickler table - - Back to Main page. - - It is possible to export strickler table from HYDROGUI module. This operation is accessible from context menu of selected strickler table in Object browser.
- - Export Strickler table looks like: - \image html export_strickler_table_input_panel.png "Export strickler table input panel" - - Arguments of the input panel: - -File name - field to define file to export;
-Name - field to show name of strickler table to export;
-Apply - button to export strickler table object;
-Apply and Close - button to export strickler table object and close input panel;
-Close - button to close input panel.
- - - - -*/ diff --git a/doc/salome/gui/HYDRO/find_bottom.h b/doc/salome/gui/HYDRO/find_bottom.h deleted file mode 100644 index e34acfcc..00000000 --- a/doc/salome/gui/HYDRO/find_bottom.h +++ /dev/null @@ -1,33 +0,0 @@ - -/** - @file - \brief Help for the find bottom -*/ - -/** - \page findbottom Find bottom - - Back to Main page. - - Find bottom operation builds polyline simulating the river bottom. The bottom polyline is constructed as the spline connecting the points with the minimal altitude from each profile inside the stream. - - Find stream bottom input panel can be opened via:
    -
  1. The main menu HYDRO => Stream => Find bottom; -
  2. Context menu of Stream object in Object browser - Find bottom;
    3. -
- - Arguments of the input panel: - - \image html find_bottom_input_panel.png "Find stream bottom input panel" - -Stream object - combo-box to define reference stream object;
-Apply - button to build stream's bottom;
-Apply and Close - button to build stream's bottom and close input panel;
-Close - button to close input panel. - -Example:
- -\image html find_bottom_example.png "Find bottom example" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/fuse_images.h b/doc/salome/gui/HYDRO/fuse_images.h deleted file mode 100644 index 9b6a6342..00000000 --- a/doc/salome/gui/HYDRO/fuse_images.h +++ /dev/null @@ -1,45 +0,0 @@ - -/** - @file - \brief Help for the fuse images -*/ - -/* -div.inline-image, -div.inline-image > div { - display:inline; -} -*/ - -/** - \page fuseimages Fuse images - - Back to Main page. - -The user can start Fuse images operation via:
    -
  1. The main menu HYDRO - Fuse images;
    2. -
  2. Context menu of any image in Object browser - Fuse images;
    3. -
  3. Fuse images toolbar button. \image html fuse_images_toolbar_button.png "Fuse images toolbar button" -
- - - - - Arguments of the input panel: - - \image html fuse_images_input_panel.png "Fuse images input panel" - -Name - field for defining the name of image after fusing;
-Image 1 - field for defining the first fusing image;
-Image 2 - field for defining the second fusing image;
-Apply - button to create fused image object;
-Apply and Close - button to create fused image object and close input panel;
-Close - button to close input panel.
- -
Also, it's possible to change background color of fused image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. - - \image html select_color.png "Select color dialog box" - -Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/general_services.h b/doc/salome/gui/HYDRO/general_services.h deleted file mode 100644 index 6b1b7318..00000000 --- a/doc/salome/gui/HYDRO/general_services.h +++ /dev/null @@ -1,29 +0,0 @@ - -/** - @file - \brief Help for the general services -*/ - -/** - \page general_services General services - - The HYRDOGUI module supports following services: - - \ref save "Save file" - - \ref open "Open file" - - \ref dump_study "Dump study" - - \ref load_script "Load script" - - \ref undo_redo "Undo/Redo actions" - - \ref copy_paste "Copy/Paste object(s)" - - \ref delete "Delete object(s)" - - \ref color "Color object" - - \ref show_hide "Show/Hide object(s)" - - \ref update "Update object" - - \ref rename "Rename object" - - \ref submersible "Submersible" - - \ref copy_position "Copy position" - - \ref change_layer_order "Change layer order" - - Back to Main page. - - -*/ diff --git a/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat b/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat deleted file mode 100644 index 7cbbb4c1..00000000 --- a/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat +++ /dev/null @@ -1,3 +0,0 @@ - -echo Generating documentation... -doxygen.exe HYDROGUI.doxygen 2> documentation.log diff --git a/doc/salome/gui/HYDRO/georeferencement_profile.h b/doc/salome/gui/HYDRO/georeferencement_profile.h deleted file mode 100644 index faad63f2..00000000 --- a/doc/salome/gui/HYDRO/georeferencement_profile.h +++ /dev/null @@ -1,41 +0,0 @@ - -/** - @file - \brief Help for the georeferencement profile -*/ - -/** - \page georeferencement_profile Georeferencement of profiles - - Back to Main page. - - Georeferencement of profiles in HYDROGUI module is accessible via:
    -
  • The main menu HYDRO => Profile => Georeferencement;
    • -
  • Context menu of PROFILES in Object browser - Georeferencement;
    • -
  • Context menu of selected profiles in Object browser - Georeferencement;
    • -
  • Profile(s)georeferencement toolar button.
    • - -\image html georeferencement_toolbar_button.png "Profile(s) georeferencement toolbar button" -
- - Georeferencement profile input panel appears. The table widget shows either all profiles existing in document or selected profiles depending on the radio button activated: - - \image html profiles_georeferencement_all.png "Profiles georeferencement input panel- All profiles" - \image html profiles_georeferencement_selected.png "Profiles georeferencement input panel- Selected profiles" - -If the user starts the operation via main menu, context menu of PROFILES or toolar button then the radio button All is activated automatically; if via context menu of selected profiles - Selected radio button. - -The user can input/change the coordinates of G, D profile points directly in the table using cell widgets or selecting a cell in the table and clicking in viewer. - -Apply - button to validate changes;
-Apply and Close - button to validate changes and close input panel;
-Close - button to close input panel. - - -2D profiles that were georeferenced become 3D profiles and their names color is changed from red to black. - -\image html georeferencemented_profiles.png "Profiles in Object browser before and after georeferencement" - - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/image.h b/doc/salome/gui/HYDRO/image.h deleted file mode 100644 index eb9e0664..00000000 --- a/doc/salome/gui/HYDRO/image.h +++ /dev/null @@ -1,20 +0,0 @@ -/** - @file - \brief Help for the image -*/ - -/** - \page image Image - - Back to Main page. - -Image is a picture area, the user is interested in. Images can be used to better visualize the study zone, the positioning of the geometries - polylines, bathymetries, etc.
- The HYDROGUI module supports the following operations with images: - - - \ref impimage "Import image" - - \ref fuseimages "Fuse images" - - \ref cutimages "Cut images" - - \ref splitimage "Split image" - - -*/ diff --git a/doc/salome/gui/HYDRO/immersible_zone.h b/doc/salome/gui/HYDRO/immersible_zone.h deleted file mode 100644 index c0a1ff7a..00000000 --- a/doc/salome/gui/HYDRO/immersible_zone.h +++ /dev/null @@ -1,36 +0,0 @@ - -/** - @file - \brief Help for the immersible zone -*/ - -/** - \page imzone Immersible zone - - Back to Main page. - - The immersible zone is a natural object describing the area that is (or may be) under the water. - - Create immersible zone input panel can be opened via:
    -
  1. The main menu HYDRO => Create immersible zone; -
  2. Context menu of NATURAL OBJECTS in Object browser => Create immersible zone; -
  3. Create immersible zone toolar button.\image html create_immersible_zone_toolbar_button.png "Create immersible zone toolbar button" -
- - Arguments of the input panel: - - \image html create_immersible_zone_input_panel.png "Create immersible zone input panel" - -Name - field to define the immersible zone name;
-Polyline - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.
-Bathymetry - combo - box to select the bathymetry object describing immersible zone's profile;
-Apply - button to generate immersible zone;
-Apply and Close - button to generate immersible zone and close input panel;
-Close - button to close input panel. - -Example:
- -\image html immersible_zone_example.png "Immersible zone example" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/import_image.h b/doc/salome/gui/HYDRO/import_image.h deleted file mode 100644 index 553c26b3..00000000 --- a/doc/salome/gui/HYDRO/import_image.h +++ /dev/null @@ -1,54 +0,0 @@ - -/** - @file - \brief Help for the import image -*/ - -/** - \page impimage Import image - - Back to Main page. - - Import image input panel can be opened via:
    -
  1. The main menu HYDRO => Import image; -
  2. Context menu of IMAGES in Object browser => Import image; -
  3. CTRL + I buttons combination; -
  4. Import image toolar button. \image html import_image_toolbar_button.png "Import image toolbar button" -
- - Arguments of the input panel: - - \image html impot_image_dialog.png "Import image input panel" - -File name - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif.
-Name - field for defining the name of image after import. By default - the name of the file;
-Apply - button to create image object;
-Apply and Close - button to create image object and close input panel;
-Close - button to close input panel.
- Another fields become enabled: - - \image html import_image_enabled.png "Enabled Import image input panel" - - By default, two points should be used for the image positioning. The corresponding transformation should be built using the rules: only panning, rotation and scaling are allowed; the scaling is same along X, Y; all angles are kept.
- An additional check box allows the user to activate usage of the 3-rd point (unchecked by default). When user activates it he can select the 3-rd point exactly as previous two and in this case the complete affine transformation is applied (note that angles can be not kept and scaling along X, Y may be different in this case).
- - Coordinates of points can be defined via:
    - -
  1. Manually input Geographic coordinates -
    It's necessary to to input latitude and longitude of points. - \image html geographic_coordinates.png "Geographic coordinates" - -
  2. Manually input Plane coordinates(Lambert93) -
    It's necessary to input lambert coordinates of points. - \image html lambert_coordinates.png "Lambert coordinates" - -
  3. Get Plane coordinates (Lambert93) from file -
    It's necessary to load file with lambert coordinates. Supported format - .GRF (image georeferencement file) - -
  4. Choose points on reference image -
    It's necessary to choose reference image from combo box - \image html reference_image.png "Combo-box for defining reference image" -
- -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/import_obstacle.h b/doc/salome/gui/HYDRO/import_obstacle.h deleted file mode 100644 index 98f499b7..00000000 --- a/doc/salome/gui/HYDRO/import_obstacle.h +++ /dev/null @@ -1,71 +0,0 @@ - -/** - @file - \brief Help for Import obstacle from file operation -*/ - -/** - \page import_obstacle Import obstacle from file - - - Back to Main page. - - An obstacle can be imported into the HYDROGUI module from external file. - - - The Import obstacle operation can be started via:
    - -
  1. The main menu HYDRO => Obstacle => Import obstacle ; -
  2. Context menu of OBSTACLES in Object browser - Import obstacle; -
  3. Import obstacle from file toolbar button -
- -\image html import_obstacle_toolbar_button.png "Import obstacle from file toolbar button" - - - Import obstacle input panel appears. - - - \image html import_obstacle_create_input_panel.png " Import obstacle input panel - Create mode" - - \image html import_obstacle_input_panel.png " Import obstacle input panel - Modify mode" - -Arguments of the input panel: - -File name - field for defining file to import. - - -The user clicks Open File button. - - -\image html open_file_icon.png "Open File button" - - -Open File dialog box appears. - - -\image html open_file_dialog.png "Open File dialog" - - -The user selects type of file to be imported. Supported formats are BREP, IGES, STEP. - - -The user selects folder in Look in filed and desired file in this folder. - -The user clicks Open button. - -Open File dialog box is closed. Selected file appears in File name. - - -Name - field to define the obstacle name. By default name is the same as file name without extension;
-Mode - allows to generate a new obstacle (radio-button Create new) or replace existing obstacle (radio-button Modify) ;
-Apply - button to import obstacle;
-Apply and Close - button to import obstacle and close input panel;
-Close - button to close input panel. - - The obstacle is presented as the face and 3D object. - \image html obstacle_presentation.png "Obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/import_obstacle_GEOM.h b/doc/salome/gui/HYDRO/import_obstacle_GEOM.h deleted file mode 100644 index bf6ae770..00000000 --- a/doc/salome/gui/HYDRO/import_obstacle_GEOM.h +++ /dev/null @@ -1,43 +0,0 @@ - -/** - @file - \brief Help for Import GEOM object as obstacle operation -*/ - -/** - \page import_obstacle_GEOM Import GEOM object as obstacle - - Back to Main page. - - A geometrical object can be imported into the HYDROGUI module as an obstacle. - - - The Import GEOM object as obstacle operation can be started via Context menu of GEOM object in Object browser - Import as obstacle. - - The user can select one/several objects in GEOM, in this case for each selected object the corresponding instance of HYDRO obstacle will be created. - - - Import GEOM object as obstacle input panel appears. - -The same input panel appears after creation of new geometrical primitives as results of Create box and Create cylinder operations. - -Import GEOM object as obstacle input panel appears. - - \image html box_input_panel_create.png " Import GEOM object as obstacle input panel - Create mode" - - \image html box_input_panel.png " Import GEOM object as obstacle input panel - Modify mode" - -Arguments of the input panel: - -Name - field to define the obstacle name. By default name is the same as name of corresponding GEOM object;
-Mode - allows to generate a new obstacle (radio-button Create new) or replace existing obstacle (radio-button Modify) ;
-Apply - button to generate obstacle;
-Apply and Close - button to generate obstacle and close input panel;
-Close - button to close input panel. - - The obstacle is presented as the face and 3D object. - \image html box_presentation.png "Box obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/import_polyline.h b/doc/salome/gui/HYDRO/import_polyline.h deleted file mode 100644 index 0737324f..00000000 --- a/doc/salome/gui/HYDRO/import_polyline.h +++ /dev/null @@ -1,21 +0,0 @@ - -/** - @file - \brief Help for the import polyline -*/ - -/** - \page import_polyline Import polyline - - Back to Main page. - - It is possible to import polylines in HYDROGUI module. This operation is accessible via:
    -
  • The main menu HYDRO => Import polyline;
    • -
  • Import polyline toolar button. \image html import_polyline_toolbar_button.png "Import polyline toolbar button"
    • -
- - Import polyline dialog box appears: - \image html import_polyline_dialog_box.png "Import polyline dialog box" - -Supported formats - .SX(sinusX files) and .SHP(shape files). -*/ diff --git a/doc/salome/gui/HYDRO/import_profile.h b/doc/salome/gui/HYDRO/import_profile.h deleted file mode 100644 index 5377ea47..00000000 --- a/doc/salome/gui/HYDRO/import_profile.h +++ /dev/null @@ -1,41 +0,0 @@ - -/** - @file - \brief Help for the import profile -*/ - -/** - \page import_profile Import profile - - Back to Main page. - - Import profiles in HYDROGUI module from external file is accessible via:
    -
  • The main menu HYDRO => Profile => Import profiles;
    • -
  • Context menu of PROFILES in Object browser - Import profiles;
    • -
  • Import profiles from file(s) toolar button.
    • - -\image html import_profile_toolbar_button.png "Import profiles from file(s) toolbar button" -
- - Import profile dialog box appears: - \image html import_profile_dialog_box.png "Import profile dialog box" - - -The user selects folder in Look in filed and one or several desired file in this folder. - -The user clicks Open button. - -Open File dialog box is closed. Selected profile(s) appear(s) in Object browser. 2D profiles names are colored in red, 3D profile names with georteferncement are colored in black. - -\image html imported_profiles.png "Imported profiles in Object browser" - -The profile file format is text where each line corresponds to one point in the profile. - -Depending on number of values in line two use cases can be distinguished:
    - -
  • 2D case - each line contains 2 double values (parametric case). Note, that the X values should increase so if the current value is less than previous it can be interpreted as start of new profile.
    • -
  • 3D case - each line contains 3 double values. First and last points are interpreted as points of georeferencement: first point is G (left bank), last point is D (right bank). The intermediate points should be recalculated to parametric presentation according to rule: the profile is straight segment on plan, and for each point U is equal to distance from the current point to the first point and Z is taken as is from the file.
    • -
- - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/import_strickler_table.h b/doc/salome/gui/HYDRO/import_strickler_table.h deleted file mode 100644 index 809f941e..00000000 --- a/doc/salome/gui/HYDRO/import_strickler_table.h +++ /dev/null @@ -1,27 +0,0 @@ - -/** - @file - \brief Help for the import strickler table -*/ - -/** - \page import_strickler_table Import strickler table - - Back to Main page. - - It is possible to import strickler table in HYDROGUI module. This operation is accessible via:
    -
  • The main menu HYDRO => Import strickler table;
    • -
  • Context menu of STRICKLER TABLES in Object browser => Import strickler table;
    • -
  • Import strickler table toolar button. \image html import_strickler_table_toolbar_button.png "Import strickler table toolbar button"
    • -
- - Import strickler table input panel looks like: - \image html import_strickler_table_input_panel.png "Import strickler table input panel" - Arguments of the input panel: - -File name - field to define file to import;
-Name - field to define the name of strickler table object after import. By default - the name of the file;
-Apply - button to create strickler table object;
-Apply and Close - button to create strickler table object and close input panel;
-Close - button to close input panel.
-*/ diff --git a/doc/salome/gui/HYDRO/input/bathymetry.doc b/doc/salome/gui/HYDRO/input/bathymetry.doc new file mode 100644 index 00000000..626b395c --- /dev/null +++ b/doc/salome/gui/HYDRO/input/bathymetry.doc @@ -0,0 +1,37 @@ + +/** + @file + \brief Help for the bathymetry +*/ + +/** + \page bathymetry Bathymetry + + Back to Main page. + + Bathymetry is an altitude object. It associates an altitude value to each point on the 2D plane. + + Import bathymetry input panel can be opened via:
    +
  1. The main menu HYDRO => Import bathymetry; +
  2. Context menu of BATHYMETRIES in Object browser => Import bathymetry; +
  3. CTRL + B buttons combination; +
  4. Import bathymetry toolar button.\image html import_bathymetry_toolbar_button.png "Import bathymetry toolbar button" +
+ + Arguments of the input panel: + + \image html import_bathymetry_input_panel.png "Import bathymetry input panel" + +File name - field to select file to import. Supported format: .XYZ(Bathymetry files);
+Name - field to define bathymetry object name;
+Invert altitude object - if this checkbox is ON, Z-coordinates of imported bathymetry become inverted. If checkbox is OFF, file is imported without modification.
+Apply - button to create bathymetry object;
+Apply and Close - button to create bathymetry object and close input panel;
+Close - button to close input panel. + +Example:
+ +\image html bathymetry_example.png "Bathymetry zone example" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/box_obstacle.doc b/doc/salome/gui/HYDRO/input/box_obstacle.doc new file mode 100644 index 00000000..0b192630 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/box_obstacle.doc @@ -0,0 +1,44 @@ + +/** + @file + \brief Help for the box obstacle +*/ + +/** + \page box_obstacle Box obstacle + + Back to Main page. + + + In the HYDROGUI module box obstacle is a geometrical primitive Box. + + + The obstacle can be created via:
    +
  1. The main menu HYDRO => Obstacle => Create box;
    2. +
  2. Context menu of OBSTACLES in Object browser - Create box;
    3. +
  3. Create box obstacle toolbar button
    4. +
+ +\image html box_toolbar_button.png "Create box obstacle toolbar button" + + Box construction dialog box from Geometry module appears + \image html box_dialog.png "Box construction dialog box" + +User sets necesssary arguments and clicks Apply and Close button. + +Box construction dialog box is closed and a new geometrical object box appears in the Geometry module with defined by user name and dimensions. + +Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Box. + + + Import GEOM object as obstacle input panel appears. + + + - \ref import_obstacle_GEOM "Import GEOM object as obstacle" + + The box obstacle is presented as the face and 3D object. + \image html box_presentation.png "Box obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/calculation_case.doc b/doc/salome/gui/HYDRO/input/calculation_case.doc new file mode 100644 index 00000000..b05b4ad2 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/calculation_case.doc @@ -0,0 +1,13 @@ +/** + @file + \brief Help for the calculation case +*/ + +/** + \page calculation_case Calculation case + + Back to Main page. + + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/change_layer_order.doc b/doc/salome/gui/HYDRO/input/change_layer_order.doc new file mode 100644 index 00000000..01642f92 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/change_layer_order.doc @@ -0,0 +1,43 @@ + +/** + @file + \brief Help for the change layer order +*/ + +/** + \page change_layer_order Change layer order + + Back to Main page. + + The HYDROGUI module allows the user to define priority of visibility 2d objects.
+ This feature is executed with help of Change layer order dialog box, which can be called via according command in context menu, called in OCC viewer.
+ +Change layer order dialog box looks like: + + \image html change_layer_order_dialog_box.png "Change layer order dialog box" + + Only shown objects are presented in the dialog box.
+ + Controls of the dialog box:
+ + Move the item(s) on top - button to move selected in the list objects on top, i.e. set for them the highest visibility priority;
+ \image html move_item_on_top_button.png "Move the item(s) on top button" + Move the item(s) up - button to move selected in the list objects up, i.e. increase visibility priority on one point;
+ \image html move_item_up_button.png "Move the item(s) up button" + Move the item(s) down - button to move selected in the list objects down, i.e. decrease visibility priority on one point;
+ \image html move_item_down_button.png "Move the item(s) down button" + Move the item(s) on bottom - button to move selected in the list objects on bottom, i.e. set for them least visibility priority;
+ \image html move_item_on_bottom_button.png "Move the item(s) on bottom button" + All objects - check-box to show all objects(even hidden) in the list;
+ Apply - button to apply modifications done;
+ Apply and Close - button to apply modifications done and close dialog box;
+ Close - button to close dialog box. + + Example: + \image html example_change_layer_order_before.png "Before changing layer order" + + \image html example_change_layer_order_after.png "After changing layer order" + +Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/channel.doc b/doc/salome/gui/HYDRO/input/channel.doc new file mode 100644 index 00000000..df4c9ce6 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/channel.doc @@ -0,0 +1,55 @@ + +/** + @file + \brief Help for the channel +*/ + +/** + \page art_channel Channel + + Back to Main page. + + The channel is an artificial object. + + In the HYDROGUI module channel is created using the extrusion operation of profile along the provided path (guide line). + + The channel 3d shape is shell. + + Each profile vertex is extruded into channel edge. + + Each profile edge is extruded into channel face. + + All sections of channel should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane. + + Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell. + + + The channel can be created via:
    + +
  1. The main menu HYDRO => Create channel; +
  2. Context menu of Artificial objects in Object browser - Create channel; +
  3. Create channel toolbar button +
+ +\image html channel_toolbar_button.png "Channel construction toolbar button" + + Channel input panel appears. + + \image html channel_input_panel.png " Channel input panel" + + Arguments of the input panel: + +Name - field to define the channel name;
+Guide line - combo - box to select the polyline 3D defining the channel guide line;
+Profile - combo - box to select the profile object describing channel cross-section. +Apply - button to generate digue;
+Apply and Close - button to generate digue and close input panel;
+Close - button to close input panel. + + + The channel is presented as the face and 3D object. + \image html channel_presentation.png "channel example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/color.doc b/doc/salome/gui/HYDRO/input/color.doc new file mode 100644 index 00000000..fc3e0fb3 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/color.doc @@ -0,0 +1,43 @@ + +/** + @file + \brief Help for the color object +*/ + +/** + \page color Color object(s) + + Back to Main page. + + The HYDROGUI module supports changing object's color. This operation is available for all objects except images, bathymetries and strickler tables.
+ + To change color of the object, it's necessary to select it and call Color command from context menu.
+ + Set color dialog box looks like: + + \image html set_color_dialog_box.png "Set color dialog box" + + Controls inside the dialog: + + Transparent - radio button to make object transparent;
+ Color - radio button to color the object with selected color;
+ Border - check-box to define any color for object's border;
+ OK - button to apply modifications;
+ Cancel - button to reject color changing.
+ + To change color it's necessary to check Color radio button and double click on the colored field near it.
+ + To change border color it's necessary to check Border check box and double click on the colored field near it.
+ + Appearing Select color dialog box looks like: + + \image html select_color.png "Select color dialog box" + + Example: + + \image html color_example.png "Color example" + + Back to Main page. + + +*/ diff --git a/doc/salome/gui/HYDRO/input/copy_paste.doc b/doc/salome/gui/HYDRO/input/copy_paste.doc new file mode 100644 index 00000000..fd572242 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/copy_paste.doc @@ -0,0 +1,29 @@ + +/** + @file + \brief Help for the copy/paste +*/ + +/** + \page copy_paste Copy/Paste object(s) + + Back to Main page. + + It is possible to copy and paste objects in HYDROGUI module. + + To copy any object it's necessary to select it and use one of the following ways:
    +
  1. The main menu Edit => Copy;
    2. +
  2. CTRL + C buttons combination;
    3. +
  3. Call context menu of object(s) and Copy command
    4. +
+ + When objects have been copied, they can be pasted into the study. To paste them use one of the following ways:
    +
  1. The main menu Edit => Paste;
    2. +
  2. CTRL + V buttons combination;
    3. +
+ + Paste operation creates new objects, identical to copied and adds them to according branch: polyline - in POLYLINES branch, stream - in NATURAL OBJECTS branch, etc. + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/copy_position.doc b/doc/salome/gui/HYDRO/input/copy_position.doc new file mode 100644 index 00000000..89d10fa8 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/copy_position.doc @@ -0,0 +1,18 @@ + +/** + @file + \brief Help for the copy_position +*/ + +/** + \page copy_position Copy position + + Back to Main page. + + It is possible to copy local coordinates of any position in OCC view.
+ + For this it is necessary to put the mouse on interesting position in OCC view, call context menu and select Copy position command.
+ + Local coordinates become remembered and ready for pasting. + +*/ diff --git a/doc/salome/gui/HYDRO/input/create_profile.doc b/doc/salome/gui/HYDRO/input/create_profile.doc new file mode 100644 index 00000000..77b54d41 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/create_profile.doc @@ -0,0 +1,95 @@ + +/** + @file + \brief Help for profile +*/ + +/** + \page create_profile "Create/Edit profile" + + Back to Main page. + + The profile can be created via:
    +
  1. The main menu HYDRO => Profile => Create profile; +
  2. Context menu of PROFILES in Object browser => Create profile; +
  3. Create profile toolbar button. +
+ +\image html create_profile_toolbar_button.png "Create profile toolbar button" + + The profile can be edited via Context menu of existing profile in Object browser => Edit profile. + + +Create/Edit profile input panel appears. + + + \image html create_profile_input_panel.png "Create profile input panel" + + \image html profile_edit.png "Edit profile input panel" + +Arguments of the input panel: + + Name - field to define the profile name;
+ Apply - button to create profile;
+ Apply and Close - button to create profile and close input panel;
+ Close - button to close input panel.
+ + + The profile contains only one open section. Double click on section activates Edit element panel. + + \image html edit_element_panel.png "Edit element panel" + + Name - field to define the section name. This name is not saved into data model and is lost after closing input panel. Note, that figure in the end of name indicates number of points in section as shown in figure Edit profile input panel;
+ Type - combo-box to define type of section: Polyline or Spline;
+ OK - button to validate changes in section and close Edit element panel;
+ Cancel - button to cancel changes in section and close Edit element panel.
+ + Section curve is defined by a list of points through which it passes. + + 2 modes are available for work with points:
    + +
  1. Addition mode

    2. + In this mode only point’s creation is available. Can be activated by Addition mode button clicking.
    \image html addition_mode_button.png "Addition mode toolbar button" + Each time when user clicks left mouse button in the input panel built-in viewer a new point is created in a 2D space (U, Z). The point is added always between neighbor points according to coordinate U. + + \image html profile_addition_points.png "Profile built-in viewer" + +
  2. Modification mode

    3. + In this mode the user can edit points of the profile curve. Can be activated by Modification mode button clicking.
    \image html modification_mode_button.png "Modification mode toolbar button" +
      +
    • When user selects a point (or several points) in viewer, its (their) coordinates are shown in the the table of input panel. + +The user can change coordinates directly using table cell widgets;
      • + + \image html prof_modif_mode_table.png "Table with coordinates" + +
    • When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position;
      • +
    • When user selects one or several points in viewer, he can activate the “drag-n-drop” mode (holding the mouse left button) to move all selected points inside the plane U, Z;
      • +
    • The rectangular and additive (holding Ctrl button) selections should be available for points;
      • +
    • User can remove points selecting one or several points and pressing “Delete” on keyboard or calling the popup menu and clicking on operation “Delete” or clicking Remove button.
      • + \image html remove_button.png "Remove toolbar button" +
    + +
+ + Other operations are available during creation/edition of profile:
    +
  • Undo

    • + Undoes last action. + \image html undo_button.png "Undo toolbar button" +
  • Redo

    • + Redoes last undoing. + \image html redo_button.png "Redo toolbar button" +
  • Clear all

    • + Can be called only if modification mode is activated from section context menu.
    + Remove all points. +
  • Set polyline

    • + Can be called only if modification mode is activated from section context menu.
    + Modifies selected section into polyline. +
  • Set spline

    • + Can be called only if modification mode is activated from section context menu.
    + Modifies selected section into spline. +
+ + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/cut_images.doc b/doc/salome/gui/HYDRO/input/cut_images.doc new file mode 100644 index 00000000..1ea0807d --- /dev/null +++ b/doc/salome/gui/HYDRO/input/cut_images.doc @@ -0,0 +1,34 @@ + +/** + @file + \brief Help for the cut images +*/ + +/** + \page cutimages Cut images + + Back to Main page. + +The user can start Cut images operation via:
    +
  1. The main menu HYDRO - Cut images; +
  2. Context menu of any image in Object browser - Cut images; +
  3. Cut images toolbar button.\image html cut_images_toolbar_button.png "Cut images toolbar button" +
+ Arguments of the input panel: + + \image html cut_images_input_panel.png "Cut images input panel(TO BE UPDATED)" + +Name - field for defining the name of image after cut;
+Image 1 - field for defining the image which will be cut;
+Image 2 - field for defining the image which will cut;
+Apply - button to create cut image object;
+Apply and Close - button to create cut image object and close input panel;
+Close - button to close input panel.
+It's necessary to select 2 pictures to be cut with help of Image 1 and Image 2 fields.
+
Also, it's possible to change background color of cut image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. + + \image html select_color.png "Select color dialog box" + +Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/cylinder_obstacle.doc b/doc/salome/gui/HYDRO/input/cylinder_obstacle.doc new file mode 100644 index 00000000..319e9673 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/cylinder_obstacle.doc @@ -0,0 +1,43 @@ + +/** + @file + \brief Help for the cylinder obstacle +*/ + +/** + \page cylinder_obstacle Cylinder obstacle + + Back to Main page. + + In the HYDROGUI module cylinder obstacle is a geometrical primitive cylinder. + + + The cylinder obstacle can be created via:
    +
  1. The main menu HYDRO => Obstacle => Create cylinder;
    2. +
  2. Context menu of OBSTACLES in Object browser - Create cylinder;
    3. +
  3. Create cylinder obstacle toolbar button
    4. +
+ +\image html cylinder_toolbar_button.png "Create cylinder obstacle toolbar button" + + Cylinder construction dialog box from Geometry module appears + \image html cylinder_dialog.png "Cylinder construction dialog box" + +User sets necesssary arguments and clicks Apply and Close button. + +Cylinder construction dialog box is closed and a new geometrical object cylinder appears in the Geometry module with defined by user name and dimensions. + +Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Cylinder. + + + Import GEOM object as obstacle input panel appears. + + + - \ref import_obstacle_GEOM "Import GEOM object as obstacle" + + The cylinder obstacle is presented as the face and 3D object. + \image html cylinder_presentation.png "Cylinder obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/delete.doc b/doc/salome/gui/HYDRO/input/delete.doc new file mode 100644 index 00000000..2856e1d4 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/delete.doc @@ -0,0 +1,29 @@ + +/** + @file + \brief Help for the delete object(s) +*/ + +/** + \page delete Delete object(s) + + Back to Main page. + + It is possible to delete one or more objects in HYDROGUI module.
+ Following ways are available for beginning this action:
    +
  1. Select object(s) and push Delete button;
    2. +
  2. Select object(s), call context menu and call Delete button;
    3. +
+ + Further 2 possible ways are possible:
    +
  1. If deleting objects are not used as references for another objects, Delete objects dialog box appears:
    + + \image html delete_objects_dialog_box.png "Delete objects dialog box"
    2. +
  2. If removing objects are used as references for another objects, Delete objects warning appears:
    + + \image html delete_objects_warning.png "Delete objects warning" + In this case, firstly, it's necessary to remove objects which have been created basing on deleting objects. After that first case will be available.
    3. +
+ + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/digue.doc b/doc/salome/gui/HYDRO/input/digue.doc new file mode 100644 index 00000000..5f641f81 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/digue.doc @@ -0,0 +1,54 @@ + +/** + @file + \brief Help for the digue +*/ + +/** + \page art_digue Digue + + Back to Main page. + + The digue is an artificial object. + + In the HYDROGUI module digue is created using the extrusion operation of profile along the provided path (guide line). + + The digue 3d shape is shell. + + Each profile vertex is extruded into digue edge. + + Each profile edge is extruded into digue face. + + All sections of digue should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane. + + Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell. + + + The digue can be created via:
    + +
  1. The main menu HYDRO => Create digue; +
  2. Context menu of Artificial objects in Object browser - Create digue; +
  3. Create digue toolbar button +
+ +\image html digue_toolbar_button.png "Create digue toolbar button" + + Digue input panel appears. + + \image html digue_input_panel.png " Digue input panel" + +Arguments of the input panel: + +Name - field to define the digue name;
+Guide line - combo - box to select the polyline 3D defining the digue guide line;
+Profile - combo - box to select the profile object describing digue cross-section;
+Apply - button to generate digue;
+Apply and Close - button to generate digue and close input panel;
+Close - button to close input panel. + + The digue is presented as the face and 3D object. + \image html digue_presentation.png " Digue example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/dump_study.doc b/doc/salome/gui/HYDRO/input/dump_study.doc new file mode 100644 index 00000000..cc08d9f4 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/dump_study.doc @@ -0,0 +1,32 @@ + +/** + @file + \brief Help for the dump study +*/ + +/** + \page dump_study Dump study + + Back to Main page. + + The HYDROGUI module supports dumping documents into Python scripts. This operation can be called via:
    +
  1. The main menu File => Dump study;
    2. +
  2. CTRL + D buttons combination;
    3. +
+ + + Dump study dialog box looks like: + + \image html dump_study_dialog_box.png "Dump study dialog box" + + Controls inside Dump study dialog box:
    +
  • Publish in study - check-box to
    • +
  • Multi file dump - check-box to
    • +
  • Save GUI state - check-box to
    • +
+ + In case if the user tries to save file with the name already used, warning appears, suggested overwriting existing file : + \image html warning_dump.png "Warning" + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/export_polyline.doc b/doc/salome/gui/HYDRO/input/export_polyline.doc new file mode 100644 index 00000000..2917bcfb --- /dev/null +++ b/doc/salome/gui/HYDRO/input/export_polyline.doc @@ -0,0 +1,19 @@ + +/** + @file + \brief Help for the export polyline +*/ + +/** + \page export_polyline Export polyline + + Back to Main page. + + It is possible to export polylines from HYDROGUI module. This operation can be called from context menu of selected polylines in Object browser. + + Export polyline dialog box appears: + \image html export_polyline_dialog_box.png "Export polyline dialog box" + + Supported format - .SHP(shape files). + +*/ diff --git a/doc/salome/gui/HYDRO/input/export_strickler_table.doc b/doc/salome/gui/HYDRO/input/export_strickler_table.doc new file mode 100644 index 00000000..0f006c3d --- /dev/null +++ b/doc/salome/gui/HYDRO/input/export_strickler_table.doc @@ -0,0 +1,28 @@ + +/** + @file + \brief Help for the export strickler table +*/ + +/** + \page export_strickler_table Export strickler table + + Back to Main page. + + It is possible to export strickler table from HYDROGUI module. This operation is accessible from context menu of selected strickler table in Object browser.
+ + Export Strickler table looks like: + \image html export_strickler_table_input_panel.png "Export strickler table input panel" + + Arguments of the input panel: + +File name - field to define file to export;
+Name - field to show name of strickler table to export;
+Apply - button to export strickler table object;
+Apply and Close - button to export strickler table object and close input panel;
+Close - button to close input panel.
+ + + + +*/ diff --git a/doc/salome/gui/HYDRO/input/find_bottom.doc b/doc/salome/gui/HYDRO/input/find_bottom.doc new file mode 100644 index 00000000..e34acfcc --- /dev/null +++ b/doc/salome/gui/HYDRO/input/find_bottom.doc @@ -0,0 +1,33 @@ + +/** + @file + \brief Help for the find bottom +*/ + +/** + \page findbottom Find bottom + + Back to Main page. + + Find bottom operation builds polyline simulating the river bottom. The bottom polyline is constructed as the spline connecting the points with the minimal altitude from each profile inside the stream. + + Find stream bottom input panel can be opened via:
    +
  1. The main menu HYDRO => Stream => Find bottom; +
  2. Context menu of Stream object in Object browser - Find bottom;
    3. +
+ + Arguments of the input panel: + + \image html find_bottom_input_panel.png "Find stream bottom input panel" + +Stream object - combo-box to define reference stream object;
+Apply - button to build stream's bottom;
+Apply and Close - button to build stream's bottom and close input panel;
+Close - button to close input panel. + +Example:
+ +\image html find_bottom_example.png "Find bottom example" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/fuse_images.doc b/doc/salome/gui/HYDRO/input/fuse_images.doc new file mode 100644 index 00000000..9b6a6342 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/fuse_images.doc @@ -0,0 +1,45 @@ + +/** + @file + \brief Help for the fuse images +*/ + +/* +div.inline-image, +div.inline-image > div { + display:inline; +} +*/ + +/** + \page fuseimages Fuse images + + Back to Main page. + +The user can start Fuse images operation via:
    +
  1. The main menu HYDRO - Fuse images;
    2. +
  2. Context menu of any image in Object browser - Fuse images;
    3. +
  3. Fuse images toolbar button. \image html fuse_images_toolbar_button.png "Fuse images toolbar button" +
+ + + + + Arguments of the input panel: + + \image html fuse_images_input_panel.png "Fuse images input panel" + +Name - field for defining the name of image after fusing;
+Image 1 - field for defining the first fusing image;
+Image 2 - field for defining the second fusing image;
+Apply - button to create fused image object;
+Apply and Close - button to create fused image object and close input panel;
+Close - button to close input panel.
+ +
Also, it's possible to change background color of fused image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. + + \image html select_color.png "Select color dialog box" + +Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/general_services.doc b/doc/salome/gui/HYDRO/input/general_services.doc new file mode 100644 index 00000000..6b1b7318 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/general_services.doc @@ -0,0 +1,29 @@ + +/** + @file + \brief Help for the general services +*/ + +/** + \page general_services General services + + The HYRDOGUI module supports following services: + - \ref save "Save file" + - \ref open "Open file" + - \ref dump_study "Dump study" + - \ref load_script "Load script" + - \ref undo_redo "Undo/Redo actions" + - \ref copy_paste "Copy/Paste object(s)" + - \ref delete "Delete object(s)" + - \ref color "Color object" + - \ref show_hide "Show/Hide object(s)" + - \ref update "Update object" + - \ref rename "Rename object" + - \ref submersible "Submersible" + - \ref copy_position "Copy position" + - \ref change_layer_order "Change layer order" + + Back to Main page. + + +*/ diff --git a/doc/salome/gui/HYDRO/input/georeferencement_profile.doc b/doc/salome/gui/HYDRO/input/georeferencement_profile.doc new file mode 100644 index 00000000..faad63f2 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/georeferencement_profile.doc @@ -0,0 +1,41 @@ + +/** + @file + \brief Help for the georeferencement profile +*/ + +/** + \page georeferencement_profile Georeferencement of profiles + + Back to Main page. + + Georeferencement of profiles in HYDROGUI module is accessible via:
    +
  • The main menu HYDRO => Profile => Georeferencement;
    • +
  • Context menu of PROFILES in Object browser - Georeferencement;
    • +
  • Context menu of selected profiles in Object browser - Georeferencement;
    • +
  • Profile(s)georeferencement toolar button.
    • + +\image html georeferencement_toolbar_button.png "Profile(s) georeferencement toolbar button" +
+ + Georeferencement profile input panel appears. The table widget shows either all profiles existing in document or selected profiles depending on the radio button activated: + + \image html profiles_georeferencement_all.png "Profiles georeferencement input panel- All profiles" + \image html profiles_georeferencement_selected.png "Profiles georeferencement input panel- Selected profiles" + +If the user starts the operation via main menu, context menu of PROFILES or toolar button then the radio button All is activated automatically; if via context menu of selected profiles - Selected radio button. + +The user can input/change the coordinates of G, D profile points directly in the table using cell widgets or selecting a cell in the table and clicking in viewer. + +Apply - button to validate changes;
+Apply and Close - button to validate changes and close input panel;
+Close - button to close input panel. + + +2D profiles that were georeferenced become 3D profiles and their names color is changed from red to black. + +\image html georeferencemented_profiles.png "Profiles in Object browser before and after georeferencement" + + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/image.doc b/doc/salome/gui/HYDRO/input/image.doc new file mode 100644 index 00000000..eb9e0664 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/image.doc @@ -0,0 +1,20 @@ +/** + @file + \brief Help for the image +*/ + +/** + \page image Image + + Back to Main page. + +Image is a picture area, the user is interested in. Images can be used to better visualize the study zone, the positioning of the geometries - polylines, bathymetries, etc.
+ The HYDROGUI module supports the following operations with images: + + - \ref impimage "Import image" + - \ref fuseimages "Fuse images" + - \ref cutimages "Cut images" + - \ref splitimage "Split image" + + +*/ diff --git a/doc/salome/gui/HYDRO/input/immersible_zone.doc b/doc/salome/gui/HYDRO/input/immersible_zone.doc new file mode 100644 index 00000000..c0a1ff7a --- /dev/null +++ b/doc/salome/gui/HYDRO/input/immersible_zone.doc @@ -0,0 +1,36 @@ + +/** + @file + \brief Help for the immersible zone +*/ + +/** + \page imzone Immersible zone + + Back to Main page. + + The immersible zone is a natural object describing the area that is (or may be) under the water. + + Create immersible zone input panel can be opened via:
    +
  1. The main menu HYDRO => Create immersible zone; +
  2. Context menu of NATURAL OBJECTS in Object browser => Create immersible zone; +
  3. Create immersible zone toolar button.\image html create_immersible_zone_toolbar_button.png "Create immersible zone toolbar button" +
+ + Arguments of the input panel: + + \image html create_immersible_zone_input_panel.png "Create immersible zone input panel" + +Name - field to define the immersible zone name;
+Polyline - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.
+Bathymetry - combo - box to select the bathymetry object describing immersible zone's profile;
+Apply - button to generate immersible zone;
+Apply and Close - button to generate immersible zone and close input panel;
+Close - button to close input panel. + +Example:
+ +\image html immersible_zone_example.png "Immersible zone example" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/import_image.doc b/doc/salome/gui/HYDRO/input/import_image.doc new file mode 100644 index 00000000..553c26b3 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_image.doc @@ -0,0 +1,54 @@ + +/** + @file + \brief Help for the import image +*/ + +/** + \page impimage Import image + + Back to Main page. + + Import image input panel can be opened via:
    +
  1. The main menu HYDRO => Import image; +
  2. Context menu of IMAGES in Object browser => Import image; +
  3. CTRL + I buttons combination; +
  4. Import image toolar button. \image html import_image_toolbar_button.png "Import image toolbar button" +
+ + Arguments of the input panel: + + \image html impot_image_dialog.png "Import image input panel" + +File name - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif.
+Name - field for defining the name of image after import. By default - the name of the file;
+Apply - button to create image object;
+Apply and Close - button to create image object and close input panel;
+Close - button to close input panel.
+ Another fields become enabled: + + \image html import_image_enabled.png "Enabled Import image input panel" + + By default, two points should be used for the image positioning. The corresponding transformation should be built using the rules: only panning, rotation and scaling are allowed; the scaling is same along X, Y; all angles are kept.
+ An additional check box allows the user to activate usage of the 3-rd point (unchecked by default). When user activates it he can select the 3-rd point exactly as previous two and in this case the complete affine transformation is applied (note that angles can be not kept and scaling along X, Y may be different in this case).
+ + Coordinates of points can be defined via:
    + +
  1. Manually input Geographic coordinates +
    It's necessary to to input latitude and longitude of points. + \image html geographic_coordinates.png "Geographic coordinates" + +
  2. Manually input Plane coordinates(Lambert93) +
    It's necessary to input lambert coordinates of points. + \image html lambert_coordinates.png "Lambert coordinates" + +
  3. Get Plane coordinates (Lambert93) from file +
    It's necessary to load file with lambert coordinates. Supported format - .GRF (image georeferencement file) + +
  4. Choose points on reference image +
    It's necessary to choose reference image from combo box + \image html reference_image.png "Combo-box for defining reference image" +
+ +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/import_obstacle.doc b/doc/salome/gui/HYDRO/input/import_obstacle.doc new file mode 100644 index 00000000..98f499b7 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_obstacle.doc @@ -0,0 +1,71 @@ + +/** + @file + \brief Help for Import obstacle from file operation +*/ + +/** + \page import_obstacle Import obstacle from file + + + Back to Main page. + + An obstacle can be imported into the HYDROGUI module from external file. + + + The Import obstacle operation can be started via:
    + +
  1. The main menu HYDRO => Obstacle => Import obstacle ; +
  2. Context menu of OBSTACLES in Object browser - Import obstacle; +
  3. Import obstacle from file toolbar button +
+ +\image html import_obstacle_toolbar_button.png "Import obstacle from file toolbar button" + + + Import obstacle input panel appears. + + + \image html import_obstacle_create_input_panel.png " Import obstacle input panel - Create mode" + + \image html import_obstacle_input_panel.png " Import obstacle input panel - Modify mode" + +Arguments of the input panel: + +File name - field for defining file to import. + + +The user clicks Open File button. + + +\image html open_file_icon.png "Open File button" + + +Open File dialog box appears. + + +\image html open_file_dialog.png "Open File dialog" + + +The user selects type of file to be imported. Supported formats are BREP, IGES, STEP. + + +The user selects folder in Look in filed and desired file in this folder. + +The user clicks Open button. + +Open File dialog box is closed. Selected file appears in File name. + + +Name - field to define the obstacle name. By default name is the same as file name without extension;
+Mode - allows to generate a new obstacle (radio-button Create new) or replace existing obstacle (radio-button Modify) ;
+Apply - button to import obstacle;
+Apply and Close - button to import obstacle and close input panel;
+Close - button to close input panel. + + The obstacle is presented as the face and 3D object. + \image html obstacle_presentation.png "Obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/import_obstacle_GEOM.doc b/doc/salome/gui/HYDRO/input/import_obstacle_GEOM.doc new file mode 100644 index 00000000..bf6ae770 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_obstacle_GEOM.doc @@ -0,0 +1,43 @@ + +/** + @file + \brief Help for Import GEOM object as obstacle operation +*/ + +/** + \page import_obstacle_GEOM Import GEOM object as obstacle + + Back to Main page. + + A geometrical object can be imported into the HYDROGUI module as an obstacle. + + + The Import GEOM object as obstacle operation can be started via Context menu of GEOM object in Object browser - Import as obstacle. + + The user can select one/several objects in GEOM, in this case for each selected object the corresponding instance of HYDRO obstacle will be created. + + + Import GEOM object as obstacle input panel appears. + +The same input panel appears after creation of new geometrical primitives as results of Create box and Create cylinder operations. + +Import GEOM object as obstacle input panel appears. + + \image html box_input_panel_create.png " Import GEOM object as obstacle input panel - Create mode" + + \image html box_input_panel.png " Import GEOM object as obstacle input panel - Modify mode" + +Arguments of the input panel: + +Name - field to define the obstacle name. By default name is the same as name of corresponding GEOM object;
+Mode - allows to generate a new obstacle (radio-button Create new) or replace existing obstacle (radio-button Modify) ;
+Apply - button to generate obstacle;
+Apply and Close - button to generate obstacle and close input panel;
+Close - button to close input panel. + + The obstacle is presented as the face and 3D object. + \image html box_presentation.png "Box obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/import_polyline.doc b/doc/salome/gui/HYDRO/input/import_polyline.doc new file mode 100644 index 00000000..0737324f --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_polyline.doc @@ -0,0 +1,21 @@ + +/** + @file + \brief Help for the import polyline +*/ + +/** + \page import_polyline Import polyline + + Back to Main page. + + It is possible to import polylines in HYDROGUI module. This operation is accessible via:
    +
  • The main menu HYDRO => Import polyline;
    • +
  • Import polyline toolar button. \image html import_polyline_toolbar_button.png "Import polyline toolbar button"
    • +
+ + Import polyline dialog box appears: + \image html import_polyline_dialog_box.png "Import polyline dialog box" + +Supported formats - .SX(sinusX files) and .SHP(shape files). +*/ diff --git a/doc/salome/gui/HYDRO/input/import_profile.doc b/doc/salome/gui/HYDRO/input/import_profile.doc new file mode 100644 index 00000000..5377ea47 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_profile.doc @@ -0,0 +1,41 @@ + +/** + @file + \brief Help for the import profile +*/ + +/** + \page import_profile Import profile + + Back to Main page. + + Import profiles in HYDROGUI module from external file is accessible via:
    +
  • The main menu HYDRO => Profile => Import profiles;
    • +
  • Context menu of PROFILES in Object browser - Import profiles;
    • +
  • Import profiles from file(s) toolar button.
    • + +\image html import_profile_toolbar_button.png "Import profiles from file(s) toolbar button" +
+ + Import profile dialog box appears: + \image html import_profile_dialog_box.png "Import profile dialog box" + + +The user selects folder in Look in filed and one or several desired file in this folder. + +The user clicks Open button. + +Open File dialog box is closed. Selected profile(s) appear(s) in Object browser. 2D profiles names are colored in red, 3D profile names with georteferncement are colored in black. + +\image html imported_profiles.png "Imported profiles in Object browser" + +The profile file format is text where each line corresponds to one point in the profile. + +Depending on number of values in line two use cases can be distinguished:
    + +
  • 2D case - each line contains 2 double values (parametric case). Note, that the X values should increase so if the current value is less than previous it can be interpreted as start of new profile.
    • +
  • 3D case - each line contains 3 double values. First and last points are interpreted as points of georeferencement: first point is G (left bank), last point is D (right bank). The intermediate points should be recalculated to parametric presentation according to rule: the profile is straight segment on plan, and for each point U is equal to distance from the current point to the first point and Z is taken as is from the file.
    • +
+ + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/import_strickler_table.doc b/doc/salome/gui/HYDRO/input/import_strickler_table.doc new file mode 100644 index 00000000..809f941e --- /dev/null +++ b/doc/salome/gui/HYDRO/input/import_strickler_table.doc @@ -0,0 +1,27 @@ + +/** + @file + \brief Help for the import strickler table +*/ + +/** + \page import_strickler_table Import strickler table + + Back to Main page. + + It is possible to import strickler table in HYDROGUI module. This operation is accessible via:
    +
  • The main menu HYDRO => Import strickler table;
    • +
  • Context menu of STRICKLER TABLES in Object browser => Import strickler table;
    • +
  • Import strickler table toolar button. \image html import_strickler_table_toolbar_button.png "Import strickler table toolbar button"
    • +
+ + Import strickler table input panel looks like: + \image html import_strickler_table_input_panel.png "Import strickler table input panel" + Arguments of the input panel: + +File name - field to define file to import;
+Name - field to define the name of strickler table object after import. By default - the name of the file;
+Apply - button to create strickler table object;
+Apply and Close - button to create strickler table object and close input panel;
+Close - button to close input panel.
+*/ diff --git a/doc/salome/gui/HYDRO/input/land_cover.doc b/doc/salome/gui/HYDRO/input/land_cover.doc new file mode 100644 index 00000000..acd21e8f --- /dev/null +++ b/doc/salome/gui/HYDRO/input/land_cover.doc @@ -0,0 +1,13 @@ +/** + @file + \brief Help for the land cover +*/ + +/** + \page land_cover Land cover + + Back to Main page. + + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/load_script.doc b/doc/salome/gui/HYDRO/input/load_script.doc new file mode 100644 index 00000000..3ae2ccb1 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/load_script.doc @@ -0,0 +1,27 @@ + +/** + @file + \brief Help for the load script +*/ + +/** + \page load_script Load script + + Back to Main page. + + The HYDROGUI module supports loading Python scripts. This operation can be called via:
    +
  1. The main menu File => Load script;
    2. +
  2. CTRL + T buttons combination;
    3. +
+ + + Load python script dialog box looks like: + + \image html load_python_script_dialog_box.png "Load python script dialog box" + + When script loading is done, according message appears in Python console. In case of problems during loading, error appears in Python console. + + \image html python_console.png "Python console" + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/local_cs.doc b/doc/salome/gui/HYDRO/input/local_cs.doc new file mode 100644 index 00000000..1c537c37 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/local_cs.doc @@ -0,0 +1,31 @@ + +/** + @file + \brief Help for the local CS +*/ + +/** + \page local_cs Local CS + + Back to Main page. + + The HYDROGUI module allows the user to change local coordinate system to avoid big numbers with Lambert 93 coordinates.
+ For this Local CS transformation input panel should be called via:
    +
  • The main menu HYDRO => Change local CS;
    • +
  • Context menu of HYDRO in Object browser => Change local CS.
    • +
+Local CS transformation input panel looks like: + + \image html local_cs_transformation_input_panel.png "Local CS transformation input panel" + + Arguments of the input panel:
+ + LX - spin-box to define value of OX in local CS;
+ LY - spin-box to define value of OY in local CS.
+ Apply - button to transform local coordinate system;
+ Apply and Close - button to transform local coordinate system and close input panel;
+ Close - button to close input panel. + +Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/mainpage.doc b/doc/salome/gui/HYDRO/input/mainpage.doc new file mode 100644 index 00000000..f57f0673 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/mainpage.doc @@ -0,0 +1,88 @@ + +/** + @file + \brief Help for the main page of the HYDROGUI module +*/ + +/** + @mainpage + + The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company + in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc). + It represents a pre-processor for the geometry modelling of the natural and artificial objects on the landscape. + The user starts work with raster maps where he can create analytic curves and regions describing the existing natural objects, + such as banks, coasts, lakes, rivers etc. Also he can create artificial objects (channel, dam) using the algorithms of the geometry modelling. + The objects are referenced to the real territory using the geodesic coordinates. + Finally the constructed landscape study is prepared for the further meshing and using in the hydrodynamic solvers. + + The HYDRO module is implemented on the base of the SALOME platform and powered by the OpenCascade and SALOME platforms. + + It supports the following features: + - raster maps (import from files and georeferencement by geodesic coordinates); + - geometry curves (creation on the map and import from SALOME GEOM module); + - geometry objects (creation and import from SALOME GEOM module); + - support of natural objects (immersible zones, lakes, rivers) and artificial objects (obstacles, channels, dams); + - georeferencement of the objects when the objects are connected with points on real territory using the geodesic coordinates; + - geometry algorithms on analytic objects (extrusion, partition) for complex objects construction; + - support of the results of the territory level measurement (bathymetry); + - partition of objects on zones of intersection and specifying the properties for these zones; + + In the perspective the pre-processor can be completed by the post-processor showing the calculated results. + + The HYDROGUI module supports the following objects: + - \ref imzone "Immersible zone" + - \ref p_profile "Profile" + - \ref create_profile "Create profile" + - \ref import_profile "Import profile" + - \ref georeferencement_profile "Profile georeferencement" + - \ref art_digue "Digue" + - \ref art_channel "Channel" + - \ref obstacle "Obstacle" + - \ref box_obstacle "Create Box obstacle" + - \ref cylinder_obstacle "Create Cylinder obstacle" + - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY" + - \ref import_obstacle "Import obstacle from file" + - \ref translate_obstacle "Translation of an obstacle" + + + - \ref polyline3d "Polyline 3D" + - \ref polyline "Polyline" + - \ref export_polyline "Export polyline" + - \ref import_polyline "Import polyline" + - \ref bathymetry "Bathymetry" + - \ref strickler_table "Strickler table" + - \ref export_strickler_table "Export strickler table" + - \ref import_strickler_table "Import strickler table" + - \ref stream "Stream" + - \ref impimage "Find bottom" + - \ref profilesinterpolation "Profiles interpolation" + - \ref image "Image" + - \ref impimage "Import image" + - \ref fuseimages "Fuse images" + - \ref cutimages "Cut images" + - \ref splitimage "Split image" + - \ref calculation_case "Calculation case" + +The HYDROGUI module supports the following \ref general_services "services":
+ + + - \ref general_services "General services" + - \ref preferences "Preferences" + - \ref save "Save file" + - \ref open "Open file" + - \ref dump_study "Dump study" + - \ref load_script "Load script" + - \ref undo_redo "Undo/Redo actions" + - \ref copy_paste "Copy/Paste object(s)" + - \ref delete "Delete object(s)" + - \ref color "Color object" + - \ref show_hide "Show/Hide object(s)" + - \ref update "Update object" + - \ref rename "Rename object" + - \ref submersible "Submersible" + - \ref copy_position "Copy position" + - \ref change_layer_order "Change layer order" + - \ref local_cs "Local CS" + + +*/ diff --git a/doc/salome/gui/HYDRO/input/obstacle.doc b/doc/salome/gui/HYDRO/input/obstacle.doc new file mode 100644 index 00000000..3a2d2833 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/obstacle.doc @@ -0,0 +1,29 @@ + +/** + @file + \brief Help for the obstacle +*/ + +/** + \page obstacle Obstacle + + Back to Main page. + + In the HYDROGUI module obstacle is 3D object created in or imported from Geometry module or from external file. + + + The HYDROGUI module supports the following techniques of obstacles creation: + + + - \ref box_obstacle "Create Box obstacle" + - \ref cylinder_obstacle "Create Cylinder obstacle" + - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY" + - \ref import_obstacle "Import obstacle from file" + - \ref translate_obstacle "Translation of an obstacle" + + The obstacle is presented as the 2D face and 3D object. + \image html box_presentation.png "Box obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/open_file.doc b/doc/salome/gui/HYDRO/input/open_file.doc new file mode 100644 index 00000000..7e0c9807 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/open_file.doc @@ -0,0 +1,38 @@ + +/** + @file + \brief Help for the open file +*/ + +/** + \page open Open file + + Back to Main page. + + The HYDROGUI module supports opening documents. This operation can be called via:
    +
  1. The main menu File => Open;
    2. +
  2. CTRL + O buttons combination;
    3. +
  3. Open document toolar button.
    4. + \image html open_document_toolbar_button.png "Open document toolbar button" +
+ + In case if there is an active study in the session, Close active study warning appears: + \image html close_active_study_warning.png "Close active study warning" + + Save & Close - button to save active study and open new file;
+ Close w/o saving - button to ingore saving active study and open new file;
+ Cancel - button to reject opening new file.br> + + Open file dialog box looks like: + \image html open_file_dialog_box.png "Save file dialog box" + + Supported format: .HDF
+ + Additionally, Reopen file operation is supported. It can be called from the main menu File => Reopen. After that dialog box appears, clarifying the user's desire to reopen document: + \image html reopen_file_dialog_box.png "Reopen file dialog box" + + Yes - button to reopen file and lost all not saved data;
+ No - button to reject reopening.
+ + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/polyline.doc b/doc/salome/gui/HYDRO/input/polyline.doc new file mode 100644 index 00000000..9784226d --- /dev/null +++ b/doc/salome/gui/HYDRO/input/polyline.doc @@ -0,0 +1,101 @@ + +/** + @file + \brief Help for the polyline +*/ + +/** + \page polyline Polyline + + Back to Main page. + + The polyline creation is available only in the OCC viewer. + + Create polyline input panel can be opened via:
    +
  1. The main menu HYDRO => Create polyline; +
  2. Context menu of POLYLINES in Object browser => Create polyline; +
  3. Create polyline toolar button.\image html create_polyline_toolbar_button.png "Create polyline toolbar button" +
+ + Arguments of the input panel: + + \image html create_polyline_input_panel.png "Create polyline input panel" + + Name - field to define the polyline name;
+ Apply - button to create polyline;
+Apply and Close - button to create polyline and close input panel;
+Close - button to close input panel.
+ The polyline creation starts by creation of one or several sections. For adding new section it's necessary to click Insert new section button. \image html insert_new_section_button.png "Insert new section toolbar button" + + Add element panel is necessary to define parameters of section. + + \image html add_element_panel.png "Add element panel" + + Name - field to define the section name;
+ Type - combo-box to define type of section: Polyline or Spline;
+ Closed - if this checkbox is OFF, new section will be open. If checkbox is ON, new section will be closed;
+ Add - button to add new section into the list.
+ + A polyline may include several sections not connected with each other. + + 3 modes are available for work with points:
    +
  1. Addition mode

    2. + In this mode only point’s creation is available. Can be activated by Addition mode button clicking.
    \image html addition_mode_button.png "Addition mode toolbar button" + Each time when user clicks left mouse button in the viewer a new point is created (the plane X,Y, i.e. Z = 0 should be used for coordinates obtaining). The point is added always to the end of points list. + Note that addition of points is performed always to the current (selected) section of the polyline. User should select in the dialog box another section to start points addition to it. +
  2. Modification mode

    3. + In this mode the user can edit the built sections and points of the polyline. Can be activated by Modification mode button clicking.
    \image html modification_mode_button.png "Modification mode toolbar button" +
      +
    • When user selects a point (or several points) in viewer, its coordinates are shown in the input panel in the table, so the user can change it directly using table cell widgets;
      • +
    • When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position; the new point is inserted between segment tail points;
      • +
    • When user selects one or several points in viewer, he can activate the “drag-n-drop” mode (holding the mouse left button) to move all selected points inside the plane X, Y;
      • +
    • The rectangular and additive (holding Ctrl button) selections should be available for points;
      • +
    • User can remove points selecting one or several points and pressing “Delete” on keyboard or calling the popup menu and clicking on operation “Delete”.
      • +
    + \image html modif_mode_table.png "Table with coordinates" +
  3. Detection mode

    4. + TO BE UPDATED +
+ + Another operations are available during creation/edition of polyline:
    +
  • Undo

    • + Undoes last action. + \image html undo_button.png "Undo toolbar button" +
  • Redo

    • + Redoes last undoing. + \image html redo_button.png "Redo toolbar button" +
  • Remove

    • + Can be called by Remove button clicking. + \image html remove_button.png "Remove toolbar button" + Removes selected section(s) if no mode is activated.
    + Removes selected points if modification mode is activated.
    +
  • Join selected sections

    • + Can be called with help of:
      +
    • Join selected sections toolbar button, if 2 or more selected sections are selected in the list
      • ;
      + \image html join_selected_sections_button.png "Join selected sections toolbar button" +
    • Join command, called from context menu of 2 or more selected sections
      • ;
      +
    + Joines sections selected in the list inside Sections area, creating one section. +
  • Join all sections

    • + Can be called with help of Join all sections command from context menu inside Sections area.
    + Joines all existing sections, having creating one section having type closed polyline.
    +
  • Clear all

    • + Can be called only if modification mode is activated from context menu inside Sections area.
    +
  • Set closed

    • + Can be called only if modification mode is activated from context menu of selected section(s).
    + Modifies selected section into closed. +
  • Set open

    • + Can be called only if modification mode is activated from context menu of selected section(s).
    + Modifies selected section into open. +
  • Set polyline

    • + Can be called only if modification mode is activated from context menu of selected section(s).
    + Modifies selected section into polyline. +
  • Set spline

    • + Can be called only if modification mode is activated from context menu of selected section(s).
    + Modifies selected section into spline. +
+ + Additionally, the HYDROGUI module supports \ref export_polyline "export" and \ref import_polyline "import polyline". + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/polyline3d.doc b/doc/salome/gui/HYDRO/input/polyline3d.doc new file mode 100644 index 00000000..a2ed3e46 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/polyline3d.doc @@ -0,0 +1,39 @@ + +/** + @file + \brief Help for the polyline 3d +*/ + +/** + \page polyline3d Polyline 3D + + Back to Main page. + +The polyline 3D object is used as guide line for creation of channel or digue.
+Creation of polyline 3D is available only in the OCC viewer.
+ Create polyline 3D input panel can be opened via:
    +
  1. The main menu HYDRO => Create polyline 3D; +
  2. Context menu of POLYLINES 3D in Object browser => Create polyline 3D; +
  3. Create polyline 3D toolar button.\image html create_polyline_3d_toolbar_button.png "Create polyline 3D toolbar button" +
+ + Arguments of the input panel: + + \image html create_polyline_3d_input_panel.png "Create polyline 3D input panel" + +Name - field for defining the name of polyline 3D;
+Apply - button to create polyline 3D;
+Apply and Close - button to create polyline 3D and close input panel;
+Close - button to close input panel.
+ +Following parameters have to be defined to create polyline 3d object:
    +
  • Polyline
    • - any polyline object can be selected in this field; +
  • Profile or Bathymetry - one of this fields should be filled by any profile or bathymetry accordingly.
    • +
+ +Example:
+ +\image html polyline_3d_example.png "Polyline 3D example" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/preferences.doc b/doc/salome/gui/HYDRO/input/preferences.doc new file mode 100644 index 00000000..dc5a065a --- /dev/null +++ b/doc/salome/gui/HYDRO/input/preferences.doc @@ -0,0 +1,64 @@ + +/ +/** + @file + \brief Help for the HYDRO module Preferences +*/ + +/** + \page preferences Preferences + + Back to Main page + + + Salome application supports Preferences. The Preferences dialog box can be called via:
    + +
  1. The main menu File => Preferences;
    2. + +
  2. CTRL + R buttons combination.
    3. + +
+ + + + Preferences dialog box appears. Help for all sections of Preferences dialog box except HYDRO can be found in Introduction to Salome platform. + +The user selects HYDRO in Available preferences section: + + + + \image html preferences.png "Preferences dialog box" + + + + Controls inside Preferences dialog box: + + +Type - combo - box to select the cursor presentation for edition operation;
+ +\image html preferences_type.png "Type combo-box in Preferences dialog box" + + +Make automatic fit all after show object operation - check - box swith on/off Fit all;
+Default Strickler coefficient field is used for Strickler coefficient asigned to area not covered by land cover or land cover with undefined type;
+OK - button to validate changes and close dialog box;
+Apply - button to validate changes;
+Defaults - button to restore default values in all fields;
+Close - button to close dialog box;
+Import - button to import Preferences from external xml file. + + The user clicks Import button. Import preferences dialog box appears: + +\image html preferences_import.png "Import preferences dialog box" + + + +The user selects folder in Look in filed and desired file in this folder. + +The user clicks Open button. + +Import preferences dialog box is closed. Prefernces are updated. + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/profile.doc b/doc/salome/gui/HYDRO/input/profile.doc new file mode 100644 index 00000000..a51466e2 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/profile.doc @@ -0,0 +1,48 @@ + +/** + @file + \brief Help for profile +*/ + +/** + \page p_profile Profile + + Back to Main page. + +The profile is used for definition of a stream cross-section or as a base of extrusion to generate a channel or digue. + +The 2D profiles are built/defined in a 2D space (U, Z). The coordinate U is parametric coordinate, it has no unit. The coordinate Z is real altitude (in meters). + +To build 2D profile Use function + + - \ref create_profile "Create profile". + + + +2D profile object is internal data model object and can not be shown in OCC viewer. 2D profile names are colored in red in object browser. + + + +Created 2D profiles should be positioned in 3D space using Georeferencement to be converted into 3D profiles: + +- \ref georeferencement_profile "Profile georeferencement". + + +3D profile is 3D wire describing profile curve in 3d space. +3D profile names are colored in black in object browser. + + +Both 2D and 3D profiles can be imported from external file: + + - \ref import_profile "Import profile" + + Back to Main page. + +*/ + + + + + + + diff --git a/doc/salome/gui/HYDRO/input/profile_interpolation.doc b/doc/salome/gui/HYDRO/input/profile_interpolation.doc new file mode 100644 index 00000000..7bc9a058 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/profile_interpolation.doc @@ -0,0 +1,45 @@ + +/** + @file + \brief Help for the find bottom +*/ + +/** + \page profilesinterpolation Profiles interpolation + + Back to Main page. + + Profiles interpolation operation builds additional profiles to get more detailed river bed. + + Profiles interpolation input panel can be opened via:
    +
  1. The main menu HYDRO => Stream => Profiles interpolation; +
  2. Context menu of Stream object in Object browser - Profiles interpolation;
    3. +
+ + Profiles interpolation input panel looks like: + + \image html profiles_interpolation_input_panel.png "Profiles interpolation input panel" + + Arguments of the input panel:
+ +Stream object - combo-box to define reference stream object;
+Interpolator - combo-box to define interpolation algorithm used. Currently only linear interpolation is accessible;
+Description - field, describing interpolation method's features;
+Profile 1 - combo-box to define profile, which will be the start of interpolation;
+Profile 1 - combo-box to define profile, which will be the end of interpolation;
+Number of profiles - spin-box to define the quantity of profiles which will be created;
+Parameters - field to set additional interpolation parameters (name as string, value as string):
    +
  • complete line of parameters should be input by user as a single text line and it should be parsed by spaces i.e. for example “len 5 hypothesis linear” will give additional parameters “len” = “5”; “hypothesis” = “linear”;
    • +
  • the sense of such parameters depends on the interpolator implementation;
    • +
  • parameters are passed to interpolator by several calls of “set” function (for each pair name, value);
    • +
+Apply - button to build stream's bottom;
+Apply and Close - button to build stream's bottom and close input panel;
+Close - button to close input panel. + +The input panel built-in viewer shows profiles from selected reference stream object and profiles to be created during interpolation. The existing profiles are shown as black curves, the new profiles – as red curves: + +\image html profile_interpolation_preview.png "Profile interpolation preview" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/rename.doc b/doc/salome/gui/HYDRO/input/rename.doc new file mode 100644 index 00000000..80619d68 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/rename.doc @@ -0,0 +1,20 @@ + +/** + @file + \brief Help for the rename object +*/ + +/** + \page rename Rename object + + Back to Main page. + + It is possible to rename any object in HYDROGUI module.
+ + Following ways are available for starting this action:
    +
  1. Select object and push F2 button;
    2. +
  2. Select object, call context menu and call Rename button;
    3. +
  3. Double click on interesting object.
    4. +
+ +*/ diff --git a/doc/salome/gui/HYDRO/input/save_file.doc b/doc/salome/gui/HYDRO/input/save_file.doc new file mode 100644 index 00000000..cb09d80b --- /dev/null +++ b/doc/salome/gui/HYDRO/input/save_file.doc @@ -0,0 +1,28 @@ + +/** + @file + \brief Help for the save file +*/ + +/** + \page save Save file + + Back to Main page. + + The HYDROGUI module supports saving documents in .HDF format. This operation can be called via:
    +
  1. The main menu File => Save;
    2. +
  2. CTRL + S buttons combination;
    3. +
  3. CTRL + SHIFT + S buttons combination for Save As... operation;
    4. +
  4. Save document toolar button.
    5. + \image html save_document_toolbar_button.png "Save document toolbar button" +
+ + Save file dialog box looks like: + \image html save_file_dialog_box.png "Save file dialog box" + + + In case if the user tries to save document with name already used, warning appears, suggested overwriting existing file : + \image html save_file_warning.png "Warning" + + Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/show_hide.doc b/doc/salome/gui/HYDRO/input/show_hide.doc new file mode 100644 index 00000000..9a0090be --- /dev/null +++ b/doc/salome/gui/HYDRO/input/show_hide.doc @@ -0,0 +1,31 @@ + +/** + @file + \brief Help for the show/hide object +*/ + +/** + \page show_hide Show/hide object(s) + + Back to Main page:
+ + \ref general_services "Back to general services" + + It is possible to show and hide objects in the viewer in HYDROGUI module.
+ + The user can show object(s) via the following commands:
    +
  1. Show all
    2. - shows all objects. Can be executed from context menu called from viewer or Object browser; +
  2. Show
    3. - shows selected objects. Can be executed from context menu of selected objects; +
  3. Show only
    4. - shows selected objects and hides already shown objects. Can be executed from context menu of selected objects; +
  4. Eye icon
    5. - locates in Object browser near every object. Just click on it to show object, if it is hidden. + + \image html eye_icons.png "Eye icons of shown and hidden objects" +
+ + The user can hide object(s) via the following commands:
    +
  1. Hide all
    2. - hides all objects. Can be executed from context menu called from viewer or Object browser; +
  2. Hide
    3. - hides selected objects. Can be executed from context menu of selected objects; +
  3. Eye icon
    4. - locates in Object browser near every object. Just click on it to hide object, if it is shown. +
+ +*/ diff --git a/doc/salome/gui/HYDRO/input/split_image.doc b/doc/salome/gui/HYDRO/input/split_image.doc new file mode 100644 index 00000000..3d1de565 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/split_image.doc @@ -0,0 +1,34 @@ + +/** + @file + \brief Help for the split image +*/ + +/** + \page splitimage Split image + + Back to Main page. + +The user can start Split image operation via:
    +
  1. The main menu HYDRO - Split image; +
  2. Context menu of any image in Object browser - Split image; +
  3. Split image toolbar button \image html split_image_toolbar_button.png "Split image toolbar button" +
+ Arguments of the input panel: + \image html split_image_input_panel.png "Split image input panel" + +Name - field for defining the name of image after cut;
+Modify selected image - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified.
+Image - field for defining the reference image to be split;
+Polyline - field for defining the the tool for split. Only closed polylines can be selected in this field;
+Apply - button to create split image object;
+Apply and Close - button to create split image object and close input panel;
+Close - button to close input panel.
+ +Also, it's possible to change background color of split image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. + + \image html select_color.png "Select color dialog box" + +Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/stream.doc b/doc/salome/gui/HYDRO/input/stream.doc new file mode 100644 index 00000000..0db796e7 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/stream.doc @@ -0,0 +1,54 @@ + +/** + @file + \brief Help for the stream +*/ + +/** + \page stream Stream + + Back to Main page. + + Stream is a natural object simulating the river bed. + + Create stream input panel can be opened via:
    +
  1. The main menu HYDRO => Stream => Create stream; +
  2. Context menu of NATURAL OBJECTS in Object browser => Create stream; +
  3. Create steam toolar button.\image html create_stream_toolbar_button.png "Create stream toolbar button" +
+ + Arguments of the input panel: + + \image html create_stream_input_panel.png "Create stream input panel" + +Name - field to define the stream name;
+Polyline - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.
+Hydraulic axis - combo - box to select the polyline, which is hydraulic axis of the river. Rules are following:
    +
  • Polyline should be open;
    • +
  • Polyline should consist from one section only;
    • +
  • Polyline cannot be self-intersected or contain sharp angles, which can lead to self-intersections in resulting shell.
    • +
+Apply - button to generate stream;
+Apply and Close - button to generate stream and close input panel;
+Close - button to close input panel.
+ +Also it's necessary to add profiles into the list. For this select one/several profiles objects in the object browser and click the button Add. The rules are following:
    +
  1. Invalid (not positioned) profiles can not be added; they are simply ignored;
    2. +
  2. Profile can not be added several times to the list; such profiles are simply ignored;
    3. +
  3. Each added profile should intersect with the selected hydraulic axis; if for certain profile does not intersect, it is ignored.
    4. +
+It's possible to remove added profiles from the list. For this select profile(s) in the list and click Remove button.
+ +Generated stream object contains 3D object, simulating the river bed, and its projection on XY plane, which is used for calculation.
+ +Following operations are available with stream: + - \ref findbottom "Find bottom" + - \ref profilesinterpolation "Profiles interpolation" + +Examples:
+ +\image html stream_3d_example.png "Stream 3D example" +\image html stream_2d_example.png "Stream 2D example" + +Back to Main page. +*/ diff --git a/doc/salome/gui/HYDRO/input/strickler_table.doc b/doc/salome/gui/HYDRO/input/strickler_table.doc new file mode 100644 index 00000000..305c2249 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/strickler_table.doc @@ -0,0 +1,13 @@ + +/** + @file + \brief Help for the strickler table +*/ + +/** + \page strickler_table Strickler table + + Back to Main page. + + +*/ diff --git a/doc/salome/gui/HYDRO/input/submersible.doc b/doc/salome/gui/HYDRO/input/submersible.doc new file mode 100644 index 00000000..c799cf73 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/submersible.doc @@ -0,0 +1,21 @@ + +/** + @file + \brief Help for the submersible +*/ + +/** + \page submersible Submersible + + Back to Main page. + + Objects in HYDROGUI module have Submersible mark.
+ + Regions, created basing on submersible objects are included in final geometry during export calculation case. Regions, created basing on not submersible objects are excluded from final geometry.
+ + It is possible to define, is submersible the object or not, with help of its context menu and according command. + +\image html submersible.png "Submersible context menu command" + + +*/ diff --git a/doc/salome/gui/HYDRO/input/translate_obstacle.doc b/doc/salome/gui/HYDRO/input/translate_obstacle.doc new file mode 100644 index 00000000..7501d327 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/translate_obstacle.doc @@ -0,0 +1,36 @@ + +/** + @file + \brief Help for translate obstacle operation +*/ + +/** + \page translate_obstacle + + Back to Main page. + + An obstacle can be copied and translated in the HYDROGUI module. + + + The Translation of an obstacle operation can be started via Context menu of obstacle object in Object browser - Translate. + + + + Translation of an obstacle input panel appears. + + \image html translate_obstacle_input_panel.png " Translation of an obstacle input panel" + +Arguments of the input panel: + +Name - uneditable field containing the initial obstacle name;
+Dx, Dy, Dz - components of translation vector;
+Apply - button to generate obstacle;
+Apply and Close - button to generate obstacle and close input panel;
+Close - button to close input panel. + + + \image html translate_obstacle_example.png "Translation of an obstacle example" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/undo_redo.doc b/doc/salome/gui/HYDRO/input/undo_redo.doc new file mode 100644 index 00000000..6ba9693b --- /dev/null +++ b/doc/salome/gui/HYDRO/input/undo_redo.doc @@ -0,0 +1,44 @@ + +/** + @file + \brief Help for the undo redo +*/ + +/** + \page undo_redo Undo/Redo actions + + Back to Main page. + + The HYDROGUI module supports two levels of Undo/Redo functionality:
    +
  • Global undo/redo
    + Global undo reverts last operation, redo performs latest undone operation (if there is any);
    • +
  • Local undo/redo - is available only for \ref create_profile "profiles" and \ref polyline "polylines" creation/edition
    • . +
+ + Global Undo operation can be executed via:
    +
  1. The main menu Edit => Undo;
    2. +
  2. Undo toolbar button;
    3. + + \image html undo_toolbar_button.png "Undo toolbar button" + +
  3. CTRL + Z buttons combination;
    4. +
  4. Selection of operations to be undone with help of Undo combo-box
    5. + + \image html undo_combo_box.png "Undo combo-box" +
+ + Global Redo operation can be executed via:
    +
  1. The main menu Edit => Redo;
    2. +
  2. Redo toolbar button;
    3. + + \image html redo_toolbar_button.png "Redo toolbar button" + +
  3. CTRL + Y buttons combination;
    4. +
  4. Selection of operations to be redone with help of Redo combo-box
    5. +
+ + \image html redo_combo_box.png "Redo combo-box" + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/input/update.doc b/doc/salome/gui/HYDRO/input/update.doc new file mode 100644 index 00000000..82f6f770 --- /dev/null +++ b/doc/salome/gui/HYDRO/input/update.doc @@ -0,0 +1,27 @@ + +/** + @file + \brief Help for the update object +*/ + +/** + \page update Update object(s) + +Note that objects update is not automatic in The HYDRO GUI project. + +For example, in the case when one of profiles used in Stream is changed, the Stream is marked as not updated in object browser. + +\image html not_updated_stream.png "Not updated stream in object browser" + + +The user starts the Update operation via context menu of NATURAL OBJECTS/Stream_1 in Object browser => Update. + +The Stream object is updated. If the Stream_1_bottom polyline exists, it is also updated together with parent stream. + + +\image html updated_stream.png "Updated stream in object browser" + + + Back to Main page. + +*/ diff --git a/doc/salome/gui/HYDRO/land_cover.h b/doc/salome/gui/HYDRO/land_cover.h deleted file mode 100644 index acd21e8f..00000000 --- a/doc/salome/gui/HYDRO/land_cover.h +++ /dev/null @@ -1,13 +0,0 @@ -/** - @file - \brief Help for the land cover -*/ - -/** - \page land_cover Land cover - - Back to Main page. - - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/load_script.h b/doc/salome/gui/HYDRO/load_script.h deleted file mode 100644 index 3ae2ccb1..00000000 --- a/doc/salome/gui/HYDRO/load_script.h +++ /dev/null @@ -1,27 +0,0 @@ - -/** - @file - \brief Help for the load script -*/ - -/** - \page load_script Load script - - Back to Main page. - - The HYDROGUI module supports loading Python scripts. This operation can be called via:
    -
  1. The main menu File => Load script;
    2. -
  2. CTRL + T buttons combination;
    3. -
- - - Load python script dialog box looks like: - - \image html load_python_script_dialog_box.png "Load python script dialog box" - - When script loading is done, according message appears in Python console. In case of problems during loading, error appears in Python console. - - \image html python_console.png "Python console" - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/local_cs.h b/doc/salome/gui/HYDRO/local_cs.h deleted file mode 100644 index 1c537c37..00000000 --- a/doc/salome/gui/HYDRO/local_cs.h +++ /dev/null @@ -1,31 +0,0 @@ - -/** - @file - \brief Help for the local CS -*/ - -/** - \page local_cs Local CS - - Back to Main page. - - The HYDROGUI module allows the user to change local coordinate system to avoid big numbers with Lambert 93 coordinates.
- For this Local CS transformation input panel should be called via:
    -
  • The main menu HYDRO => Change local CS;
    • -
  • Context menu of HYDRO in Object browser => Change local CS.
    • -
-Local CS transformation input panel looks like: - - \image html local_cs_transformation_input_panel.png "Local CS transformation input panel" - - Arguments of the input panel:
- - LX - spin-box to define value of OX in local CS;
- LY - spin-box to define value of OY in local CS.
- Apply - button to transform local coordinate system;
- Apply and Close - button to transform local coordinate system and close input panel;
- Close - button to close input panel. - -Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/mainpage.h b/doc/salome/gui/HYDRO/mainpage.h deleted file mode 100644 index f57f0673..00000000 --- a/doc/salome/gui/HYDRO/mainpage.h +++ /dev/null @@ -1,88 +0,0 @@ - -/** - @file - \brief Help for the main page of the HYDROGUI module -*/ - -/** - @mainpage - - The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company - in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc). - It represents a pre-processor for the geometry modelling of the natural and artificial objects on the landscape. - The user starts work with raster maps where he can create analytic curves and regions describing the existing natural objects, - such as banks, coasts, lakes, rivers etc. Also he can create artificial objects (channel, dam) using the algorithms of the geometry modelling. - The objects are referenced to the real territory using the geodesic coordinates. - Finally the constructed landscape study is prepared for the further meshing and using in the hydrodynamic solvers. - - The HYDRO module is implemented on the base of the SALOME platform and powered by the OpenCascade and SALOME platforms. - - It supports the following features: - - raster maps (import from files and georeferencement by geodesic coordinates); - - geometry curves (creation on the map and import from SALOME GEOM module); - - geometry objects (creation and import from SALOME GEOM module); - - support of natural objects (immersible zones, lakes, rivers) and artificial objects (obstacles, channels, dams); - - georeferencement of the objects when the objects are connected with points on real territory using the geodesic coordinates; - - geometry algorithms on analytic objects (extrusion, partition) for complex objects construction; - - support of the results of the territory level measurement (bathymetry); - - partition of objects on zones of intersection and specifying the properties for these zones; - - In the perspective the pre-processor can be completed by the post-processor showing the calculated results. - - The HYDROGUI module supports the following objects: - - \ref imzone "Immersible zone" - - \ref p_profile "Profile" - - \ref create_profile "Create profile" - - \ref import_profile "Import profile" - - \ref georeferencement_profile "Profile georeferencement" - - \ref art_digue "Digue" - - \ref art_channel "Channel" - - \ref obstacle "Obstacle" - - \ref box_obstacle "Create Box obstacle" - - \ref cylinder_obstacle "Create Cylinder obstacle" - - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY" - - \ref import_obstacle "Import obstacle from file" - - \ref translate_obstacle "Translation of an obstacle" - - - - \ref polyline3d "Polyline 3D" - - \ref polyline "Polyline" - - \ref export_polyline "Export polyline" - - \ref import_polyline "Import polyline" - - \ref bathymetry "Bathymetry" - - \ref strickler_table "Strickler table" - - \ref export_strickler_table "Export strickler table" - - \ref import_strickler_table "Import strickler table" - - \ref stream "Stream" - - \ref impimage "Find bottom" - - \ref profilesinterpolation "Profiles interpolation" - - \ref image "Image" - - \ref impimage "Import image" - - \ref fuseimages "Fuse images" - - \ref cutimages "Cut images" - - \ref splitimage "Split image" - - \ref calculation_case "Calculation case" - -The HYDROGUI module supports the following \ref general_services "services":
- - - - \ref general_services "General services" - - \ref preferences "Preferences" - - \ref save "Save file" - - \ref open "Open file" - - \ref dump_study "Dump study" - - \ref load_script "Load script" - - \ref undo_redo "Undo/Redo actions" - - \ref copy_paste "Copy/Paste object(s)" - - \ref delete "Delete object(s)" - - \ref color "Color object" - - \ref show_hide "Show/Hide object(s)" - - \ref update "Update object" - - \ref rename "Rename object" - - \ref submersible "Submersible" - - \ref copy_position "Copy position" - - \ref change_layer_order "Change layer order" - - \ref local_cs "Local CS" - - -*/ diff --git a/doc/salome/gui/HYDRO/obstacle.h b/doc/salome/gui/HYDRO/obstacle.h deleted file mode 100644 index 3a2d2833..00000000 --- a/doc/salome/gui/HYDRO/obstacle.h +++ /dev/null @@ -1,29 +0,0 @@ - -/** - @file - \brief Help for the obstacle -*/ - -/** - \page obstacle Obstacle - - Back to Main page. - - In the HYDROGUI module obstacle is 3D object created in or imported from Geometry module or from external file. - - - The HYDROGUI module supports the following techniques of obstacles creation: - - - - \ref box_obstacle "Create Box obstacle" - - \ref cylinder_obstacle "Create Cylinder obstacle" - - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY" - - \ref import_obstacle "Import obstacle from file" - - \ref translate_obstacle "Translation of an obstacle" - - The obstacle is presented as the 2D face and 3D object. - \image html box_presentation.png "Box obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/open_file.h b/doc/salome/gui/HYDRO/open_file.h deleted file mode 100644 index 7e0c9807..00000000 --- a/doc/salome/gui/HYDRO/open_file.h +++ /dev/null @@ -1,38 +0,0 @@ - -/** - @file - \brief Help for the open file -*/ - -/** - \page open Open file - - Back to Main page. - - The HYDROGUI module supports opening documents. This operation can be called via:
    -
  1. The main menu File => Open;
    2. -
  2. CTRL + O buttons combination;
    3. -
  3. Open document toolar button.
    4. - \image html open_document_toolbar_button.png "Open document toolbar button" -
- - In case if there is an active study in the session, Close active study warning appears: - \image html close_active_study_warning.png "Close active study warning" - - Save & Close - button to save active study and open new file;
- Close w/o saving - button to ingore saving active study and open new file;
- Cancel - button to reject opening new file.br> - - Open file dialog box looks like: - \image html open_file_dialog_box.png "Save file dialog box" - - Supported format: .HDF
- - Additionally, Reopen file operation is supported. It can be called from the main menu File => Reopen. After that dialog box appears, clarifying the user's desire to reopen document: - \image html reopen_file_dialog_box.png "Reopen file dialog box" - - Yes - button to reopen file and lost all not saved data;
- No - button to reject reopening.
- - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/polyline.h b/doc/salome/gui/HYDRO/polyline.h deleted file mode 100644 index 9784226d..00000000 --- a/doc/salome/gui/HYDRO/polyline.h +++ /dev/null @@ -1,101 +0,0 @@ - -/** - @file - \brief Help for the polyline -*/ - -/** - \page polyline Polyline - - Back to Main page. - - The polyline creation is available only in the OCC viewer. - - Create polyline input panel can be opened via:
    -
  1. The main menu HYDRO => Create polyline; -
  2. Context menu of POLYLINES in Object browser => Create polyline; -
  3. Create polyline toolar button.\image html create_polyline_toolbar_button.png "Create polyline toolbar button" -
- - Arguments of the input panel: - - \image html create_polyline_input_panel.png "Create polyline input panel" - - Name - field to define the polyline name;
- Apply - button to create polyline;
-Apply and Close - button to create polyline and close input panel;
-Close - button to close input panel.
- The polyline creation starts by creation of one or several sections. For adding new section it's necessary to click Insert new section button. \image html insert_new_section_button.png "Insert new section toolbar button" - - Add element panel is necessary to define parameters of section. - - \image html add_element_panel.png "Add element panel" - - Name - field to define the section name;
- Type - combo-box to define type of section: Polyline or Spline;
- Closed - if this checkbox is OFF, new section will be open. If checkbox is ON, new section will be closed;
- Add - button to add new section into the list.
- - A polyline may include several sections not connected with each other. - - 3 modes are available for work with points:
    -
  1. Addition mode

    2. - In this mode only point’s creation is available. Can be activated by Addition mode button clicking.
    \image html addition_mode_button.png "Addition mode toolbar button" - Each time when user clicks left mouse button in the viewer a new point is created (the plane X,Y, i.e. Z = 0 should be used for coordinates obtaining). The point is added always to the end of points list. - Note that addition of points is performed always to the current (selected) section of the polyline. User should select in the dialog box another section to start points addition to it. -
  2. Modification mode

    3. - In this mode the user can edit the built sections and points of the polyline. Can be activated by Modification mode button clicking.
    \image html modification_mode_button.png "Modification mode toolbar button" -
      -
    • When user selects a point (or several points) in viewer, its coordinates are shown in the input panel in the table, so the user can change it directly using table cell widgets;
      • -
    • When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position; the new point is inserted between segment tail points;
      • -
    • When user selects one or several points in viewer, he can activate the “drag-n-drop” mode (holding the mouse left button) to move all selected points inside the plane X, Y;
      • -
    • The rectangular and additive (holding Ctrl button) selections should be available for points;
      • -
    • User can remove points selecting one or several points and pressing “Delete” on keyboard or calling the popup menu and clicking on operation “Delete”.
      • -
    - \image html modif_mode_table.png "Table with coordinates" -
  3. Detection mode

    4. - TO BE UPDATED -
- - Another operations are available during creation/edition of polyline:
    -
  • Undo

    • - Undoes last action. - \image html undo_button.png "Undo toolbar button" -
  • Redo

    • - Redoes last undoing. - \image html redo_button.png "Redo toolbar button" -
  • Remove

    • - Can be called by Remove button clicking. - \image html remove_button.png "Remove toolbar button" - Removes selected section(s) if no mode is activated.
    - Removes selected points if modification mode is activated.
    -
  • Join selected sections

    • - Can be called with help of:
      -
    • Join selected sections toolbar button, if 2 or more selected sections are selected in the list
      • ;
      - \image html join_selected_sections_button.png "Join selected sections toolbar button" -
    • Join command, called from context menu of 2 or more selected sections
      • ;
      -
    - Joines sections selected in the list inside Sections area, creating one section. -
  • Join all sections

    • - Can be called with help of Join all sections command from context menu inside Sections area.
    - Joines all existing sections, having creating one section having type closed polyline.
    -
  • Clear all

    • - Can be called only if modification mode is activated from context menu inside Sections area.
    -
  • Set closed

    • - Can be called only if modification mode is activated from context menu of selected section(s).
    - Modifies selected section into closed. -
  • Set open

    • - Can be called only if modification mode is activated from context menu of selected section(s).
    - Modifies selected section into open. -
  • Set polyline

    • - Can be called only if modification mode is activated from context menu of selected section(s).
    - Modifies selected section into polyline. -
  • Set spline

    • - Can be called only if modification mode is activated from context menu of selected section(s).
    - Modifies selected section into spline. -
- - Additionally, the HYDROGUI module supports \ref export_polyline "export" and \ref import_polyline "import polyline". - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/polyline3d.h b/doc/salome/gui/HYDRO/polyline3d.h deleted file mode 100644 index a2ed3e46..00000000 --- a/doc/salome/gui/HYDRO/polyline3d.h +++ /dev/null @@ -1,39 +0,0 @@ - -/** - @file - \brief Help for the polyline 3d -*/ - -/** - \page polyline3d Polyline 3D - - Back to Main page. - -The polyline 3D object is used as guide line for creation of channel or digue.
-Creation of polyline 3D is available only in the OCC viewer.
- Create polyline 3D input panel can be opened via:
    -
  1. The main menu HYDRO => Create polyline 3D; -
  2. Context menu of POLYLINES 3D in Object browser => Create polyline 3D; -
  3. Create polyline 3D toolar button.\image html create_polyline_3d_toolbar_button.png "Create polyline 3D toolbar button" -
- - Arguments of the input panel: - - \image html create_polyline_3d_input_panel.png "Create polyline 3D input panel" - -Name - field for defining the name of polyline 3D;
-Apply - button to create polyline 3D;
-Apply and Close - button to create polyline 3D and close input panel;
-Close - button to close input panel.
- -Following parameters have to be defined to create polyline 3d object:
    -
  • Polyline
    • - any polyline object can be selected in this field; -
  • Profile or Bathymetry - one of this fields should be filled by any profile or bathymetry accordingly.
    • -
- -Example:
- -\image html polyline_3d_example.png "Polyline 3D example" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/preferences.h b/doc/salome/gui/HYDRO/preferences.h deleted file mode 100644 index dc5a065a..00000000 --- a/doc/salome/gui/HYDRO/preferences.h +++ /dev/null @@ -1,64 +0,0 @@ - -/ -/** - @file - \brief Help for the HYDRO module Preferences -*/ - -/** - \page preferences Preferences - - Back to Main page - - - Salome application supports Preferences. The Preferences dialog box can be called via:
    - -
  1. The main menu File => Preferences;
    2. - -
  2. CTRL + R buttons combination.
    3. - -
- - - - Preferences dialog box appears. Help for all sections of Preferences dialog box except HYDRO can be found in Introduction to Salome platform. - -The user selects HYDRO in Available preferences section: - - - - \image html preferences.png "Preferences dialog box" - - - - Controls inside Preferences dialog box: - - -Type - combo - box to select the cursor presentation for edition operation;
- -\image html preferences_type.png "Type combo-box in Preferences dialog box" - - -Make automatic fit all after show object operation - check - box swith on/off Fit all;
-Default Strickler coefficient field is used for Strickler coefficient asigned to area not covered by land cover or land cover with undefined type;
-OK - button to validate changes and close dialog box;
-Apply - button to validate changes;
-Defaults - button to restore default values in all fields;
-Close - button to close dialog box;
-Import - button to import Preferences from external xml file. - - The user clicks Import button. Import preferences dialog box appears: - -\image html preferences_import.png "Import preferences dialog box" - - - -The user selects folder in Look in filed and desired file in this folder. - -The user clicks Open button. - -Import preferences dialog box is closed. Prefernces are updated. - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/profile.h b/doc/salome/gui/HYDRO/profile.h deleted file mode 100644 index a51466e2..00000000 --- a/doc/salome/gui/HYDRO/profile.h +++ /dev/null @@ -1,48 +0,0 @@ - -/** - @file - \brief Help for profile -*/ - -/** - \page p_profile Profile - - Back to Main page. - -The profile is used for definition of a stream cross-section or as a base of extrusion to generate a channel or digue. - -The 2D profiles are built/defined in a 2D space (U, Z). The coordinate U is parametric coordinate, it has no unit. The coordinate Z is real altitude (in meters). - -To build 2D profile Use function - - - \ref create_profile "Create profile". - - - -2D profile object is internal data model object and can not be shown in OCC viewer. 2D profile names are colored in red in object browser. - - - -Created 2D profiles should be positioned in 3D space using Georeferencement to be converted into 3D profiles: - -- \ref georeferencement_profile "Profile georeferencement". - - -3D profile is 3D wire describing profile curve in 3d space. -3D profile names are colored in black in object browser. - - -Both 2D and 3D profiles can be imported from external file: - - - \ref import_profile "Import profile" - - Back to Main page. - -*/ - - - - - - - diff --git a/doc/salome/gui/HYDRO/profile_interpolation.h b/doc/salome/gui/HYDRO/profile_interpolation.h deleted file mode 100644 index 7bc9a058..00000000 --- a/doc/salome/gui/HYDRO/profile_interpolation.h +++ /dev/null @@ -1,45 +0,0 @@ - -/** - @file - \brief Help for the find bottom -*/ - -/** - \page profilesinterpolation Profiles interpolation - - Back to Main page. - - Profiles interpolation operation builds additional profiles to get more detailed river bed. - - Profiles interpolation input panel can be opened via:
    -
  1. The main menu HYDRO => Stream => Profiles interpolation; -
  2. Context menu of Stream object in Object browser - Profiles interpolation;
    3. -
- - Profiles interpolation input panel looks like: - - \image html profiles_interpolation_input_panel.png "Profiles interpolation input panel" - - Arguments of the input panel:
- -Stream object - combo-box to define reference stream object;
-Interpolator - combo-box to define interpolation algorithm used. Currently only linear interpolation is accessible;
-Description - field, describing interpolation method's features;
-Profile 1 - combo-box to define profile, which will be the start of interpolation;
-Profile 1 - combo-box to define profile, which will be the end of interpolation;
-Number of profiles - spin-box to define the quantity of profiles which will be created;
-Parameters - field to set additional interpolation parameters (name as string, value as string):
    -
  • complete line of parameters should be input by user as a single text line and it should be parsed by spaces i.e. for example “len 5 hypothesis linear” will give additional parameters “len” = “5”; “hypothesis” = “linear”;
    • -
  • the sense of such parameters depends on the interpolator implementation;
    • -
  • parameters are passed to interpolator by several calls of “set” function (for each pair name, value);
    • -
-Apply - button to build stream's bottom;
-Apply and Close - button to build stream's bottom and close input panel;
-Close - button to close input panel. - -The input panel built-in viewer shows profiles from selected reference stream object and profiles to be created during interpolation. The existing profiles are shown as black curves, the new profiles – as red curves: - -\image html profile_interpolation_preview.png "Profile interpolation preview" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/rename.h b/doc/salome/gui/HYDRO/rename.h deleted file mode 100644 index 80619d68..00000000 --- a/doc/salome/gui/HYDRO/rename.h +++ /dev/null @@ -1,20 +0,0 @@ - -/** - @file - \brief Help for the rename object -*/ - -/** - \page rename Rename object - - Back to Main page. - - It is possible to rename any object in HYDROGUI module.
- - Following ways are available for starting this action:
    -
  1. Select object and push F2 button;
    2. -
  2. Select object, call context menu and call Rename button;
    3. -
  3. Double click on interesting object.
    4. -
- -*/ diff --git a/doc/salome/gui/HYDRO/save_file.h b/doc/salome/gui/HYDRO/save_file.h deleted file mode 100644 index cb09d80b..00000000 --- a/doc/salome/gui/HYDRO/save_file.h +++ /dev/null @@ -1,28 +0,0 @@ - -/** - @file - \brief Help for the save file -*/ - -/** - \page save Save file - - Back to Main page. - - The HYDROGUI module supports saving documents in .HDF format. This operation can be called via:
    -
  1. The main menu File => Save;
    2. -
  2. CTRL + S buttons combination;
    3. -
  3. CTRL + SHIFT + S buttons combination for Save As... operation;
    4. -
  4. Save document toolar button.
    5. - \image html save_document_toolbar_button.png "Save document toolbar button" -
- - Save file dialog box looks like: - \image html save_file_dialog_box.png "Save file dialog box" - - - In case if the user tries to save document with name already used, warning appears, suggested overwriting existing file : - \image html save_file_warning.png "Warning" - - Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/show_hide.h b/doc/salome/gui/HYDRO/show_hide.h deleted file mode 100644 index 9a0090be..00000000 --- a/doc/salome/gui/HYDRO/show_hide.h +++ /dev/null @@ -1,31 +0,0 @@ - -/** - @file - \brief Help for the show/hide object -*/ - -/** - \page show_hide Show/hide object(s) - - Back to Main page:
- - \ref general_services "Back to general services" - - It is possible to show and hide objects in the viewer in HYDROGUI module.
- - The user can show object(s) via the following commands:
    -
  1. Show all
    2. - shows all objects. Can be executed from context menu called from viewer or Object browser; -
  2. Show
    3. - shows selected objects. Can be executed from context menu of selected objects; -
  3. Show only
    4. - shows selected objects and hides already shown objects. Can be executed from context menu of selected objects; -
  4. Eye icon
    5. - locates in Object browser near every object. Just click on it to show object, if it is hidden. - - \image html eye_icons.png "Eye icons of shown and hidden objects" -
- - The user can hide object(s) via the following commands:
    -
  1. Hide all
    2. - hides all objects. Can be executed from context menu called from viewer or Object browser; -
  2. Hide
    3. - hides selected objects. Can be executed from context menu of selected objects; -
  3. Eye icon
    4. - locates in Object browser near every object. Just click on it to hide object, if it is shown. -
- -*/ diff --git a/doc/salome/gui/HYDRO/split_image.h b/doc/salome/gui/HYDRO/split_image.h deleted file mode 100644 index 3d1de565..00000000 --- a/doc/salome/gui/HYDRO/split_image.h +++ /dev/null @@ -1,34 +0,0 @@ - -/** - @file - \brief Help for the split image -*/ - -/** - \page splitimage Split image - - Back to Main page. - -The user can start Split image operation via:
    -
  1. The main menu HYDRO - Split image; -
  2. Context menu of any image in Object browser - Split image; -
  3. Split image toolbar button \image html split_image_toolbar_button.png "Split image toolbar button" -
- Arguments of the input panel: - \image html split_image_input_panel.png "Split image input panel" - -Name - field for defining the name of image after cut;
-Modify selected image - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified.
-Image - field for defining the reference image to be split;
-Polyline - field for defining the the tool for split. Only closed polylines can be selected in this field;
-Apply - button to create split image object;
-Apply and Close - button to create split image object and close input panel;
-Close - button to close input panel.
- -Also, it's possible to change background color of split image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. - - \image html select_color.png "Select color dialog box" - -Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/static/footer.html b/doc/salome/gui/HYDRO/static/footer.html new file mode 100644 index 00000000..e69de29b diff --git a/doc/salome/gui/HYDRO/static/header.html b/doc/salome/gui/HYDRO/static/header.html new file mode 100644 index 00000000..e69de29b diff --git a/doc/salome/gui/HYDRO/static/salome_extra.css b/doc/salome/gui/HYDRO/static/salome_extra.css new file mode 100644 index 00000000..3e8b838a --- /dev/null +++ b/doc/salome/gui/HYDRO/static/salome_extra.css @@ -0,0 +1,29 @@ +/* The extra CSS for doxygen 1.8.3.1 */ + +#titlearea { + background-image:url('head.png'); + background-color: #175783; + border: 1px solid; + height: 80px; + background-repeat: no-repeat; + padding: 0px; + margin: 0px; + width: 99.9%; + border-bottom: 1px solid #5373B4; +} + +div.version { + border:1px solid #0000FF; + color: #CCCCCC; + font-family: Arial, Helvetica, sans-serif; + font-size: 9pt; + text-align: center; + width:100px; + -moz-border-radius: 8px; + margin: 5px; +} + +.navpath li.footer { + line-height:15px; + text-align: right; +} \ No newline at end of file diff --git a/doc/salome/gui/HYDRO/stream.h b/doc/salome/gui/HYDRO/stream.h deleted file mode 100644 index 0db796e7..00000000 --- a/doc/salome/gui/HYDRO/stream.h +++ /dev/null @@ -1,54 +0,0 @@ - -/** - @file - \brief Help for the stream -*/ - -/** - \page stream Stream - - Back to Main page. - - Stream is a natural object simulating the river bed. - - Create stream input panel can be opened via:
    -
  1. The main menu HYDRO => Stream => Create stream; -
  2. Context menu of NATURAL OBJECTS in Object browser => Create stream; -
  3. Create steam toolar button.\image html create_stream_toolbar_button.png "Create stream toolbar button" -
- - Arguments of the input panel: - - \image html create_stream_input_panel.png "Create stream input panel" - -Name - field to define the stream name;
-Polyline - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.
-Hydraulic axis - combo - box to select the polyline, which is hydraulic axis of the river. Rules are following:
    -
  • Polyline should be open;
    • -
  • Polyline should consist from one section only;
    • -
  • Polyline cannot be self-intersected or contain sharp angles, which can lead to self-intersections in resulting shell.
    • -
-Apply - button to generate stream;
-Apply and Close - button to generate stream and close input panel;
-Close - button to close input panel.
- -Also it's necessary to add profiles into the list. For this select one/several profiles objects in the object browser and click the button Add. The rules are following:
    -
  1. Invalid (not positioned) profiles can not be added; they are simply ignored;
    2. -
  2. Profile can not be added several times to the list; such profiles are simply ignored;
    3. -
  3. Each added profile should intersect with the selected hydraulic axis; if for certain profile does not intersect, it is ignored.
    4. -
-It's possible to remove added profiles from the list. For this select profile(s) in the list and click Remove button.
- -Generated stream object contains 3D object, simulating the river bed, and its projection on XY plane, which is used for calculation.
- -Following operations are available with stream: - - \ref findbottom "Find bottom" - - \ref profilesinterpolation "Profiles interpolation" - -Examples:
- -\image html stream_3d_example.png "Stream 3D example" -\image html stream_2d_example.png "Stream 2D example" - -Back to Main page. -*/ diff --git a/doc/salome/gui/HYDRO/strickler_table.h b/doc/salome/gui/HYDRO/strickler_table.h deleted file mode 100644 index 305c2249..00000000 --- a/doc/salome/gui/HYDRO/strickler_table.h +++ /dev/null @@ -1,13 +0,0 @@ - -/** - @file - \brief Help for the strickler table -*/ - -/** - \page strickler_table Strickler table - - Back to Main page. - - -*/ diff --git a/doc/salome/gui/HYDRO/submersible.h b/doc/salome/gui/HYDRO/submersible.h deleted file mode 100644 index c799cf73..00000000 --- a/doc/salome/gui/HYDRO/submersible.h +++ /dev/null @@ -1,21 +0,0 @@ - -/** - @file - \brief Help for the submersible -*/ - -/** - \page submersible Submersible - - Back to Main page. - - Objects in HYDROGUI module have Submersible mark.
- - Regions, created basing on submersible objects are included in final geometry during export calculation case. Regions, created basing on not submersible objects are excluded from final geometry.
- - It is possible to define, is submersible the object or not, with help of its context menu and according command. - -\image html submersible.png "Submersible context menu command" - - -*/ diff --git a/doc/salome/gui/HYDRO/translate_obstacle.h b/doc/salome/gui/HYDRO/translate_obstacle.h deleted file mode 100644 index 7501d327..00000000 --- a/doc/salome/gui/HYDRO/translate_obstacle.h +++ /dev/null @@ -1,36 +0,0 @@ - -/** - @file - \brief Help for translate obstacle operation -*/ - -/** - \page translate_obstacle - - Back to Main page. - - An obstacle can be copied and translated in the HYDROGUI module. - - - The Translation of an obstacle operation can be started via Context menu of obstacle object in Object browser - Translate. - - - - Translation of an obstacle input panel appears. - - \image html translate_obstacle_input_panel.png " Translation of an obstacle input panel" - -Arguments of the input panel: - -Name - uneditable field containing the initial obstacle name;
-Dx, Dy, Dz - components of translation vector;
-Apply - button to generate obstacle;
-Apply and Close - button to generate obstacle and close input panel;
-Close - button to close input panel. - - - \image html translate_obstacle_example.png "Translation of an obstacle example" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/undo_redo.h b/doc/salome/gui/HYDRO/undo_redo.h deleted file mode 100644 index 6ba9693b..00000000 --- a/doc/salome/gui/HYDRO/undo_redo.h +++ /dev/null @@ -1,44 +0,0 @@ - -/** - @file - \brief Help for the undo redo -*/ - -/** - \page undo_redo Undo/Redo actions - - Back to Main page. - - The HYDROGUI module supports two levels of Undo/Redo functionality:
    -
  • Global undo/redo
    - Global undo reverts last operation, redo performs latest undone operation (if there is any);
    • -
  • Local undo/redo - is available only for \ref create_profile "profiles" and \ref polyline "polylines" creation/edition
    • . -
- - Global Undo operation can be executed via:
    -
  1. The main menu Edit => Undo;
    2. -
  2. Undo toolbar button;
    3. - - \image html undo_toolbar_button.png "Undo toolbar button" - -
  3. CTRL + Z buttons combination;
    4. -
  4. Selection of operations to be undone with help of Undo combo-box
    5. - - \image html undo_combo_box.png "Undo combo-box" -
- - Global Redo operation can be executed via:
    -
  1. The main menu Edit => Redo;
    2. -
  2. Redo toolbar button;
    3. - - \image html redo_toolbar_button.png "Redo toolbar button" - -
  3. CTRL + Y buttons combination;
    4. -
  4. Selection of operations to be redone with help of Redo combo-box
    5. -
- - \image html redo_combo_box.png "Redo combo-box" - - Back to Main page. - -*/ diff --git a/doc/salome/gui/HYDRO/update.h b/doc/salome/gui/HYDRO/update.h deleted file mode 100644 index 82f6f770..00000000 --- a/doc/salome/gui/HYDRO/update.h +++ /dev/null @@ -1,27 +0,0 @@ - -/** - @file - \brief Help for the update object -*/ - -/** - \page update Update object(s) - -Note that objects update is not automatic in The HYDRO GUI project. - -For example, in the case when one of profiles used in Stream is changed, the Stream is marked as not updated in object browser. - -\image html not_updated_stream.png "Not updated stream in object browser" - - -The user starts the Update operation via context menu of NATURAL OBJECTS/Stream_1 in Object browser => Update. - -The Stream object is updated. If the Stream_1_bottom polyline exists, it is also updated together with parent stream. - - -\image html updated_stream.png "Updated stream in object browser" - - - Back to Main page. - -*/