Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv18991/src/libopenvrml/openvrml
Modified Files:
Tag: OpenVRML-0_16-BRANCH
viewer.cpp
Log Message:
Doc-comment improvements.
Index: viewer.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/viewer.cpp,v
retrieving revision 1.13.2.1
retrieving revision 1.13.2.2
diff -C2 -d -r1.13.2.1 -r1.13.2.2
*** viewer.cpp 6 Mar 2007 07:23:12 -0000 1.13.2.1
--- viewer.cpp 16 Apr 2007 05:05:14 -0000 1.13.2.2
***************
*** 1,3 ****
! // -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; -*-
//
// OpenVRML
--- 1,3 ----
! // -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 78 -*-
//
// OpenVRML
***************
*** 46,51 ****
* @var openvrml::browser * openvrml::viewer::browser_
*
! * @brief A pointer to the <code>browser</code> with which the
! * <code>viewer</code> is currently associated.
*/
--- 46,51 ----
* @var openvrml::browser * openvrml::viewer::browser_
*
! * @brief A pointer to the @c browser with which the @c viewer is currently
! * associated.
*/
***************
*** 136,145 ****
/**
! * @brief A pointer to the <code>browser</code> with which the
! * <code>viewer</code> is currently associated.
*
! * @return a pointer to the <code>browser</code> with which the
! * <code>viewer</code> is currently associated, or 0 if the
! * <code>viewer</code> is not associated with a <code>browser</code>.
*/
openvrml::browser * openvrml::viewer::browser() const OPENVRML_NOTHROW
--- 136,145 ----
/**
! * @brief A pointer to the @c browser with which the @c viewer is currently
! * associated.
*
! * @return a pointer to the @c browser with which the @c viewer is currently
! * associated, or 0 if the @c viewer is not associated with a
! * @c browser.
*/
openvrml::browser * openvrml::viewer::browser() const OPENVRML_NOTHROW
***************
*** 404,409 ****
*
* @param[in] color fog color.
! * @param[in] visibility_range the distance at which objects are fully obscured by
! * fog.
* @param[in] type fog type.
*/
--- 404,409 ----
*
* @param[in] color fog color.
! * @param[in] visibility_range the distance at which objects are fully
! * obscured by fog.
* @param[in] type fog type.
*/
***************
*** 522,531 ****
/**
! * Intersect the given bounding volume with the view volume. This
! * goes into the viewer to provide a hook for systems that use
! * non-standard view volumes. Most subclasses should be able to use
! * the default implementation provided here. If your view volume is
! * so strange that there's no way to cull to is, then reimplement to
! * always return bounding_volume::inside.
*
* @param[in] bvolume the bounding volume to intersect with the view volume.
--- 522,530 ----
/**
! * Intersect the given bounding volume with the view volume. This goes into
! * the viewer to provide a hook for systems that use non-standard view
! * volumes. Most subclasses should be able to use the default implementation
! * provided here. If your view volume is so strange that there's no way to
! * cull to is, then reimplement to always return @c bounding_volume::inside.
*
* @param[in] bvolume the bounding volume to intersect with the view volume.
***************
*** 539,548 ****
//
// For normal VRML97 use, this won't need to be overridden, but for
! // systems with non-standard view volumes, this can be changed to
! // cull as appropriate. Note that culling can be disabled by setting
! // a flag in rendering_context. Since I don't have access to the
! // appropriate cave/boom/whichever api's, I can't be sure that this
! // is enough. If it isn't, please express any concerns to the
! // OpenVRML developer's list, and it can be fixed...
//
return bvolume.intersect_frustum(this->frustum_);
--- 538,547 ----
//
// For normal VRML97 use, this won't need to be overridden, but for
! // systems with non-standard view volumes, this can be changed to cull as
! // appropriate. Note that culling can be disabled by setting a flag in
! // rendering_context. Since I don't have access to the appropriate
! // cave/boom/whichever api's, I can't be sure that this is enough. If it
! // isn't, please express any concerns to the OpenVRML developer's list,
! // and it can be fixed...
//
return bvolume.intersect_frustum(this->frustum_);
***************
*** 554,570 ****
* @brief Draw a bounding sphere.
*
! * Used for debugging view culling. Probably should be draw_bounding_volume and
! * handle axis_aligned_bounding_boxes as well.
*
* @param[in] bs a bounding sphere; if max, will not be drawn
! * @param[in] intersection one of the bvolume intersection test constants, or 4
! * to draw in unique way. (useful for debugging)
*/
/**
! * @todo We're forcing everybody to carry around a frustum
! * whether they want it or not. It shouldn't be used except
! * for debugging and stuff since it might not be valid in some
! * implementations
*
* @return the frustum.
--- 553,570 ----
* @brief Draw a bounding sphere.
*
! * Used for debugging view culling.
! *
! * @todo Probably should be draw_bounding_volume and handle
! * axis_aligned_bounding_boxes as well.
*
* @param[in] bs a bounding sphere; if max, will not be drawn
! * @param[in] intersection one of the bvolume intersection test constants, or
! * 4 to draw in unique way. (useful for debugging)
*/
/**
! * @todo We're forcing everybody to carry around a frustum whether they want
! * it or not. It shouldn't be used except for debugging and stuff since
! * it might not be valid in some implementations
*
* @return the frustum.
|
