Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# Ogre::MovableObject Class Reference

Abstract class definining a movable object in a scene. More...

`#include <OgreMovableObject.h>`

Inheritance diagram for Ogre::MovableObject:

[legend]
List of all members.

## Public Types

typedef std::vector< ShadowRenderable * > | ShadowRenderableList
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator

## Public Methods

| MovableObject ()
| Constructor.
virtual | ~MovableObject ()
| Virtual destructor - read Scott Meyers if you don't know why this is needed.
virtual const String & | getName (void) const=0
| Returns the name of this object.
virtual const String & | getMovableType (void) const=0
| Returns the type name of this object.
virtual Node * | getParentNode (void) const
| Returns the node to which this object is attached.
virtual SceneNode * | getParentSceneNode (void) const
| Returns the scene node to which this object is attached.
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false)
| Internal method called to notify the object that it has been attached to a node.
virtual bool | isAttached (void) const
| Returns true if this object is attached to a SceneNode or TagPoint.
virtual void | _notifyCurrentCamera (Camera *cam)=0
| Internal method to notify the object of the camera to be used for the next rendering operation.
virtual const AxisAlignedBox & | getBoundingBox (void) const=0
| Retrieves the local axis-aligned bounding box for this object.
virtual Real | getBoundingRadius (void) const=0
| Retrieves the radius of the origin-centered bounding sphere for this object.
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const
| Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const
| Retrieves the worldspace bounding sphere for this object.
virtual void | _updateRenderQueue (RenderQueue *queue)=0
| Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
virtual void | setVisible (bool visible)
| Tells this object whether to be visible or not, if it has a renderable component.
virtual bool | isVisible (void) const
| Returns whether or not this object is supposed to be visible or not.
virtual void | setUserObject (UserDefinedObject *obj)
| Call this to associate your own custom user object instance with this MovableObject.
virtual UserDefinedObject * | getUserObject (void)
| Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.
virtual void | setRenderQueueGroup (RenderQueueGroupID queueID)
| Sets the render queue group this entity will be rendered through.
virtual RenderQueueGroupID | getRenderQueueGroup (void) const
| Gets the queue group for this entity, see setRenderQueueGroup for full details.
virtual Matrix4 | _getParentNodeFullTransform (void) const
| return the full transformation of the parent sceneNode or the attachingPoint node
virtual void | setQueryFlags (unsigned long flags)
| Sets the query flags for this object.
virtual void | addQueryFlags (unsigned long flags)
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void | removeQueryFlags (unsigned long flags)
| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual unsigned long | getQueryFlags (void) const
| Returns the query flags relevant for this object.
EdgeData * | getEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows.
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
| Define a default implementation of method from ShadowCaster which implements no shadows.
ShadowRenderableListIterator | getLastShadowVolumeRenderableIterator (void)
| Return the last calculated shadow renderables.
const AxisAlignedBox & | getLightCapBounds (void) const
| Overridden member from ShadowCaster.
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
| Overridden member from ShadowCaster.
void | setCastShadows (bool enabled)
| Sets whether or not this object will cast shadows.
bool | getCastShadows (void) const
| Returns whether shadow casting is enabled for this object.
Real | getPointExtrusionDistance (const Light *l) const
| Get the distance to extrude for a point/spot light.

## Static Public Methods

void | extrudeVertices (HardwareVertexBufferSharedPtr vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
| Utility method for extruding vertices based on a light.

## Protected Methods

Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
| Helper moethod for calculating extrusion distance.
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
| Tells the caster to perform the tasks necessary to update the edge data's light listing.
virtual void | generateShadowVolume (EdgeData *edgeData, HardwareIndexBufferSharedPtr indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
| Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
| Utility method for extruding a bounding box.

## Protected Attributes

Node * | mParentNode
| node to which this object is attached
bool | mParentIsTagPoint
bool | mVisible
| Is this object visible?
UserDefinedObject * | mUserObject
| User defined object which is linked to this object.
RenderQueueGroupID | mRenderQueueID
| The render queue to use when rendering this object.
bool | mRenderQueueIDSet
| Flags whether the RenderQueue's default should be used.
unsigned long | mQueryFlags
| Flags determining whether this object is included / excluded from scene queries.
AxisAlignedBox | mWorldAABB
| Cached world AABB of this object.
Sphere | mWorldBoundingSphere
AxisAlignedBox | mWorldDarkCapBounds
| World space AABB of this object's dark cap.
bool | mCastShadows
| Does this object cast shadows?

## Detailed Description

Abstract class definining a movable object in a scene.

Remarks:
  Instances of this class are discrete, relatively small, movable objects which are attached to SceneNode objects to define their position.

Definition at line 44 of file OgreMovableObject.h.

## Member Typedef Documentation

typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList`[inherited]`

| Definition at line 125 of file OgreShadowCaster.h.

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator`[inherited]`

| Definition at line 126 of file OgreShadowCaster.h. Referenced by Ogre::Entity::getLastShadowVolumeRenderableIterator().

## Constructor & Destructor Documentation

Ogre::MovableObject::MovableObject | ( |  | ) |

| Constructor. Definition at line 36 of file OgreMovableObject.cpp. References mCastShadows, mParentIsTagPoint, mParentNode, mQueryFlags, mRenderQueueID, mRenderQueueIDSet, mUserObject, mVisible, mWorldAABB, Ogre::RENDER_QUEUE_MAIN, and Ogre::AxisAlignedBox::setNull().

Ogre::MovableObject::~MovableObject | ( |  | ) | `[virtual]`

| Virtual destructor - read Scott Meyers if you don't know why this is needed. Definition at line 49 of file OgreMovableObject.cpp.

## Member Function Documentation

Matrix4 Ogre::MovableObject::_getParentNodeFullTransform | ( | void |  | ) | const`[virtual]`

return the full transformation of the parent sceneNode or the attachingPoint node

Definition at line 121 of file OgreMovableObject.cpp.

References Ogre::Node::_getFullTransform(), and mParentNode.

Referenced by Ogre::Entity::cacheBoneMatrices(), Ogre::TagPoint::getParentEntityTransform(), getWorldBoundingBox(), Ogre::SubEntity::getWorldTransforms(), Ogre::Entity::EntityShadowRenderable::getWorldTransforms(), and Ogre::BillboardSet::getWorldTransforms().

void Ogre::MovableObject::_notifyAttached | ( | Node * | parent,
|  | bool | isTagPoint = false
| ) | `[virtual]`

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::Entity.

Definition at line 69 of file OgreMovableObject.cpp.

References mParentIsTagPoint, and mParentNode.

Referenced by Ogre::SceneNode::attachObject(), Ogre::Entity::attachObjectImpl(), Ogre::SceneNode::detachAllObjects(), Ogre::SceneNode::detachObject(), Ogre::Entity::detachObjectImpl(), and Ogre::SceneNode::~SceneNode().

virtual void Ogre::MovableObject::_notifyCurrentCamera | ( | Camera * | cam | ) | `[pure virtual]`

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks:
  Certain objects may want to do specific processing based on the camera position. This method notifies them incase they wish to do this.

Implemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::SimpleRenderable, and Ogre::TerrainRenderable.

Referenced by Ogre::OctreeNode::_addToRenderQueue(), and Ogre::BspSceneManager::processVisibleLeaf().

virtual void Ogre::MovableObject::_updateRenderQueue | ( | RenderQueue * | queue | ) | `[pure virtual]`

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks:
  The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::SimpleRenderable, and Ogre::TerrainRenderable.

Referenced by Ogre::BspSceneManager::processVisibleLeaf().

virtual void Ogre::MovableObject::addQueryFlags | ( | unsigned long | flags | ) | `[virtual]`

| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. Definition at line 185 of file OgreMovableObject.h.

void Ogre::ShadowCaster::extrudeBounds | ( | AxisAlignedBox & | box,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) | const`[protected, virtual, inherited]`

Utility method for extruding a bounding box.

Parameters:

  box | Original bounding box, will be updated in-place
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light
  extrudeDist | The distance to extrude

Definition at line 275 of file OgreShadowCaster.cpp.

References Ogre::AxisAlignedBox::getAllCorners(), Ogre::AxisAlignedBox::getMaximum(), Ogre::AxisAlignedBox::getMinimum(), Ogre::Vector3::makeCeil(), Ogre::Vector3::makeFloor(), Ogre::Vector3::normalise(), Ogre::Real, Ogre::AxisAlignedBox::setExtents(), Ogre::Vector4::w, Ogre::Vector4::x, Ogre::Vector3::x, Ogre::Vector4::y, Ogre::Vector3::y, Ogre::Vector4::z, and Ogre::Vector3::z.

Referenced by getDarkCapBounds().

void Ogre::ShadowCaster::extrudeVertices | ( | HardwareVertexBufferSharedPtr | vertexBuffer,
|  | size_t | originalVertexCount,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) | `[static, inherited]`

Utility method for extruding vertices based on a light.

Remarks:
  Unfortunately, because D3D cannot handle homogenous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters:

  vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
  originalVertexCount | The count of the original number of vertices, ie the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light
  extrudeDist | The distance to extrude

Definition at line 236 of file OgreShadowCaster.cpp.

References Ogre::Vector3::normalise(), Ogre::Real, Ogre::Vector4::w, Ogre::Vector3::x, Ogre::Vector4::x, Ogre::Vector3::y, Ogre::Vector4::y, Ogre::Vector3::z, and Ogre::Vector4::z.

Referenced by Ogre::Entity::getShadowVolumeRenderableIterator().

void Ogre::ShadowCaster::generateShadowVolume | ( | EdgeData * | edgeData,
|  | HardwareIndexBufferSharedPtr | indexBuffer,
|  | const Light * | light,
|  | ShadowRenderableList & | shadowRenderables,
|  | unsigned long | flags
| ) | `[protected, virtual, inherited]`

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

Parameters:

  edgeData | The edge information to use
  indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable.
  light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
  shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
  flags | Additional controller flags, see ShadowRenderableFlags

Definition at line 37 of file OgreShadowCaster.cpp.

References Ogre::EdgeData::Edge::degenerate, Ogre::EdgeData::edgeGroups, Ogre::EdgeData::EdgeGroup::edges, Ogre::ShadowRenderable::getLightCapRenderable(), Ogre::ShadowRenderable::getRenderOperationForUpdate(), Ogre::Light::getType(), Ogre::IndexData::indexCount, Ogre::RenderOperation::indexData, Ogre::IndexData::indexStart, Ogre::EdgeData::Triangle::lightFacing, Ogre::SRF_EXTRUDE_TO_INFINITY, Ogre::SRF_INCLUDE_DARK_CAP, Ogre::SRF_INCLUDE_LIGHT_CAP, Ogre::EdgeData::triangles, Ogre::EdgeData::Edge::triIndex, Ogre::VertexData::vertexCount, Ogre::EdgeData::EdgeGroup::vertexData, Ogre::EdgeData::EdgeGroup::vertexSet, Ogre::EdgeData::Triangle::vertexSet, Ogre::EdgeData::Triangle::vertIndex, and Ogre::EdgeData::Edge::vertIndex.

Referenced by Ogre::Entity::getShadowVolumeRenderableIterator().

virtual const AxisAlignedBox& Ogre::MovableObject::getBoundingBox | ( | void |  | ) | const`[pure virtual]`

Retrieves the local axis-aligned bounding box for this object.

Remarks:
  This bounding box is in local coordinates.

Implemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::SimpleRenderable, and Ogre::TerrainRenderable.

Referenced by getWorldBoundingBox().

virtual Real Ogre::MovableObject::getBoundingRadius | ( | void |  | ) | const`[pure virtual]`

| Retrieves the radius of the origin-centered bounding sphere for this object. Implemented in Ogre::BillboardSet, Ogre::Camera, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::Rectangle2D, Ogre::WireBoundingBox, and Ogre::TerrainRenderable. Referenced by Ogre::BspIntersectionSceneQuery::execute(), getWorldBoundingSphere(), and Ogre::BspLevel::tagNodesWithMovable().

bool Ogre::MovableObject::getCastShadows | ( | void |  | ) | const`[virtual]`

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Definition at line 231 of file OgreMovableObject.h.

Referenced by Ogre::OctreeNode::_addToRenderQueue(), Ogre::SubEntity::getCastsShadows(), Ogre::SceneManager::prepareShadowTextures(), Ogre::BspSceneManager::processVisibleLeaf(), Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult(), Ogre::SceneManager::renderAdditiveStencilShadowedQueueGroupObjects(), Ogre::SceneManager::renderModulativeStencilShadowedQueueGroupObjects(), and Ogre::SceneManager::renderModulativeTextureShadowedQueueGroupObjects().

const AxisAlignedBox & Ogre::MovableObject::getDarkCapBounds | ( | const Light & | light,
|  | Real | dirLightExtrusionDist
| ) | const`[virtual]`

| Overridden member from ShadowCaster. Implements Ogre::ShadowCaster. Definition at line 162 of file OgreMovableObject.cpp. References Ogre::ShadowCaster::extrudeBounds(), Ogre::Light::getAs4DVector(), getLightCapBounds(), mWorldDarkCapBounds, and Ogre::Real.

EdgeData* Ogre::MovableObject::getEdgeList | ( | void |  | ) | `[virtual]`

| Define a default implementation of method from ShadowCaster which implements no shadows. Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity. Definition at line 195 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance | ( | const Vector3 & | objectPos,
|  | const Light * | light
| ) | const`[protected, inherited]`

| Helper moethod for calculating extrusion distance. Definition at line 321 of file OgreShadowCaster.cpp. References Ogre::Light::getAttenuationRange(), Ogre::Light::getDerivedPosition(), Ogre::Vector3::length(), and Ogre::Real. Referenced by getPointExtrusionDistance().

ShadowRenderableListIterator Ogre::MovableObject::getLastShadowVolumeRenderableIterator | ( | void |  | ) | `[virtual]`

| Return the last calculated shadow renderables. Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity. Definition at line 206 of file OgreMovableObject.h.

const AxisAlignedBox & Ogre::MovableObject::getLightCapBounds | ( | void |  | ) | const`[virtual]`

| Overridden member from ShadowCaster. Implements Ogre::ShadowCaster. Definition at line 156 of file OgreMovableObject.cpp. References getWorldBoundingBox(). Referenced by getDarkCapBounds().

virtual const String& Ogre::MovableObject::getMovableType | ( | void |  | ) | const`[pure virtual]`

| Returns the type name of this object. Implemented in Ogre::BillboardSet, Ogre::Camera, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::ParticleSystem, Ogre::SimpleRenderable, and Ogre::TerrainRenderable.

virtual const String& Ogre::MovableObject::getName | ( | void |  | ) | const`[pure virtual]`

| Returns the name of this object. Implemented in Ogre::BillboardSet, Ogre::Camera, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::MovablePlane, Ogre::SimpleRenderable, and Ogre::TerrainRenderable. Referenced by Ogre::SceneNode::attachObject(), Ogre::Entity::attachObjectImpl(), and Ogre::Entity::attachObjectToBone().

Node * Ogre::MovableObject::getParentNode | ( | void |  | ) | const`[virtual]`

Returns the node to which this object is attached.

Remarks:
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

Definition at line 75 of file OgreMovableObject.cpp.

References mParentNode.

Referenced by Ogre::TagPoint::_updateFromParent(), Ogre::Entity::detachObjectImpl(), Ogre::BspIntersectionSceneQuery::execute(), Ogre::SubEntity::getSquaredViewDepth(), Ogre::Entity::EntityShadowRenderable::getWorldOrientation(), Ogre::Entity::EntityShadowRenderable::getWorldPosition(), Ogre::TagPoint::needUpdate(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

SceneNode * Ogre::MovableObject::getParentSceneNode | ( | void |  | ) | const`[virtual]`

Returns the scene node to which this object is attached.

Remarks:
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

Definition at line 80 of file OgreMovableObject.cpp.

References Ogre::TagPoint::getParentEntity().

Referenced by Ogre::TerrainRenderable::getLights(), Ogre::TagPoint::getLights(), Ogre::SubEntity::getLights(), Ogre::SimpleRenderable::getLights(), and Ogre::BillboardSet::getLights().

Real Ogre::MovableObject::getPointExtrusionDistance | ( | const Light * | l | ) | const`[virtual]`

| Get the distance to extrude for a point/spot light. Implements Ogre::ShadowCaster. Definition at line 172 of file OgreMovableObject.cpp. References Ogre::Node::_getDerivedPosition(), Ogre::ShadowCaster::getExtrusionDistance(), mParentNode, and Ogre::Real.

virtual unsigned long Ogre::MovableObject::getQueryFlags | ( | void |  | ) | const`[virtual]`

| Returns the query flags relevant for this object. Definition at line 192 of file OgreMovableObject.h. Referenced by Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute(), Ogre::OctreeSphereSceneQuery::execute(), Ogre::OctreeRaySceneQuery::execute(), Ogre::OctreeAxisAlignedBoxSceneQuery::execute(), Ogre::OctreeIntersectionSceneQuery::execute(), and Ogre::BspIntersectionSceneQuery::execute().

RenderQueueGroupID Ogre::MovableObject::getRenderQueueGroup | ( | void |  | ) | const`[virtual]`

| Gets the queue group for this entity, see setRenderQueueGroup for full details. Definition at line 116 of file OgreMovableObject.cpp. References mRenderQueueID, and Ogre::RenderQueueGroupID.

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator | ( | ShadowTechnique | shadowTechnique,
|  | const Light * | light,
|  | HardwareIndexBufferSharedPtr * | indexBuffer,
|  | bool | extrudeVertices,
|  | Real | extrusionDist,
|  | unsigned long | flags = 0
| ) | `[virtual]`

| Define a default implementation of method from ShadowCaster which implements no shadows. Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity. Definition at line 197 of file OgreMovableObject.h. References Ogre::Real, and Ogre::ShadowTechnique.

virtual UserDefinedObject* Ogre::MovableObject::getUserObject | ( | void |  | ) | `[virtual]`

| Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject. Definition at line 153 of file OgreMovableObject.h.

const AxisAlignedBox & Ogre::MovableObject::getWorldBoundingBox | ( | bool | derive = false | ) | const`[virtual]`

Retrieves the axis-aligned bounding box for this object in world coordinates.

Implements Ogre::ShadowCaster.

Definition at line 133 of file OgreMovableObject.cpp.

References _getParentNodeFullTransform(), getBoundingBox(), mWorldAABB, and Ogre::AxisAlignedBox::transform().

Referenced by Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute(), Ogre::OctreeSphereSceneQuery::execute(), Ogre::OctreeRaySceneQuery::execute(), Ogre::OctreeAxisAlignedBoxSceneQuery::execute(), Ogre::OctreeIntersectionSceneQuery::execute(), Ogre::BspIntersectionSceneQuery::execute(), getLightCapBounds(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

const Sphere & Ogre::MovableObject::getWorldBoundingSphere | ( | bool | derive = false | ) | const`[virtual]`

| Retrieves the worldspace bounding sphere for this object. Definition at line 145 of file OgreMovableObject.cpp. References Ogre::Node::_getDerivedPosition(), getBoundingRadius(), mParentNode, mWorldBoundingSphere, Ogre::Sphere::setCenter(), and Ogre::Sphere::setRadius(). Referenced by Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

bool Ogre::MovableObject::isAttached | ( | void |  | ) | const`[virtual]`

| Returns true if this object is attached to a SceneNode or TagPoint. Definition at line 93 of file OgreMovableObject.cpp. References mParentNode. Referenced by Ogre::Entity::attachObjectToBone().

bool Ogre::MovableObject::isVisible | ( | void |  | ) | const`[virtual]`

| Returns whether or not this object is supposed to be visible or not. Definition at line 104 of file OgreMovableObject.cpp. References mVisible. Referenced by Ogre::OctreeNode::_addToRenderQueue(), Ogre::SceneManager::_populateLightList(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

virtual void Ogre::MovableObject::removeQueryFlags | ( | unsigned long | flags | ) | `[virtual]`

| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. Definition at line 189 of file OgreMovableObject.h.

void Ogre::MovableObject::setCastShadows | ( | bool | enabled | ) |

Sets whether or not this object will cast shadows.

Remarks:
  This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note:
  This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 229 of file OgreMovableObject.h.

Referenced by Ogre::Entity::Entity(), Ogre::SceneManager::setSkyBox(), Ogre::SceneManager::setSkyDome(), and Ogre::SceneManager::setSkyPlane().

virtual void Ogre::MovableObject::setQueryFlags | ( | unsigned long | flags | ) | `[virtual]`

Sets the query flags for this object.

Remarks:
  When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

Definition at line 181 of file OgreMovableObject.h.

void Ogre::MovableObject::setRenderQueueGroup | ( | RenderQueueGroupID | queueID | ) | `[virtual]`

Sets the render queue group this entity will be rendered through.

Remarks:
  Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

  See RenderQueue for more details.

Parameters:

  queueID | Enumerated value of the queue group to use.

Reimplemented in Ogre::Entity.

Definition at line 110 of file OgreMovableObject.cpp.

References mRenderQueueID, mRenderQueueIDSet, and Ogre::RenderQueueGroupID.

virtual void Ogre::MovableObject::setUserObject | ( | UserDefinedObject * | obj | ) | `[virtual]`

Call this to associate your own custom user object instance with this MovableObject.

Remarks:
  By simply making your game / application object a subclass of UserDefinedObject, you can establish a link between an OGRE instance of MovableObject and your own application classes. Call this method to establish the link.

Definition at line 149 of file OgreMovableObject.h.

void Ogre::MovableObject::setVisible | ( | bool | visible | ) | `[virtual]`

| Tells this object whether to be visible or not, if it has a renderable component. Reimplemented in Ogre::Light. Definition at line 99 of file OgreMovableObject.cpp. References mVisible.

void Ogre::ShadowCaster::updateEdgeListLightFacing | ( | EdgeData * | edgeData,
|  | const Vector4 & | lightPos
| ) | `[protected, virtual, inherited]`

Tells the caster to perform the tasks necessary to update the edge data's light listing.

Can be overridden if the subclass needs to do additional things.

Parameters:

  edgeData | The edge information to update
  lightPos | 4D vector representing the light, a directional light has w=0.0

Definition at line 31 of file OgreShadowCaster.cpp.

References Ogre::EdgeData::updateTriangleLightFacing().

Referenced by Ogre::Entity::getShadowVolumeRenderableIterator().

## Member Data Documentation

bool Ogre::MovableObject::mCastShadows`[protected]`

| Does this object cast shadows? Definition at line 67 of file OgreMovableObject.h. Referenced by Ogre::BillboardSet::BillboardSet(), and MovableObject().

bool Ogre::MovableObject::mParentIsTagPoint`[protected]`

| Definition at line 49 of file OgreMovableObject.h. Referenced by _notifyAttached(), and MovableObject().

Node* Ogre::MovableObject::mParentNode`[protected]`

node to which this object is attached

Definition at line 48 of file OgreMovableObject.h.

Referenced by Ogre::MovablePlane::_getDerivedPlane(), _getParentNodeFullTransform(), _notifyAttached(), Ogre::Entity::_notifyCurrentCamera(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::BillboardSet::_updateBounds(), Ogre::Entity::attachObjectToBone(), Ogre::Camera::Camera(), Ogre::Entity::detachAllObjectsFromBone(), Ogre::Entity::detachObjectFromBone(), Ogre::Frustum::Frustum(), Ogre::BillboardSet::genBillboardAxes(), Ogre::Entity::getBoundingRadius(), getParentNode(), getPointExtrusionDistance(), Ogre::Entity::getShadowVolumeRenderableIterator(), Ogre::Frustum::getSquaredViewDepth(), getWorldBoundingSphere(), Ogre::TerrainRenderable::getWorldOrientation(), Ogre::SubEntity::getWorldOrientation(), Ogre::SimpleRenderable::getWorldOrientation(), Ogre::ParticleSystem::getWorldOrientation(), Ogre::Frustum::getWorldOrientation(), Ogre::BillboardSet::getWorldOrientation(), Ogre::TerrainRenderable::getWorldPosition(), Ogre::SubEntity::getWorldPosition(), Ogre::SimpleRenderable::getWorldPosition(), Ogre::ParticleSystem::getWorldPosition(), Ogre::Frustum::getWorldPosition(), Ogre::BillboardSet::getWorldPosition(), Ogre::TerrainRenderable::getWorldTransforms(), Ogre::SimpleRenderable::getWorldTransforms(), Ogre::Frustum::getWorldTransforms(), isAttached(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Light::Light(), MovableObject(), Ogre::SimpleRenderable::SimpleRenderable(), Ogre::Light::update(), and Ogre::Entity::updateAnimation().

unsigned long Ogre::MovableObject::mQueryFlags`[protected]`

| Flags determining whether this object is included / excluded from scene queries. Definition at line 59 of file OgreMovableObject.h. Referenced by MovableObject(), and Ogre::TerrainRenderable::TerrainRenderable().

RenderQueueGroupID Ogre::MovableObject::mRenderQueueID`[protected]`

| The render queue to use when rendering this object. Definition at line 55 of file OgreMovableObject.h. Referenced by Ogre::SimpleRenderable::_updateRenderQueue(), Ogre::Entity::_updateRenderQueue(), Ogre::BillboardSet::_updateRenderQueue(), getRenderQueueGroup(), MovableObject(), and setRenderQueueGroup().

bool Ogre::MovableObject::mRenderQueueIDSet`[protected]`

| Flags whether the RenderQueue's default should be used. Definition at line 57 of file OgreMovableObject.h. Referenced by MovableObject(), and setRenderQueueGroup().

UserDefinedObject* Ogre::MovableObject::mUserObject`[protected]`

| User defined object which is linked to this object. Definition at line 53 of file OgreMovableObject.h. Referenced by MovableObject().

bool Ogre::MovableObject::mVisible`[protected]`

| Is this object visible? Definition at line 51 of file OgreMovableObject.h. Referenced by Ogre::Camera::Camera(), Ogre::Frustum::Frustum(), isVisible(), MovableObject(), and setVisible().

AxisAlignedBox Ogre::MovableObject::mWorldAABB`[protected]`

| Cached world AABB of this object. Definition at line 61 of file OgreMovableObject.h. Referenced by getWorldBoundingBox(), and MovableObject().

Sphere Ogre::MovableObject::mWorldBoundingSphere`[protected]`

| Definition at line 63 of file OgreMovableObject.h. Referenced by getWorldBoundingSphere().

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds`[protected]`

| World space AABB of this object's dark cap. Definition at line 65 of file OgreMovableObject.h. Referenced by getDarkCapBounds().

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

- OgreMovableObject.h
- OgreMovableObject.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:17 2004