corrections to com.jme3.scene.* comments as discussed at http://hub.jmonkeyengine.org/forum/topic/typos-in-com-jme3-scene/
This commit is contained in:
parent
5372cb505d
commit
4a69eee64f
@ -76,7 +76,7 @@ public class Geometry extends Spatial {
|
|||||||
*/
|
*/
|
||||||
protected BatchNode batchNode = null;
|
protected BatchNode batchNode = null;
|
||||||
/**
|
/**
|
||||||
* the start index of this geom's mesh in the batchNode mesh
|
* the start index of this geometry's mesh in the batchNode mesh
|
||||||
*/
|
*/
|
||||||
protected int startIndex;
|
protected int startIndex;
|
||||||
/**
|
/**
|
||||||
@ -201,9 +201,9 @@ public class Geometry extends Spatial {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the mseh to use for this geometry
|
* Returns the mesh to use for this geometry
|
||||||
*
|
*
|
||||||
* @return the mseh to use for this geometry
|
* @return the mesh to use for this geometry
|
||||||
*
|
*
|
||||||
* @see #setMesh(com.jme3.scene.Mesh)
|
* @see #setMesh(com.jme3.scene.Mesh)
|
||||||
*/
|
*/
|
||||||
@ -472,9 +472,8 @@ public class Geometry extends Spatial {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a deep clone of the geometry,
|
* Create a deep clone of the geometry. This creates an identical copy of
|
||||||
* this creates an identical copy of the mesh
|
* the mesh with the vertex buffer data duplicated.
|
||||||
* with the vertexbuffer data duplicated.
|
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public Spatial deepClone() {
|
public Spatial deepClone() {
|
||||||
|
@ -76,9 +76,8 @@ public class Node extends Spatial implements Savable {
|
|||||||
* Constructor instantiates a new <code>Node</code> with a default empty
|
* Constructor instantiates a new <code>Node</code> with a default empty
|
||||||
* list for containing children.
|
* list for containing children.
|
||||||
*
|
*
|
||||||
* @param name
|
* @param name the name of the scene element. This is required for
|
||||||
* the name of the scene element. This is required for
|
* identification and comparison purposes.
|
||||||
* identification and comparision purposes.
|
|
||||||
*/
|
*/
|
||||||
public Node(String name) {
|
public Node(String name) {
|
||||||
super(name);
|
super(name);
|
||||||
|
@ -85,9 +85,10 @@ public class VertexBuffer extends NativeObject implements Savable, Cloneable {
|
|||||||
Color,
|
Color,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tangent vector, normalized (4 floats) (x,y,z,w)
|
* Tangent vector, normalized (4 floats) (x,y,z,w). The w component is
|
||||||
* the w component is called the binormal parity, is not normalized and is either 1f or -1f
|
* called the binormal parity, is not normalized, and is either 1f or
|
||||||
* It's used to compuste the direction on the binormal verctor on the GPU at render time.
|
* -1f. It's used to compute the direction on the binormal vector on the
|
||||||
|
* GPU at render time.
|
||||||
*/
|
*/
|
||||||
Tangent,
|
Tangent,
|
||||||
|
|
||||||
|
@ -46,9 +46,8 @@ import com.jme3.math.FastMath;
|
|||||||
public class AreaUtils {
|
public class AreaUtils {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* calcScreenArea -- in Pixels
|
* Estimate the screen area of a bounding volume. If the volume isn't a
|
||||||
* Aproximates the screen area of a bounding volume. If the volume isn't a
|
* BoundingSphere, BoundingBox, or OrientedBoundingBox, 0 is returned.
|
||||||
* BoundingSphere, BoundingBox, or OrientedBoundingBox 0 is returned.
|
|
||||||
*
|
*
|
||||||
* @param bound The bounds to calculate the volume from.
|
* @param bound The bounds to calculate the volume from.
|
||||||
* @param distance The distance from camera to object.
|
* @param distance The distance from camera to object.
|
||||||
|
@ -90,7 +90,7 @@ public class SkeletonPoints extends Mesh {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The method updates the geometry according to the poitions of the bones.
|
* The method updates the geometry according to the positions of the bones.
|
||||||
*/
|
*/
|
||||||
public void updateGeometry() {
|
public void updateGeometry() {
|
||||||
VertexBuffer vb = this.getBuffer(Type.Position);
|
VertexBuffer vb = this.getBuffer(Type.Position);
|
||||||
|
@ -257,13 +257,15 @@ public class Surface extends Mesh {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method adds a normal to a normals' map. This map is used to merge normals of a vertor that should be rendered smooth.
|
* This method adds a normal to a normal's map. This map is used to merge
|
||||||
|
* normals of a vector that should be rendered smooth.
|
||||||
|
*
|
||||||
* @param normalToAdd
|
* @param normalToAdd
|
||||||
* a normal to be added
|
* a normal to be added
|
||||||
* @param normalMap
|
* @param normalMap
|
||||||
* merges normals of faces that will be rendered smooth; the key is the vertex and the value - its normal vector
|
* merges normals of faces that will be rendered smooth; the key is the vertex and the value - its normal vector
|
||||||
* @param smooth
|
* @param smooth the variable that indicates whether to merge normals
|
||||||
* the variable that indicates wheather to merge normals (creating the smooth mesh) or not
|
* (creating the smooth mesh) or not
|
||||||
* @param vertices
|
* @param vertices
|
||||||
* a list of vertices read from the blender file
|
* a list of vertices read from the blender file
|
||||||
*/
|
*/
|
||||||
|
@ -57,9 +57,13 @@ public class Torus extends Mesh {
|
|||||||
private int circleSamples;
|
private int circleSamples;
|
||||||
|
|
||||||
private int radialSamples;
|
private int radialSamples;
|
||||||
|
/**
|
||||||
|
* minor radius of the torus
|
||||||
|
*/
|
||||||
private float innerRadius;
|
private float innerRadius;
|
||||||
|
/**
|
||||||
|
* major radius of the torus
|
||||||
|
*/
|
||||||
private float outerRadius;
|
private float outerRadius;
|
||||||
|
|
||||||
public Torus() {
|
public Torus() {
|
||||||
@ -73,10 +77,8 @@ public class Torus extends Mesh {
|
|||||||
* The number of samples along the circles.
|
* The number of samples along the circles.
|
||||||
* @param radialSamples
|
* @param radialSamples
|
||||||
* The number of samples along the radial.
|
* The number of samples along the radial.
|
||||||
* @param innerRadius
|
* @param innerRadius minor radius of the torus
|
||||||
* The radius of the inner begining of the Torus.
|
* @param outerRadius major radius of the torus
|
||||||
* @param outerRadius
|
|
||||||
* The radius of the outter end of the Torus.
|
|
||||||
*/
|
*/
|
||||||
public Torus(int circleSamples, int radialSamples,
|
public Torus(int circleSamples, int radialSamples,
|
||||||
float innerRadius, float outerRadius) {
|
float innerRadius, float outerRadius) {
|
||||||
@ -226,8 +228,8 @@ public class Torus extends Mesh {
|
|||||||
*
|
*
|
||||||
* @param circleSamples the number of samples along the circles.
|
* @param circleSamples the number of samples along the circles.
|
||||||
* @param radialSamples the number of samples along the radial.
|
* @param radialSamples the number of samples along the radial.
|
||||||
* @param innerRadius the radius of the inner begining of the Torus.
|
* @param innerRadius minor radius of the torus
|
||||||
* @param outerRadius the radius of the outter end of the Torus.
|
* @param outerRadius major radius of the torus
|
||||||
*/
|
*/
|
||||||
public void updateGeometry(int circleSamples, int radialSamples, float innerRadius, float outerRadius) {
|
public void updateGeometry(int circleSamples, int radialSamples, float innerRadius, float outerRadius) {
|
||||||
this.circleSamples = circleSamples;
|
this.circleSamples = circleSamples;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user