om::physics::shapes::SphereShape Class Reference

A class that represents a 3D sphere shape. More...

#include <omPhysicsSphereShape.h>

Inheritance diagram for om::physics::shapes::SphereShape:

Public Member Functions
	SphereShape ()
	Create a new sphere shape with radius = 1 and centered at the local origin. More...
	SphereShape (Float newRadius, const Vector3f &newPosition)
	Create a new sphere shape with the specified position and radius. More...
Float	getRadius () const
	Return the radius of this sphere shape in its local space. More...
SIMDFloat4	getRadiusSIMD () const
	Return the 4-wide SIMD radius of this sphere shape in its local space. More...
void	setRadius (Float newRadius)
	Set the radius of this sphere shape in its local space. More...
const Vector3f &	getPosition () const
	Return the 3D position of this sphere shape in its local space. More...
SIMDFloat4	getPositionSIMD () const
	Return the 4-wide SIMD position of this sphere shape in its local space. More...
void	setPosition (const Vector3f &newPosition)
	Set the 3D position of this sphere shape in its local space. More...
PhysicsMaterial *	getMaterial () const
	Return a pointer to the physics material that this sphere shape is using. More...
void	setMaterial (PhysicsMaterial *newMaterial)
	Set a pointer to the physics material that this sphere shape is using. More...
virtual void	getMassInfo (Float &mass, Vector3f &massCenter, Matrix3f &inertia) const
	Get the mass distribution for this shape in its local space in the output parameters. More...
virtual Float	getVolume () const
	Return the volume of this shape in distance units cubed (m^3) in its coordinate frame. More...
Public Member Functions inherited from om::physics::shapes::PhysicsShape
virtual	~PhysicsShape ()
	Destroy this physics shape and all resources it has. More...
const AABB3f &	getBoundingBox () const
	Return a const reference to the local bounding box of this shape in its coordinate frame. More...
ShapeFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the shape. More...
const ShapeFlags &	getFlags () const
	Return an object that contains boolean parameters of the shape. More...
void	setFlags (const ShapeFlags &newFlags)
	Set an object that contains boolean parameters of the shape. More...
Bool	flagIsSet (ShapeFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this shape. More...
Bool	flagsAreSet (const ShapeFlags &otherFlags) const
	Return whether or not all of the specified boolan flags are set for this shape. More...
void	setFlag (ShapeFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this shape. More...
ShapeTypeID	getTypeID () const
	Return an integer identifying the type of this collision shape. More...
const ShapeType &	getType () const
	Return an object representing the type of this PhysicsShape. More...

Static Public Member Functions
static SIMDFloat4	getSupportPoint (const SphereShape *sphere, const SIMDFloat4 &direction)
	Return the point on the specified sphere that is farthest in the given normalized direction. More...

Static Public Attributes
static const ShapeType	TYPE
	A shape type object that represents the type to use for a sphere shape. More...
Static Public Attributes inherited from om::physics::shapes::PhysicsShape
static const ResourceType	RESOURCE_TYPE
	The resource type for a physics shape. More...

Additional Inherited Members
Protected Member Functions inherited from om::physics::shapes::PhysicsShape
	PhysicsShape (const ShapeType *newType)
	Create a PhysicsShape object that has the specified subtype. More...
void	setBoundingBox (const AABB3f &newBoundingBox)
	Set the local-space bounding box to use for this PhysicsShape. More...

Detailed Description

A class that represents a 3D sphere shape.

Constructor & Destructor Documentation

om::physics::shapes::SphereShape::SphereShape

(

)

Create a new sphere shape with radius = 1 and centered at the local origin.

om::physics::shapes::SphereShape::SphereShape	(	Float	newRadius,
		const Vector3f &	newPosition
	)

Create a new sphere shape with the specified position and radius.

Member Function Documentation

Float om::physics::shapes::SphereShape::getRadius ( ) const

inline

Return the radius of this sphere shape in its local space.

SIMDFloat4 om::physics::shapes::SphereShape::getRadiusSIMD ( ) const

inline

Return the 4-wide SIMD radius of this sphere shape in its local space.

void om::physics::shapes::SphereShape::setRadius ( Float  newRadius )

inline

Set the radius of this sphere shape in its local space.

const Vector3f& om::physics::shapes::SphereShape::getPosition ( ) const

inline

Return the 3D position of this sphere shape in its local space.

SIMDFloat4 om::physics::shapes::SphereShape::getPositionSIMD ( ) const

inline

Return the 4-wide SIMD position of this sphere shape in its local space.

void om::physics::shapes::SphereShape::setPosition ( const Vector3f &  newPosition )

inline

Set the 3D position of this sphere shape in its local space.

PhysicsMaterial* om::physics::shapes::SphereShape::getMaterial ( ) const

inline

Return a pointer to the physics material that this sphere shape is using.

void om::physics::shapes::SphereShape::setMaterial ( PhysicsMaterial *  newMaterial )

inline

Set a pointer to the physics material that this sphere shape is using.

virtual void om::physics::shapes::SphereShape::getMassInfo ( Float &  mass, Vector3f &  massCenter, Matrix3f &  inertia  ) const

virtual

Get the mass distribution for this shape in its local space in the output parameters.

Implements om::physics::shapes::PhysicsShape.

virtual Float om::physics::shapes::SphereShape::getVolume ( ) const

virtual

Return the volume of this shape in distance units cubed (m^3) in its coordinate frame.

Implements om::physics::shapes::PhysicsShape.

static SIMDFloat4 om::physics::shapes::SphereShape::getSupportPoint ( const SphereShape *  sphere, const SIMDFloat4 &  direction  )

inlinestatic

Return the point on the specified sphere that is farthest in the given normalized direction.

Member Data Documentation

const ShapeType om::physics::shapes::SphereShape::TYPE

static

A shape type object that represents the type to use for a sphere shape.

---

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

• omPhysicsSphereShape.h