Author Topic: Suggestions for the javadocs  (Read 1795 times)

Offline apchar

  • byte
  • *
  • Posts: 3
    • View Profile
Suggestions for the javadocs
« on: December 06, 2010, 09:01:26 am »
I'm new to all this & I'm really glad to find JPCT. Jmonkey is just too hard for a beginner.
I think most beginners will work almost exclusively with primitives (I know I will. I am so not ready for my own meshes.) So I'm playing with the stuff in the Primitives class now. But the javadocs have too little detail on how the arguments of the methods apply to the objects. These are things I found by trial & error. Which is good but tedious. So may I suggest adding:

In getCone()
The axis of the cone is on the y-axis with the tip pointing in the -y direction. scale is the radius of the base & half the height of the cone. The origin lies on the axis of symmetry half way between the base & tip of the cone.

In getCylinder()
The axis of the cylinder is on the y axis. scale is the radius of the cylinder & half the height. The origin lies on the axis of symmetry half way between the base & top.

In getPyramide()
The axis of the pyramide is on the y axis with the tip pointing in the -y direction. scale is the width of the base & half the height. The origin lies on the axis of symmetry half way between the base & top. The tips  of the base point in the x & z directions.

In getDoubleCone()
The result is 2 cones placed base to base on the origin. The axis of symmetry is on the y axis. scale is  the radius of the base & the height of each cone.

In getBox()
The result is a scale x scale cube. It's origin is at the center. In the XZ plane, the corners point in the x & z directions.

In getSphere()
scale is the radius of the sphere. The origin is at the center.

In getEllipsoid()
The axis of symmetry is along the y axis. scale is the radius in the xz plane. scaleHeight acts in the y direction.

I suggest something for getPlane() too. I still haven't figured it out.

This would save other noobs a lot of tedium.


Offline EgonOlsen

  • Administrator
  • quad
  • *****
  • Posts: 11771
    • View Profile
    • http://www.jpct.net
Re: Suggestions for the javadocs
« Reply #1 on: December 06, 2010, 09:15:20 am »
Thank you very much, i'll add those.