Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
om::graphics::shapes::SphericalFunctionShape Class Reference

A class that provides a simple means to draw a 3D spherical function. More...

#include <omGraphicsSphericalFunctionShape.h>

Inheritance diagram for om::graphics::shapes::SphericalFunctionShape:
om::graphics::shapes::SubdivisionShape om::graphics::shapes::GraphicsShape om::graphics::base::Renderable om::graphics::devices::GraphicsContextObject

Public Types

typedef Function< void(Vector3f &position, Vector3f &normal, Color4f &color)> Delegate
 A delegate function that provides the visualization data. More...
 

Public Member Functions

 SphericalFunctionShape ()
 Create a spherical function shape centered at the origin with a radius of 1. More...
 
 SphericalFunctionShape (const SphericalFunctionShape &other)
 Create a copy of another spherical function shape. More...
 
const DelegategetDelegate () const
 Return a pointer to the delegate of this spherical function shape. More...
 
void setDelegate (const Delegate &newDelegate)
 Set a pointer to the delegate of this spherical function shape. More...
 
virtual void setContext (devices::GraphicsContext *newContext)
 Change the graphics context that is used to render this spherical function shape. More...
 
virtual void upload (UploadRequest &request)
 Upload this subdivision shape's current CPU representation to the GPU device. More...
 
virtual void download (DownloadRequest &request)
 Download the subdivision shape's GPU representation to CPU memory. More...
 
virtual void updateBoundingBox ()
 Update the sphere's axis-aligned bounding box. More...
 
- Public Member Functions inherited from om::graphics::shapes::SubdivisionShape
 SubdivisionShape (const SubdivisionShape &other)
 Create a copy of another subdivision shape. More...
 
 ~SubdivisionShape ()
 Destroy a subdivision shape, releasing all internal resources. More...
 
SubdivisionShapeoperator= (const SubdivisionShape &other)
 Assign the state of another subdivision shape to this one. More...
 
Real getLODBias () const
 Get a value that multiplicatively biases the size of a pixel radius query. More...
 
void setLODBias (Real newLODBias)
 Set a value that multiplicatively biases the size of a pixel radius query. More...
 
virtual void getRenderables (const RenderRequest &request, const Transform3 &worldTransform, RenderQueue &outputQueue) const
 Process the renderable and add all child renderable objects to the output render queue. More...
 
virtual void intersectRay (GraphicsRay &ray) const
 Trace a ray against this shape and compute the closest intersection. More...
 
virtual void testRay (GraphicsRay &ray) const
 Trace a ray against this shape and determine if any intersection exist along the ray. More...
 
- Public Member Functions inherited from om::graphics::shapes::GraphicsShape
ShapeTypeID getShapeTypeID () const
 Return an integer identifying the sub type of this shape. More...
 
const ShapeTypegetShapeType () const
 Return a reference to an object representing the type of this Shape. More...
 
Sphere3 getBoundingSphere () const
 Return a bounding sphere for this transformable in its parent coordinate space. More...
 
const AABB3getBoundingBox () const
 Return an axis-aligned bounding box that encompases this entire transformable in its parent coordinate space. More...
 
- Public Member Functions inherited from om::graphics::base::Renderable
 Renderable ()
 Create a new renderable object with the default renderable flags. More...
 
 Renderable (const RenderableFlags &newFlags)
 Create a new renderable object with the specified renderable flags. More...
 
RenderableFlagsgetFlags ()
 Return a reference to an object that contains boolean parameters of the renderable. More...
 
const RenderableFlagsgetFlags () const
 Return an object that contains boolean parameters of the renderable. More...
 
void setFlags (const RenderableFlags &newFlags)
 Set an object that contains boolean parameters of the renderable. More...
 
Bool flagIsSet (RenderableFlags::Flag flag) const
 Return whether or not the specified boolan flag is set for this renderable. More...
 
Bool flagsAreSet (const RenderableFlags &otherFlags) const
 Return whether or not all of the specified boolan flags are set for this renderable. More...
 
void setFlag (RenderableFlags::Flag flag, Bool newIsSet=true)
 Set whether or not the specified boolan flag is set for this renderable. More...
 
Bool getIsVisible () const
 Get whether or not the renderable and its children are visible in the scene. More...
 
void setIsVisible (Bool newIsVisible)
 Set whether or not the renderable and its children are visible in the scene. More...
 
Bool getShadowsEnabled () const
 Return whether or not this renderable can cast shadows. More...
 
void setShadowsEnabled (Bool newCanCastShadows)
 Set whether or not this renderable can cast shadows. More...
 
- Public Member Functions inherited from om::graphics::devices::GraphicsContextObject
virtual ~GraphicsContextObject ()
 Destory this graphics context object. More...
 
GraphicsContextgetContext () const
 Return a pointer to the graphics context this context object is using to do rendering. More...
 
void clearContext ()
 Clear the previous context from this object. More...
 
void upload ()
 Upload this resource's CPU representation to the GPU device. More...
 
void download ()
 Upload this resource's CPU representation to the GPU device. More...
 
virtual Bool isUploaded () const
 Return whether or not this graphics resource has been successfully created and uploaded to the device. More...
 
virtual Bool isDownloaded () const
 Return whether or not this graphics resource has a copy of its data stored in CPU-side memory. More...
 
virtual Bool isValid () const
 Return whether or not the state of this graphics resource is valid (either on CPU or GPU) and able to be used for rendering. More...
 

Static Public Attributes

static const ShapeType TYPE
 A shape type object that represents the type to use for a spherical function shape. More...
 
- Static Public Attributes inherited from om::graphics::shapes::GraphicsShape
static const ResourceType RESOURCE_TYPE
 The resource type for a graphics shape. More...
 

Additional Inherited Members

- Protected Member Functions inherited from om::graphics::shapes::SubdivisionShape
 SubdivisionShape (const ShapeType *newShapeType)
 Create a subdivision shape for the specified shape type. More...
 
void clearSubdivisions ()
 Clear all previously-generated subdivisions for this subdivision shape. More...
 
Size getSubdivisionCount () const
 Return the number of subdivisions there are in this shape. More...
 
SubdivisiongetSubdivision (Index subdivisionLevel) const
 Return a pointer to the subdivision in this shape for the specified level. More...
 
GraphicsShapegetSubdivisionForPixelRadius (Real pixelRadius) const
 Return the shape which should be used when the shape has the specified screen-space radius. More...
 
- Protected Member Functions inherited from om::graphics::shapes::GraphicsShape
 GraphicsShape (const ShapeType *newType)
 Create a new shape with the specified type. More...
 
void setBoundingBox (const AABB3 &newBoundingBox)
 Set the local axis-aligned bounding box for this shape. More...
 
- Protected Member Functions inherited from om::graphics::devices::GraphicsContextObject
 GraphicsContextObject ()
 Create a new graphics context object that doesn't have an associated graphics context. More...
 
 GraphicsContextObject (GraphicsContext *newContext)
 Create a new graphics context object that uses the specified context for rendering. More...
 
- Protected Attributes inherited from om::graphics::base::Renderable
RenderableFlags flags
 An object containing boolean configuration flags for this renderable. More...
 
- Protected Attributes inherited from om::graphics::devices::GraphicsContextObject
GraphicsContextcontext
 A pointer to the graphics context this object is using. More...
 

Detailed Description

A class that provides a simple means to draw a 3D spherical function.

Member Typedef Documentation

typedef Function<void ( Vector3f& position, Vector3f& normal, Color4f& color )> om::graphics::shapes::SphericalFunctionShape::Delegate

A delegate function that provides the visualization data.

Constructor & Destructor Documentation

om::graphics::shapes::SphericalFunctionShape::SphericalFunctionShape ( )

Create a spherical function shape centered at the origin with a radius of 1.

om::graphics::shapes::SphericalFunctionShape::SphericalFunctionShape ( const SphericalFunctionShape other)

Create a copy of another spherical function shape.

Member Function Documentation

const Delegate& om::graphics::shapes::SphericalFunctionShape::getDelegate ( ) const
inline

Return a pointer to the delegate of this spherical function shape.

void om::graphics::shapes::SphericalFunctionShape::setDelegate ( const Delegate newDelegate)
inline

Set a pointer to the delegate of this spherical function shape.

virtual void om::graphics::shapes::SphericalFunctionShape::setContext ( devices::GraphicsContext newContext)
virtual

Change the graphics context that is used to render this spherical function shape.

Calling this method causes the previously generated sphere geometry to be discarded and regenerated using the new context.

Reimplemented from om::graphics::shapes::SubdivisionShape.

virtual void om::graphics::shapes::SphericalFunctionShape::upload ( UploadRequest request)
virtual

Upload this subdivision shape's current CPU representation to the GPU device.

Reimplemented from om::graphics::shapes::SubdivisionShape.

virtual void om::graphics::shapes::SphericalFunctionShape::download ( DownloadRequest request)
virtual

Download the subdivision shape's GPU representation to CPU memory.

Reimplemented from om::graphics::shapes::SubdivisionShape.

virtual void om::graphics::shapes::SphericalFunctionShape::updateBoundingBox ( )
virtual

Update the sphere's axis-aligned bounding box.

Reimplemented from om::graphics::shapes::GraphicsShape.

Member Data Documentation

const ShapeType om::graphics::shapes::SphericalFunctionShape::TYPE
static

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


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