A class that implements a 3D transformation control widget that supports translation, rotation, and scaling. More...

#include <omGraphicsTransformControl.h>

Inheritance diagram for om::graphics::shapes::TransformControl:

Classes
class	DOF
	A class containing the degrees of freedom that a transform control supports. More...

Public Types
enum	DOFFlags { TRANSLATE_X = (1 << 0), TRANSLATE_Y = (1 << 1), TRANSLATE_Z = (1 << 2), TRANSLATE = (TRANSLATE_X \| TRANSLATE_Y \| TRANSLATE_Z), ROTATE_X = (1 << 3), ROTATE_Y = (1 << 4), ROTATE_Z = (1 << 5), ROTATE = (ROTATE_X \| ROTATE_Y \| ROTATE_Z), SCALE_X = (1 << 6), SCALE_Y = (1 << 7), SCALE_Z = (1 << 8), SCALE = (SCALE_X \| SCALE_Y \| SCALE_Z) }
	An enum specifying the different degrees of freedom that a transform control has. More...

Public Member Functions
	TransformControl ()
	Create a transform control shape centered at the origin. More...

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

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

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

virtual void	updateBoundingBox ()
	Update the transform control'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 transform control 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 implements a 3D transformation control widget that supports translation, rotation, and scaling.

Member Enumeration Documentation

enum om::graphics::shapes::TransformControl::DOFFlags

An enum specifying the different degrees of freedom that a transform control has.

Enumerator
TRANSLATE_X
TRANSLATE_Y
TRANSLATE_Z
TRANSLATE
ROTATE_X
ROTATE_Y
ROTATE_Z
ROTATE
SCALE_X
SCALE_Y
SCALE_Z
SCALE

Constructor & Destructor Documentation

om::graphics::shapes::TransformControl::TransformControl ( )

Create a transform control shape centered at the origin.

Member Function Documentation

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

virtual

Change the graphics context that is used to create this transform control 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::TransformControl::upload ( UploadRequest & request )

virtual

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

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

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

virtual

Download the transform control shape's GPU representation to CPU memory.

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

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

virtual

Update the transform control's axis-aligned bounding box.

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

virtual void om::graphics::shapes::TransformControl::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::TransformControl::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::TransformControl::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::TransformControl::TYPE

static

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

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

omGraphicsTransformControl.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation