om::editors::base::SpatialObject Class Reference

An interface that provides a spatial representation for a resource object. More...

#include <omEditorSpatialObject.h>

Inheritance diagram for om::editors::base::SpatialObject:

Public Member Functions
virtual	~SpatialObject ()
	Destroy a spatial object and release all internal resources. More...
virtual void	update ()
	Update the internal representation of the spatial object to reflect the resource's current state. More...
virtual OpaqueResource	getResource () const =0
	Return the resource that this spatial object represents. More...
virtual SpatialObjectFlags	getFlags () const
	Return a pointer to the boolean flags for this spatial object. More...
virtual GraphicsObject *	getGraphics () const
	Return a pointer to the graphical representation of the spatial object. More...
virtual Color4f	getSelectionColor () const
	Return the color that this object should be highlighted with when it is selected. More...
virtual Size	getTransformCount () const
	Return the number of editable transformations that this spatial object has. More...
virtual Transform3f	getTransform (Index transformIndex) const
	Return the transformation for this spatial object at the specified index. More...
virtual void	setTransform (Index transformIndex, const Transform3f &newTransform) const
	Set the transformation for this spatial object at the specified index. More...

Detailed Description

An interface that provides a spatial representation for a resource object.

Constructor & Destructor Documentation

virtual om::editors::base::SpatialObject::~SpatialObject ( )

virtual

Destroy a spatial object and release all internal resources.

Member Function Documentation

virtual void om::editors::base::SpatialObject::update ( )

virtual

Update the internal representation of the spatial object to reflect the resource's current state.

The default implementation has no effect.

Reimplemented in om::editors::types::PhysicsShapeEditor::Spatial.

virtual OpaqueResource om::editors::base::SpatialObject::getResource ( ) const

pure virtual

Return the resource that this spatial object represents.

Implemented in om::editors::types::GraphicsObjectEditor::Spatial, om::editors::types::GraphicsShapeEditor::Spatial, and om::editors::types::PhysicsShapeEditor::Spatial.

virtual SpatialObjectFlags om::editors::base::SpatialObject::getFlags ( ) const

virtual

Return a pointer to the boolean flags for this spatial object.

Reimplemented in om::editors::types::GraphicsObjectEditor::Spatial, om::editors::types::GraphicsShapeEditor::Spatial, and om::editors::types::PhysicsShapeEditor::Spatial.

virtual GraphicsObject* om::editors::base::SpatialObject::getGraphics ( ) const

virtual

Return a pointer to the graphical representation of the spatial object.

The default implementation returns NULL, indicating that the spatial object has no graphical representation.

Reimplemented in om::editors::types::GraphicsObjectEditor::Spatial, om::editors::types::GraphicsShapeEditor::Spatial, and om::editors::types::PhysicsShapeEditor::Spatial.

virtual Color4f om::editors::base::SpatialObject::getSelectionColor ( ) const

virtual

Return the color that this object should be highlighted with when it is selected.

The default color is white.

virtual Size om::editors::base::SpatialObject::getTransformCount ( ) const

virtual

Return the number of editable transformations that this spatial object has.

The default implementation returns 0.

Reimplemented in om::editors::types::GraphicsObjectEditor::Spatial.

virtual Transform3f om::editors::base::SpatialObject::getTransform ( Index  transformIndex ) const

virtual

Return the transformation for this spatial object at the specified index.

The default implementation returns the identity transform.

Reimplemented in om::editors::types::GraphicsObjectEditor::Spatial.

virtual void om::editors::base::SpatialObject::setTransform ( Index  transformIndex, const Transform3f &  newTransform  ) const

virtual

Set the transformation for this spatial object at the specified index.

The default implementation has no effect.

Reimplemented in om::editors::types::GraphicsObjectEditor::Spatial.

---

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

• omEditorSpatialObject.h