diff --git a/Doc/Examples/nav_code_to_from.cc b/Doc/Examples/nav_code_to_from.cc new file mode 100644 index 00000000..48c0adec --- /dev/null +++ b/Doc/Examples/nav_code_to_from.cc @@ -0,0 +1,5 @@ +// Get the handle of the to vertex +OpenMesh::Concepts::KernelT::to_vertex_handle(); + +// Get the handle of the from vertex +OpenMesh::Concepts::KernelT::from_vertex_handle(); diff --git a/Doc/doxy.config.in b/Doc/doxy.config.in index 30383b80..fcbf6ca1 100644 --- a/Doc/doxy.config.in +++ b/Doc/doxy.config.in @@ -1,4 +1,4 @@ -# Doxyfile 1.8.6 +# Doxyfile 1.8.7 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -70,6 +70,14 @@ OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/Build/@ACG_PROJECT_DATADIR@/Doc CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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. @@ -263,9 +271,12 @@ OPTIMIZE_OUTPUT_VHDL = NO # 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, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. 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. +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. 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 For files without extension you can use no_extension as a placeholder. # @@ -1244,7 +1255,8 @@ GENERATE_CHI = NO CHM_INDEX_ENCODING = # 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. +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1484,11 +1496,11 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1776,6 +1788,13 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + # 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 @@ -1803,18 +1822,6 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify a XML DTD, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -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 @@ -1964,9 +1971,9 @@ PREDEFINED = DOXYGEN \ EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to function-like macros that are alone on a line, have an -# all uppercase name, and do not end with a semicolon. Such function macros are -# typically used for boiler-plate code, and will confuse the parser if not +# 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. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not # removed. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -1986,7 +1993,7 @@ SKIP_FUNCTION_MACROS = YES # where loc1 and loc2 can be relative or absolute paths or URLs. See the # section "Linking to external documentation" for more information about the use # of tag files. -# Note: Each tag file must have an unique name (where the name does NOT include +# Note: 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. @@ -2064,7 +2071,7 @@ HIDE_UNDOC_RELATIONS = YES # http://www.graphviz.org/), 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 value is: NO. +# The default value is: YES. HAVE_DOT = YES @@ -2216,7 +2223,9 @@ DIRECTORY_GRAPH = YES # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). -# Possible values are: png, jpg, gif and svg. +# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, +# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, +# gif:cairo:gd, gif:gd, gif:gd:gd and svg. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. diff --git a/Doc/images/mesh.to.from.png b/Doc/images/mesh.to.from.png new file mode 100644 index 00000000..1159b731 Binary files /dev/null and b/Doc/images/mesh.to.from.png differ diff --git a/Doc/images/src/mesh.to.from.tex b/Doc/images/src/mesh.to.from.tex new file mode 100644 index 00000000..95a99638 --- /dev/null +++ b/Doc/images/src/mesh.to.from.tex @@ -0,0 +1,29 @@ +\documentclass{minimal} + +% Tikz +\usepackage{pgf} +\usepackage{tikz} + +\begin{document} + +\begin{center} + \begin{tikzpicture} + [ + vertex/.style={draw=none,circle,fill=black,minimum size=2pt}, + oedge/.style={->,>=latex,shorten >=6pt,draw,black,thick}, + roedge/.style={->,>=latex,shorten >=6pt,draw,black,thick,color=red} + ] + +\coordinate (V1) at (-3,3); +\coordinate (V2) at (0,0); + +\path[oedge] ([yshift=3pt]V1) to ([yshift=3pt]V2) {}; +\path[oedge] ([yshift=-3pt]V2) to ([yshift=-3pt]V1) {}; + +\node[vertex] at (V1) {}; +\node[vertex] at (V2) {}; + +\end{tikzpicture} +\end{center} + +\end{document} diff --git a/Doc/navigation.docu b/Doc/navigation.docu index 53cee4ad..be6031c9 100644 --- a/Doc/navigation.docu +++ b/Doc/navigation.docu @@ -7,6 +7,7 @@ \li \ref nav_bound \li \ref nav_io \li \ref nav_opposite +\li \ref nav_to_from \section nav_intro Introduction @@ -98,4 +99,16 @@ There are also a few more functions that offer easy access to opposing structure \include nav_code4.cc + +\section nav_to_from Getting the to and from vertices + +\image html mesh.to.from.png + +If you have an halfedge, you can get the to and the from handles of the adjacent vertices. +\note The halfedges have a direction. Therefore the to vertex is the from vertex of the opposite halfedge and vice versa. + +\include nav_code_to_from.cc + + + */