[vtkusers] Documentation mistake in vtkCamera

[David Gobbi]

Xabi's documentation fix for Elevation() is correct.  However, I think
there is a more serious problem that needs to be addressed:

"Rotate the camera about the cross product of the negative of the
direction of projection and the view up vector centered on the focal
point."

Although it's correct, it is as incomprehensible to the layman as the
original.  Can someone suggest an easy-to-understand sentence to
precede the technical description?  Most of the other Camera
positioning methods also need this.

(as an aside, we can't change "negative direction-of-projection" to
"view-plane normal" because there are some very rarely-used camera
projections for which this isn't the case).

  David


On Fri, Feb 12, 2010 at 9:29 AM, David Doria <daviddoria+vtk at gmail.com> wrote:
> On Fri, Jan 22, 2010 at 11:36 AM, xabi riobe <xabivtk at gmail.com> wrote:
>>
>> Hi,
>> I want to notice that there is a mistake in the documentation of
>> vtkCamera::Elevation (both 5.4 and nightly)
>> it states that:
>> "Rotate the camera about the cross product of the direction of projection
>> and the view up vector centered on the focal point."
>> but in the cxx file it is correct:
>> "Rotate the camera about the cross product of the negative of the
>> direction of projection and the view up vector centered on the focal point."
>> we can replace "the negative of the direction of projection" by "the view
>> plane normal".
>
> I've never looked into this class so I can't help. But maybe someone else
> can take a second to verify this? We shouldn't let good suggestions like
> this get looked over!
> Thanks,
>
> David
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the VTK FAQ at:
> http://www.vtk.org/Wiki/VTK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtkusers
>
>