com.jme.math
Class Ring

java.lang.Object
  com.jme.math.Ring

All Implemented Interfaces:

Savable, java.io.Serializable, java.lang.Cloneable

public class Ring
extends java.lang.Object
implements java.io.Serializable, Savable, java.lang.Cloneable

Ring defines a flat ring or disk within three dimensional space that is specified via the ring's center point, an up vector, an inner radius, and an outer radius.

Author:

Andrzej Kapolka, Joshua Slack

See Also:

Serialized Form

Constructor Summary

Ring()
Constructor creates a new Ring lying on the XZ plane, centered at the origin, with an inner radius of zero and an outer radius of one (a unit disk).

Ring(Vector3f center, Vector3f up, float innerRadius, float outerRadius)
Constructor creates a new Ring with defined center point, up vector, and inner and outer radii.

Method Summary

Ring	clone()
Vector3f	getCenter() getCenter returns the center of the ring.
java.lang.Class<? extends Ring>	getClassTag() The peristed type for the object.
float	getInnerRadius() getInnerRadius returns the ring's inner radius.
float	getOuterRadius() getOuterRadius returns the ring's outer radius.
Vector3f	getUp() getUp returns the ring's up vector.
Vector3f	random() random returns a random point within the ring.
Vector3f	random(Vector3f result) random returns a random point within the ring.
void	read(JMEImporter e)
void	setCenter(Vector3f center) setCenter sets the center of the ring.
void	setInnerRadius(float innerRadius) setInnerRadius sets the ring's inner radius.
void	setOuterRadius(float outerRadius) setOuterRadius sets the ring's outer radius.
void	setUp(Vector3f up) setUp sets the ring's up vector.
void	write(JMEExporter e)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ring

public Ring()

Constructor creates a new Ring lying on the XZ plane, centered at the origin, with an inner radius of zero and an outer radius of one (a unit disk).

Ring

public Ring(Vector3f center,
            Vector3f up,
            float innerRadius,
            float outerRadius)

Constructor creates a new Ring with defined center point, up vector, and inner and outer radii.

Parameters:

center - the center of the ring.

up - the unit up vector defining the ring's orientation.

innerRadius - the ring's inner radius.

outerRadius - the ring's outer radius.

Method Detail

getCenter

public Vector3f getCenter()

getCenter returns the center of the ring.

Returns:

the center of the ring.

setCenter

public void setCenter(Vector3f center)

setCenter sets the center of the ring.

Parameters:

center - the center of the ring.

getUp

public Vector3f getUp()

getUp returns the ring's up vector.

Returns:

the ring's up vector.

setUp

public void setUp(Vector3f up)

setUp sets the ring's up vector.

Parameters:

up - the ring's up vector.

getInnerRadius

public float getInnerRadius()

getInnerRadius returns the ring's inner radius.

Returns:

the ring's inner radius.

setInnerRadius

public void setInnerRadius(float innerRadius)

setInnerRadius sets the ring's inner radius.

Parameters:

innerRadius - the ring's inner radius.

getOuterRadius

public float getOuterRadius()

getOuterRadius returns the ring's outer radius.

Returns:

the ring's outer radius.

setOuterRadius

public void setOuterRadius(float outerRadius)

setOuterRadius sets the ring's outer radius.

Parameters:

outerRadius - the ring's outer radius.

random

public Vector3f random()

random returns a random point within the ring.

Returns:

a random point within the ring.

random

public Vector3f random(Vector3f result)

random returns a random point within the ring.

Parameters:

result - Vector to store result in

Returns:

a random point within the ring.

write

public void write(JMEExporter e)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JMEImporter e)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException

getClassTag

public java.lang.Class<? extends Ring> getClassTag()

Description copied from interface: Savable

The peristed type for the object. Note that tag here does not mean XML tag, but the class that the object is tagged with.

Specified by:

getClassTag in interface Savable

clone

public Ring clone()

Overrides:

clone in class java.lang.Object