G3D::Sphere Class Reference

#include <Sphere.h>

Public Member Functions
	Sphere ()
	Sphere (float radius)
	Sphere (class BinaryInput &b)
void	serialize (class BinaryOutput &b) const
void	deserialize (class BinaryInput &b)
	Sphere (const class Any &a)
Any	toAny () const
	Sphere (const Point3 &center, float radius)
virtual	~Sphere ()
bool	operator== (const Sphere &other) const
bool	operator!= (const Sphere &other) const
bool	contains (const Point3 &point) const
bool	contains (const Sphere &other) const
bool	culledBy (const class Plane *plane, int numPlanes, int32 &cullingPlaneIndex, const uint32 testMask, uint32 &childMask) const
bool	culledBy (const class Plane *plane, int numPlanes, int32 &cullingPlaneIndex=dummy, const uint32 testMask=0xFFFFFFFF) const
bool	culledBy (const Array< Plane > &plane, int32 &cullingPlaneIndex, const uint32 testMask, uint32 &childMask) const
bool	culledBy (const Array< Plane > &plane, int32 &cullingPlaneIndex=dummy, const uint32 testMask=0xFFFFFFFF) const
virtual std::string	toString () const
float	volume () const
float	area () const
Point3	randomSurfacePoint () const
Point3	randomInteriorPoint () const
void	getBounds (class AABox &out) const
bool	intersects (const Sphere &other) const
Sphere	operator+ (const Vector3 &v) const
Sphere	operator- (const Vector3 &v) const
void	merge (const Sphere &s)

Static Public Member Functions
static const Sphere &	inf ()

Public Attributes
Point3	center
float	radius

Static Private Attributes
static int32	dummy

Detailed Description

Sphere.

Constructor & Destructor Documentation

G3D::Sphere::Sphere ( )

inline

 : center(Point3::zero()), radius(0) {
 }

Here is the caller graph for this function:

G3D::Sphere::Sphere ( float  radius )

inlineexplicit

: radius(radius) {}

G3D::Sphere::Sphere

(

class BinaryInput &

b

)

 {
 deserialize(b);
}

Here is the call graph for this function:

G3D::Sphere::Sphere ( const class Any &  a )

explicit

Format is one of:

• Sphere(point, radius)
• Sphere(radius)

G3D::Sphere::Sphere ( const Point3 &  center, float  radius  )

inline

 : center(center), radius(radius) {
 }

virtual G3D::Sphere::~Sphere ( )

inlinevirtual

{}

Member Function Documentation

float G3D::Sphere::area

(

)

const

 {
 return (float)pi() * 4.0f * powf((float)radius, 2.0f);
}

Here is the call graph for this function:

bool G3D::Sphere::contains

(

const Point3 &

point

)

const

Returns true if point is less than or equal to radius away from the center.

 {
 float distance = (center - point).squaredMagnitude();
 return distance <= square(radius);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool G3D::Sphere::contains

(

const Sphere &

other

)

const

 {
 float distance = (center - other.center).squaredMagnitude();
 return (radius >= other.radius) && (distance <= square(radius - other.radius));
}

Here is the call graph for this function:

bool G3D::Sphere::culledBy	(	const class Plane *	plane,
		int	numPlanes,
		int32 &	cullingPlaneIndex,
		const uint32	testMask,
		uint32 &	childMask
	)		const

Deprecated:

Use culledBy(Array<Plane>&)

bool G3D::Sphere::culledBy	(	const class Plane *	plane,
		int	numPlanes,
		int32 &	cullingPlaneIndex = dummy,
		const uint32	testMask = 0xFFFFFFFF
	)		const

Deprecated:

Use culledBy(Array<Plane>&)

bool G3D::Sphere::culledBy	(	const Array< Plane > &	plane,
		int32 &	cullingPlaneIndex,
		const uint32	testMask,
		uint32 &	childMask
	)		const

See AABox::culledBy

bool G3D::Sphere::culledBy	(	const Array< Plane > &	plane,
		int32 &	cullingPlaneIndex = dummy,
		const uint32	testMask = 0xFFFFFFFF
	)		const

Conservative culling test that does not produce a mask for children.

void G3D::Sphere::deserialize

(

class BinaryInput &

b

)

 {
 center.deserialize(b);
 radius = (float)b.readFloat64();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::Sphere::getBounds

(

class AABox &

out

)

const

 {
 Vector3 extent(radius, radius, radius);
 out = AABox(center - extent, center + extent);
}

Here is the caller graph for this function:

const Sphere & G3D::Sphere::inf ( )

static

Returns the infinite sphere.

 {
 static const Sphere s(Point3::zero(), finf());
 return s;
}

Here is the call graph for this function:

bool G3D::Sphere::intersects

(

const Sphere &

other

)

const

 {
 return (other.center - center).length() <= (radius + other.radius);
}

void G3D::Sphere::merge

(

const Sphere &

s

)

Sets this to the smallest sphere that encapsulates both

 {
 if (other.contains(*this)) {
 *this = other;
 } else if (! contains(other)) {
 // The farthest distance is along the axis between the centers, which
 // must not be colocated since neither contains the other.
 Vector3 toMe = center - other.center;
 // Get a point on the axis from each
 toMe = toMe.direction();
 const Vector3& A = center + toMe * radius;
 const Vector3& B = other.center - toMe * other.radius;

 // Now just bound the A->B segment
 center = (A + B) * 0.5f;
 radius = (A - B).length();
 }
 // (if this contains other, we're done)
}

Here is the call graph for this function:

bool G3D::Sphere::operator!= ( const Sphere &  other ) const

inline

 {
 return !((center == other.center) && (radius == other.radius));
 }

Sphere G3D::Sphere::operator+ ( const Vector3 &  v ) const

inline

Translates the sphere

 {
 return Sphere(center + v, radius);
 }

Here is the call graph for this function:

Sphere G3D::Sphere::operator- ( const Vector3 &  v ) const

inline

Translates the sphere

 {
 return Sphere(center - v, radius);
 }

Here is the call graph for this function:

bool G3D::Sphere::operator== ( const Sphere &  other ) const

inline

 {
 return (center == other.center) && (radius == other.radius);
 }

Vector3 G3D::Sphere::randomInteriorPoint

(

)

const

Uniformly distributed on the interior (includes surface)

 {
 Vector3 result;
 do {
 result = Vector3(uniformRandom(-1, 1), 
 uniformRandom(-1, 1), 
 uniformRandom(-1, 1));
 } while (result.squaredMagnitude() >= 1.0f);

 return result * radius + center;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Vector3 G3D::Sphere::randomSurfacePoint

(

)

const

Uniformly distributed on the surface.

 {
 return Vector3::random() * radius + center;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::Sphere::serialize

(

class BinaryOutput &

b

)

const

 {
 center.serialize(b);
 b.writeFloat64(radius);
}

Here is the call graph for this function:

Any G3D::Sphere::toAny

(

)

const

 {
 Any a(Any::ARRAY, "Sphere");
 if (center != Point3::zero()) {
 a.append(center);
 }

 a.append(radius);
 return a;
}

Here is the call graph for this function:

std::string G3D::Sphere::toString ( ) const

virtual

 {
 return format("Sphere(<%g, %g, %g>, %g)", 
 center.x, center.y, center.z, radius);
}

Here is the call graph for this function:

float G3D::Sphere::volume

(

)

const

 {
 return (float)pi() * (4.0f / 3.0f) * powf((float)radius, 3.0f);
}

Here is the call graph for this function:

Member Data Documentation

Point3 G3D::Sphere::center

int32 G3D::Sphere::dummy

staticprivate

float G3D::Sphere::radius

---

The documentation for this class was generated from the following files:

• dep/g3dlite/include/G3D/Sphere.h
• dep/g3dlite/source/Sphere.cpp