A class that provides a simple means to draw a 3D oriented rectangular box. More...

#include <omGraphicsBoxShape.h>

Inheritance diagram for om::graphics::shapes::BoxShape:

Public Member Functions
	BoxShape ()
	Create a box shape centered at the origin with width, height and depth = 1. More...

	BoxShape (Real width, Real height, Real depth)
	Create a box shape with the specified local width, height, and depth. More...

	BoxShape (Real width, Real height, Real depth, const Vector3 &newPosition)
	Create a box shape with the specified position, width, height, and depth. More...

	BoxShape (Real width, Real height, Real depth, const Vector3 &newPosition, const Matrix3 &newOrientation)
	Create a box shape with the specified position, orientation, width, height, and depth. More...

const Vector3 &	getPosition () const
	Return the position of this box's center in local coordinates. More...

void	setPosition (const Vector3 &newPosition)
	Set the position of this box's center in local coordinates. More...

const Matrix3 &	getOrientation () const
	Return the orientation of this box's axes in local coordinates. More...

void	setOrientation (const Matrix3 &newOrientation)
	Set the orientation of this box's axes in local coordinates. More...

const Vector3 &	getSize () const
	Set the 3D dimensions of this box in its local coordinate frame. More...

void	setSize (const Vector3 &newSize)
	Set the 3D dimensions of this box in its local coordinate frame. More...

Real	getWidth () const
	Return the width (X size) of this box in its local coordinate frame. More...

void	setWidth (Real newWidth)
	Set the width (X size) of this box in its local coordinate frame. More...

Real	getHeight () const
	Return the height (Y size) of this box in its local coordinate frame. More...

void	setHeight (Real newHeight)
	Set the height (Y size) of this box in its local coordinate frame. More...

Real	getDepth () const
	Return the depth (Z size) of this box in its local coordinate frame. More...

void	setDepth (Real newDepth)
	Set the depth (Z size) of this box in its local coordinate frame. More...

Material *	getMaterial () const
	Return a pointer to the material of this box shape. More...

void	setMaterial (Material *newMaterial)
	Set the material of this box shape. More...

ConstantSet *	getConstants () const
	Return an object that describes a set of shader constants and their corresponding semantic usages for this shape. More...

void	setConstants (ConstantSet *newConstants)
	Set an object that describes a set of shader constants and their corresponding semantic usages for this shape. More...

TextureSet *	getTextures () const
	Return an object that describes a set of textures and their corresponding semantic usages for this shape. More...

void	setTextures (TextureSet *newTextures)
	Set an object that describes a set of textures and their corresponding semantic usages for this shape. More...

virtual void	setContext (devices::GraphicsContext *newContext)
	Change the graphics context that is used to create this box shape. More...

virtual void	upload (UploadRequest &request)
	Upload this box shape's CPU representation to the GPU device. More...

virtual void	download (DownloadRequest &request)
	Download the box shape's GPU representation to CPU memory. More...

virtual void	updateBoundingBox ()
	Update the box's axis-aligned bounding box. 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 ShapeType &	getShapeType () 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 AABB3 &	getBoundingBox () 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...

RenderableFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the renderable. More...

const RenderableFlags &	getFlags () 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...

GraphicsContext *	getContext () 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 box 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::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
GraphicsContext *	context
	A pointer to the graphics context this object is using. More...

Detailed Description

A class that provides a simple means to draw a 3D oriented rectangular box.

A box is specified by its width, height, and depth, as well as the position of its center and the 3 orthonormal axis that define its orientation.

This class handles all vertex and index buffer generation automatically, simplifying the visualization of boxes, such as for collision geometry.

Constructor & Destructor Documentation

om::graphics::shapes::BoxShape::BoxShape ( )

Create a box shape centered at the origin with width, height and depth = 1.

om::graphics::shapes::BoxShape::BoxShape	(	Real	width,
		Real	height,
		Real	depth
	)

Create a box shape with the specified local width, height, and depth.

om::graphics::shapes::BoxShape::BoxShape	(	Real	width,
		Real	height,
		Real	depth,
		const Vector3 &	newPosition
	)

Create a box shape with the specified position, width, height, and depth.

om::graphics::shapes::BoxShape::BoxShape	(	Real	width,
		Real	height,
		Real	depth,
		const Vector3 &	newPosition,
		const Matrix3 &	newOrientation
	)

Create a box shape with the specified position, orientation, width, height, and depth.

Member Function Documentation

const Vector3& om::graphics::shapes::BoxShape::getPosition ( ) const

inline

Return the position of this box's center in local coordinates.

void om::graphics::shapes::BoxShape::setPosition ( const Vector3 & newPosition )

Set the position of this box's center in local coordinates.

const Matrix3& om::graphics::shapes::BoxShape::getOrientation ( ) const

inline

Return the orientation of this box's axes in local coordinates.

void om::graphics::shapes::BoxShape::setOrientation ( const Matrix3 & newOrientation )

Set the orientation of this box's axes in local coordinates.

const Vector3& om::graphics::shapes::BoxShape::getSize ( ) const

inline

Set the 3D dimensions of this box in its local coordinate frame.

void om::graphics::shapes::BoxShape::setSize ( const Vector3 & newSize )

inline

Set the 3D dimensions of this box in its local coordinate frame.

Real om::graphics::shapes::BoxShape::getWidth ( ) const

inline

Return the width (X size) of this box in its local coordinate frame.

void om::graphics::shapes::BoxShape::setWidth ( Real newWidth )

inline

Set the width (X size) of this box in its local coordinate frame.

This width value is clamped to the range of [0,+infinity].

Real om::graphics::shapes::BoxShape::getHeight ( ) const

inline

Return the height (Y size) of this box in its local coordinate frame.

void om::graphics::shapes::BoxShape::setHeight ( Real newHeight )

inline

Set the height (Y size) of this box in its local coordinate frame.

This height value is clamped to the range of [0,+infinity].

Real om::graphics::shapes::BoxShape::getDepth ( ) const

inline

Return the depth (Z size) of this box in its local coordinate frame.

void om::graphics::shapes::BoxShape::setDepth ( Real newDepth )

inline

Set the depth (Z size) of this box in its local coordinate frame.

This depth value is clamped to the range of [0,+infinity].

Material* om::graphics::shapes::BoxShape::getMaterial ( ) const

inline

Return a pointer to the material of this box shape.

void om::graphics::shapes::BoxShape::setMaterial ( Material * newMaterial )

Set the material of this box shape.

ConstantSet* om::graphics::shapes::BoxShape::getConstants ( ) const

inline

Return an object that describes a set of shader constants and their corresponding semantic usages for this shape.

void om::graphics::shapes::BoxShape::setConstants ( ConstantSet * newConstants )

inline

Set an object that describes a set of shader constants and their corresponding semantic usages for this shape.

TextureSet* om::graphics::shapes::BoxShape::getTextures ( ) const

inline

Return an object that describes a set of textures and their corresponding semantic usages for this shape.

void om::graphics::shapes::BoxShape::setTextures ( TextureSet * newTextures )

inline

Set an object that describes a set of textures and their corresponding semantic usages for this shape.

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

virtual

Change the graphics context that is used to create this box shape.

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

Reimplemented from om::graphics::devices::GraphicsContextObject.

virtual void om::graphics::shapes::BoxShape::upload ( UploadRequest & request )

virtual

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

Reimplemented from om::graphics::devices::GraphicsContextObject.

virtual void om::graphics::shapes::BoxShape::download ( DownloadRequest & request )

virtual

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

Reimplemented from om::graphics::devices::GraphicsContextObject.

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

virtual

Update the box's axis-aligned bounding box.

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

virtual void om::graphics::shapes::BoxShape::getRenderables	(	const RenderRequest &	request,
		const Transform3 &	worldTransform,
		RenderQueue &	outputQueue
	)		const

virtual

Process the renderable and add all child renderable objects to the output render queue.

Implements om::graphics::base::Renderable.

virtual void om::graphics::shapes::BoxShape::intersectRay ( GraphicsRay & ray ) const

virtual

Trace a ray against this shape and compute the closest intersection.

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

virtual void om::graphics::shapes::BoxShape::testRay ( GraphicsRay & ray ) const

virtual

Trace a ray against this shape and determine if any intersection exist along the ray.

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

Member Data Documentation

const ShapeType om::graphics::shapes::BoxShape::TYPE

static

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

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

omGraphicsBoxShape.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation