[artoolkit-commits] artoolkit/include/AR arMulti.h,1.2,1.3

[Philip L. <phi...@us...>]

Update of /cvsroot/artoolkit/artoolkit/include/AR
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11265

Modified Files:
	arMulti.h 
Log Message:
Documentation fixes.

Index: arMulti.h
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/include/AR/arMulti.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** arMulti.h	22 Nov 2004 02:11:05 -0000	1.2
--- arMulti.h	23 Aug 2005 18:21:15 -0000	1.3
***************
*** 25,29 ****
  *   Rev		Date		Who		Changes
  *
! *----------------------------------------------------------------------------*/
  
  #ifndef AR_MULTI_H
--- 25,29 ----
  *   Rev		Date		Who		Changes
  *
! *----------------------------------------------------------------------------*/
  
  #ifndef AR_MULTI_H
***************
*** 33,39 ****
  #endif
  
! // ============================================================================
! //	Public includes.
! // ============================================================================
  
  #include <stdio.h>
--- 33,39 ----
  #endif
  
! // ============================================================================
! //	Public includes.
! // ============================================================================
  
  #include <stdio.h>
***************
*** 42,62 ****
  #include <AR/ar.h>
  
! // ============================================================================
! //	Public types and defines.
! // ============================================================================
! 
! 	/** \struct ARMultiEachMarkerInfoT
! * \brief multi-marker structure
! *
! * Structure for multi-marker tracking
! * really similar to ARMarkerInfo
! * \param patt_id identification of the pattern
! * \param width width of the pattern (in mm)
! * \param center center of the pattern (in mm)
! * \param trans estimated position of the pattern
! * \param itrans relative position of the pattern
! * \param pos3d final position of the pattern
! * \param visible boolean flag for visibility
! * \param visibleR last state visibility
  */
  typedef struct {
--- 42,62 ----
  #include <AR/ar.h>
  
! // ============================================================================
! //	Public types and defines.
! // ============================================================================
! 
! 	/** \struct ARMultiEachMarkerInfoT
! * \brief multi-marker structure
! *
! * Structure for multi-marker tracking
! * really similar to ARMarkerInfo
! * \param patt_id identification of the pattern
! * \param width width of the pattern (in mm)
! * \param center center of the pattern (in mm)
! * \param trans estimated position of the pattern
! * \param itrans relative position of the pattern
! * \param pos3d final position of the pattern
! * \param visible boolean flag for visibility
! * \param visibleR last state visibility
  */
  typedef struct {
***************
*** 72,85 ****
  } ARMultiEachMarkerInfoT;
  
! /** \struct ARMultiMarkerInfoT
! * \brief global multi-marker structure
! *
! * Main structure for multi-marker tracking.
! * 
! * \param marker list of markers of the multi-marker pattern
! * \param marker_num number of markers used
! * \param trans position of the multi-marker pattern (more precisely, the camera position in the multi-marker CS)
! * \param prevF boolean flag for visibility
! * \param transR last position
  */
  typedef struct {
--- 72,85 ----
  } ARMultiEachMarkerInfoT;
  
! /** \struct ARMultiMarkerInfoT
! * \brief global multi-marker structure
! *
! * Main structure for multi-marker tracking.
! * 
! * \param marker list of markers of the multi-marker pattern
! * \param marker_num number of markers used
! * \param trans position of the multi-marker pattern (more precisely, the camera position in the multi-marker CS)
! * \param prevF boolean flag for visibility
! * \param transR last position
  */
  typedef struct {
***************
*** 92,155 ****
  } ARMultiMarkerInfoT;
  
! // ============================================================================
! //	Public globals.
! // ============================================================================
! 
! // ============================================================================
! //	Public functions.
! // ============================================================================
! 
! /** \fn ARMultiMarkerInfoT *arMultiReadConfigFile( char *filename )
! * \brief loading multi-markers description from a file
! *
! * Load a configuration file for multi-markers tracking. The configuration
! * file furnishs pointer to each pattern description.
! *
! * \param filename name of the pattern file
! * \return a pattern structure, NULL if error
  */
  ARMultiMarkerInfoT *arMultiReadConfigFile( const char *filename );
  
! /** \fn double  arMultiGetTransMat(ARMarkerInfo *marker_info, int marker_num,
!                            ARMultiMarkerInfoT *config)
! * \brief compute camera position in function of the multi-marker patterns (based on detected markers)
! * 
! * calculate the transformation between the multi-marker patterns and the real camera. Based on 
! * confident values of detected markers in the multi-markers patterns, a global position is return.
! *
! * \param marker_info list of detected markers (from arDetectMarker)
! * \param marker_num number of detected markers
! * \param config 
! * \return 
  */
  double  arMultiGetTransMat(ARMarkerInfo *marker_info, int marker_num,
                             ARMultiMarkerInfoT *config);
  
! /** \fn int arMultiActivate( ARMultiMarkerInfoT *config )
! * \brief activate a multi-marker pattern on the recognition procedure.
! *
! * Activate a multi-marker for be checking during the template matching
! * operation.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiActivate( ARMultiMarkerInfoT *config );
  
! /** \fn int arMultiDeactivate( ARMultiMarkerInfoT *config )
! * \brief Desactivate a multi-marker pattern on the recognition procedure.
! *
! * Desactivate a multi-marker for not be checking during the template matching
! * operation.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiDeactivate( ARMultiMarkerInfoT *config );
! /** \fn arMultiFreeConfig( ARMultiMarkerInfoT *config )
! * \brief remove a multi-marker pattern from memory.
! *
! * desactivate a pattern and remove it from memory. Post-condition
! * of this function is unavailability of the multi-marker pattern.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiFreeConfig( ARMultiMarkerInfoT *config );
--- 92,155 ----
  } ARMultiMarkerInfoT;
  
! // ============================================================================
! //	Public globals.
! // ============================================================================
! 
! // ============================================================================
! //	Public functions.
! // ============================================================================
! 
! /**
! * \brief loading multi-markers description from a file
! *
! * Load a configuration file for multi-markers tracking. The configuration
! * file furnishs pointer to each pattern description.
! *
! * \param filename name of the pattern file
! * \return a pattern structure, NULL if error
  */
  ARMultiMarkerInfoT *arMultiReadConfigFile( const char *filename );
  
! /**
! * \brief compute camera position in function of the multi-marker patterns (based on detected markers)
! * 
! * calculate the transformation between the multi-marker patterns and the real camera. Based on 
! * confident values of detected markers in the multi-markers patterns, a global position is return.
! *
! * \param marker_info list of detected markers (from arDetectMarker)
! * \param marker_num number of detected markers
! * \param config 
! * \return 
  */
  double  arMultiGetTransMat(ARMarkerInfo *marker_info, int marker_num,
                             ARMultiMarkerInfoT *config);
  
! /**
! * \brief activate a multi-marker pattern on the recognition procedure.
! *
! * Activate a multi-marker for be checking during the template matching
! * operation.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiActivate( ARMultiMarkerInfoT *config );
  
! /**
! * \brief Desactivate a multi-marker pattern on the recognition procedure.
! *
! * Desactivate a multi-marker for not be checking during the template matching
! * operation.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiDeactivate( ARMultiMarkerInfoT *config );
! 
! /**
! * \brief remove a multi-marker pattern from memory.
! *
! * desactivate a pattern and remove it from memory. Post-condition
! * of this function is unavailability of the multi-marker pattern.
! * \param config pointer to the multi-marker
! * \return 0 if success, -1 if error
  */
  int arMultiFreeConfig( ARMultiMarkerInfoT *config );