FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changed the doxygen control characters and clarifications

Browse Source
This commit is contained in:
OpenSceneGraph git repository 2018-02-19 08:39:23 +00:00 committed by GitHub
parent f01383c02a
commit c52ae4f99f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
include/osg/ClusterCullingCallback
View File

@ -19,33 +19,32 @@
namespace osg { namespace osg {
/// /** @class ClusterCullingCallback
/// @class ClusterCullingCallback @brief Implements cluster culling to cull back facing subgraphs and drawables. Derived from Drawable::CullCallback and osg::NodeCallback.
/// @brief Implements cluster culling to cull back facing drawables. Derived from Drawable::CullCallback.
/// This culling callback is intended to be attached to a node using the setCullCallback method. If the
/// This culling callback is intended to be attached to a node using the setCullCallback method. If the node is a drawable cull(osg::NodeVisitor*, osg::Drawable*, osg::State*) otherwise
/// node is a drawable cull(osg::NodeVisitor*, osg::Drawable*, osg::State*) otherwise operator()(Node*, NodeVisitor*) will be called during the cull traversal.
/// operator()(Node*, NodeVisitor*) will be called during the cull traversal.
/// To decide whether the node (in case of a drawable) or its children (in case of any other node type) are
/// To decide whether the node (in case of a drawable) or its children (in case of any other node type) are to be culled depends on four parameters:
/// to be culled depends on four parameters: - a control point,
/// - a control point, - a normal specified at the control point,
/// - a normal specified at the control point, - a deviation value representing the cosinus of an enclosed angle and
/// - a deviation value representing the cosinus of an enclosed angle and - a radius describing a sphere around the control point.
/// - a radius describing a sphere around the control point.
/// The node is culled if the following two conditions are fulfilled:
/// The node is culled if the following two conditions are fulfilled: - the distance between the current eye/view point to the control point is larger or equal to radius,
/// - the distance between the current eye/view point to the control point is larger or equal to radius, - the cosinus of the enclosed angle between the normal and the vector from the control point to the eye/view point
/// - the cosinus of the enclosed angle between the normal and the vector from the control point to the eye/view point is smaller(!) than the specified deviation value (normally this value is negative meaning that the enclosed angle
/// is smaller(!) than the specified deviation value (normally this value is negative meaning that the enclosed angle between the control point and the eye/view point is larger than the angle indirectly specified by the
/// between the control point and the eye/view point is larger than the angle indirectly specified by the deviation value).
/// deviation value).
/// @remark As the deviation is representing the cosine of an enclosed angle its value should be within the
/// @remark As the deviation is representing the cosinus of an enclosed angle its value should be within the the interval [-1; 1]. A value of one will cull all nodes while a value of -1 will never cull a node.
/// the interval [-1; 1]. A value of one will cull all nodes while a value of -1 will never cull a node. The deviation will normally have negative values because then the enclosed angle between the normal and the
/// The deviation will normally have negative values because then the enclosed angle between the normal and the eye/view point is larger than 90 degrees (and therefore the eye sees the "back" from the control point).
/// eye/view point is larger than 90 degrees (and therefore the eye sees the "back" from the control point). */
///
class OSG_EXPORT ClusterCullingCallback : public DrawableCullCallback, public NodeCallback class OSG_EXPORT ClusterCullingCallback : public DrawableCullCallback, public NodeCallback
{ {
public: public: