From Paulk Martz, "Looks like the ClipNode::setReferenceFrame comment block came from LightSource. Fixing the comment block to refer to ClipNode instead of light source."

This commit is contained in:
Robert Osfield 2012-01-24 17:40:31 +00:00
parent 9da901e11b
commit 68f776e2cc

View File

@ -40,16 +40,16 @@ class OSG_EXPORT ClipNode : public Group
ABSOLUTE_RF
};
/** Set the light sources's ReferenceFrame, either to be relative to its
/** Set the ClipNode's ReferenceFrame, either to be relative to its
* parent reference frame, or relative to an absolute coordinate
* frame. RELATIVE_RF is the default.
* Note: setting the ReferenceFrame to be ABSOLUTE_RF will
* also set the CullingActive flag on the light source, and hence all
* of its parents, to false, thereby disabling culling of it and
* also set the CullingActive flag to false on the ClipNode (and
* consequently all of its parents), thereby disabling culling of it and
* all its parents. This is necessary to prevent inappropriate
* culling, but may impact cull times if the absolute light source is
* culling, but may impact cull times if the absolute ClipNode is
* deep in the scene graph. It is therefore recommended to only use
* absolute light source at the top of the scene.
* absolute ClipNode at the top of the scene.
*/
void setReferenceFrame(ReferenceFrame rf);