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

Ogre::MovablePlane Class Reference

Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply. More...

#include <OgreMovablePlane.h>

Inheritance diagram for Ogre::MovablePlane:

Inheritance graph
[legend]
List of all members.

Public Types

enum  Side { NO_SIDE, POSITIVE_SIDE, NEGATIVE_SIDE }
 The "positive side" of the plane is the half space to which the plane normal points. More...

typedef std::vector< ShadowRenderable * > ShadowRenderableList
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator

Public Methods

 MovablePlane (const String &name)
 MovablePlane (const Plane &rhs)
 MovablePlane (const Vector3 &rkNormal, Real fConstant)
 Construct a plane through a normal, and a distance to move the plane along the normal.

 MovablePlane (const Vector3 &rkNormal, const Vector3 &rkPoint)
 MovablePlane (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
 ~MovablePlane ()
void _notifyCurrentCamera (Camera *cam)
 Overridden from MovableObject.

const AxisAlignedBoxgetBoundingBox (void) const
 Overridden from MovableObject.

Real getBoundingRadius (void) const
 Overridden from MovableObject.

void _updateRenderQueue (RenderQueue *queue)
 Overridden from MovableObject.

const StringgetName (void) const
 Overridden from MovableObject.

const StringgetMovableType (void) const
 Overridden from MovableObject.

const Plane_getDerivedPlane (void) const
 Get the derived plane as transformed by its parent node.

Side getSide (const Vector3 &rkPoint) const
Real getDistance (const Vector3 &rkPoint) const
 This is a pseudodistance.

void redefine (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
 Redefine this plane based on 3 points.

bool operator== (const Plane &rhs) const
 Comparison operator.

virtual NodegetParentNode (void) const
 Returns the node to which this object is attached.

virtual SceneNodegetParentSceneNode (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 const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates.

virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object.

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 UserDefinedObjectgetUserObject (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.

EdgeDatagetEdgeList (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 AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster.

const AxisAlignedBoxgetDarkCapBounds (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.


Public Attributes

Vector3 normal
Real d

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

String mName
Plane mDerivedPlane
Vector3 mLastTranlate
Quaternion mLastRotate
AxisAlignedBox mNullBB
bool mDirty
NodemParentNode
 node to which this object is attached

bool mParentIsTagPoint
bool mVisible
 Is this object visible?

UserDefinedObjectmUserObject
 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?


Static Protected Attributes

String msMovableType = "MovablePlane"

Friends

_OgreExport friend std::ostream & operator<< (std::ostream &o, Plane &p)

Detailed Description

Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply.

Remarks:
This plane is not here for rendering purposes, it's to allow you to attach planes to the scene in order to have them move and follow nodes on their own, which is useful if you're using the plane for some kind of calculation, e.g. reflection.

Definition at line 49 of file OgreMovablePlane.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().


Member Enumeration Documentation

enum Ogre::Plane::Side [inherited]
 

The "positive side" of the plane is the half space to which the plane normal points.

The "negative side" is the other half space. The flag "no side" indicates the plane itself.

Enumeration values:
NO_SIDE 
POSITIVE_SIDE 
NEGATIVE_SIDE 

Definition at line 66 of file OgrePlane.h.


Constructor & Destructor Documentation

Ogre::MovablePlane::MovablePlane const String   name
 

Definition at line 34 of file OgreMovablePlane.cpp.

References Ogre::String.

Ogre::MovablePlane::MovablePlane const Plane   rhs
 

Definition at line 42 of file OgreMovablePlane.cpp.

Ogre::MovablePlane::MovablePlane const Vector3   rkNormal,
Real    fConstant
 

Construct a plane through a normal, and a distance to move the plane along the normal.

Definition at line 48 of file OgreMovablePlane.cpp.

References Ogre::Real.

Ogre::MovablePlane::MovablePlane const Vector3   rkNormal,
const Vector3   rkPoint
 

Definition at line 54 of file OgreMovablePlane.cpp.

Ogre::MovablePlane::MovablePlane const Vector3   rkPoint0,
const Vector3   rkPoint1,
const Vector3   rkPoint2
 

Definition at line 60 of file OgreMovablePlane.cpp.

Ogre::MovablePlane::~MovablePlane  
 

Definition at line 68 of file OgreMovablePlane.h.


Member Function Documentation

const Plane & Ogre::MovablePlane::_getDerivedPlane void    const
 

Get the derived plane as transformed by its parent node.

Definition at line 67 of file OgreMovablePlane.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), Ogre::Plane::d, Ogre::Vector3::dotProduct(), mDerivedPlane, mDirty, mLastRotate, mLastTranlate, Ogre::MovableObject::mParentNode, and Ogre::Plane::normal.

Referenced by Ogre::Frustum::enableCustomNearClipPlane(), Ogre::Frustum::enableReflection(), Ogre::Frustum::isFrustumOutOfDate(), Ogre::Frustum::isViewOutOfDate(), and Ogre::Camera::isViewOutOfDate().

Matrix4 Ogre::MovableObject::_getParentNodeFullTransform void    const [virtual, inherited]
 

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 Ogre::MovableObject::mParentNode.

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

void Ogre::MovableObject::_notifyAttached Node   parent,
bool    isTagPoint = false
[virtual, inherited]
 

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 Ogre::MovableObject::mParentIsTagPoint, and Ogre::MovableObject::mParentNode.

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

void Ogre::MovablePlane::_notifyCurrentCamera Camera   cam [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 70 of file OgreMovablePlane.h.

void Ogre::MovablePlane::_updateRenderQueue RenderQueue   queue [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 76 of file OgreMovablePlane.h.

virtual void Ogre::MovableObject::addQueryFlags unsigned long    flags [virtual, inherited]
 

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 Ogre::MovableObject::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().

const AxisAlignedBox& Ogre::MovablePlane::getBoundingBox void    const [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 72 of file OgreMovablePlane.h.

Real Ogre::MovablePlane::getBoundingRadius void    const [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 74 of file OgreMovablePlane.h.

References Ogre::Real.

bool Ogre::MovableObject::getCastShadows void    const [virtual, inherited]
 

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, inherited]
 

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

Definition at line 162 of file OgreMovableObject.cpp.

References Ogre::ShadowCaster::extrudeBounds(), Ogre::Light::getAs4DVector(), Ogre::MovableObject::getLightCapBounds(), Ogre::MovableObject::mWorldDarkCapBounds, and Ogre::Real.

Real Ogre::Plane::getDistance const Vector3   rkPoint const [inherited]
 

This is a pseudodistance.

The sign of the return value is positive if the point is on the positive side of the plane, negative if the point is on the negative side, and zero if the point is on the plane.

The absolute value of the return value is the true distance only when the plane normal is a unit length vector.

Definition at line 60 of file OgrePlane.cpp.

References Ogre::Plane::d, Ogre::Vector3::dotProduct(), Ogre::Plane::normal, and Ogre::Real.

Referenced by Ogre::BspNode::getDistance(), Ogre::Plane::getSide(), Ogre::OctreeCamera::getVisibility(), Ogre::intersect(), Ogre::PlaneBoundedVolume::intersects(), Ogre::Frustum::isVisible(), and Ogre::BspSceneManager::processVisibleLeaf().

EdgeData* Ogre::MovableObject::getEdgeList void    [virtual, inherited]
 

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 Ogre::MovableObject::getPointExtrusionDistance().

ShadowRenderableListIterator Ogre::MovableObject::getLastShadowVolumeRenderableIterator void    [virtual, inherited]
 

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, inherited]
 

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

Definition at line 156 of file OgreMovableObject.cpp.

References Ogre::MovableObject::getWorldBoundingBox().

Referenced by Ogre::MovableObject::getDarkCapBounds().

const String & Ogre::MovablePlane::getMovableType void    const [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 101 of file OgreMovablePlane.cpp.

References msMovableType, and Ogre::String.

const String & Ogre::MovablePlane::getName void    const [virtual]
 

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 96 of file OgreMovablePlane.cpp.

References mName, and Ogre::String.

Node * Ogre::MovableObject::getParentNode void    const [virtual, inherited]
 

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 Ogre::MovableObject::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, inherited]
 

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, inherited]
 

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(), Ogre::MovableObject::mParentNode, and Ogre::Real.

virtual unsigned long Ogre::MovableObject::getQueryFlags void    const [virtual, inherited]
 

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, inherited]
 

Gets the queue group for this entity, see setRenderQueueGroup for full details.

Definition at line 116 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mRenderQueueID, and Ogre::RenderQueueGroupID.

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

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.

Plane::Side Ogre::Plane::getSide const Vector3   rkPoint const [inherited]
 

Definition at line 65 of file OgrePlane.cpp.

References Ogre::Plane::getDistance(), and Ogre::Real.

Referenced by Ogre::BspNode::getSide(), Ogre::PlaneBoundedVolume::intersects(), Ogre::Math::intersects(), and Ogre::Frustum::isVisible().

virtual UserDefinedObject* Ogre::MovableObject::getUserObject void    [virtual, inherited]
 

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, inherited]
 

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

Implements Ogre::ShadowCaster.

Definition at line 133 of file OgreMovableObject.cpp.

References Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::MovableObject::getBoundingBox(), Ogre::MovableObject::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(), Ogre::MovableObject::getLightCapBounds(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

const Sphere & Ogre::MovableObject::getWorldBoundingSphere bool    derive = false const [virtual, inherited]
 

Retrieves the worldspace bounding sphere for this object.

Definition at line 145 of file OgreMovableObject.cpp.

References Ogre::Node::_getDerivedPosition(), Ogre::MovableObject::getBoundingRadius(), Ogre::MovableObject::mParentNode, Ogre::MovableObject::mWorldBoundingSphere, Ogre::Sphere::setCenter(), and Ogre::Sphere::setRadius().

Referenced by Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

bool Ogre::MovableObject::isAttached void    const [virtual, inherited]
 

Returns true if this object is attached to a SceneNode or TagPoint.

Definition at line 93 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentNode.

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

bool Ogre::MovableObject::isVisible void    const [virtual, inherited]
 

Returns whether or not this object is supposed to be visible or not.

Definition at line 104 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mVisible.

Referenced by Ogre::OctreeNode::_addToRenderQueue(), Ogre::SceneManager::_populateLightList(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

bool Ogre::Plane::operator== const Plane   rhs const [inherited]
 

Comparison operator.

Definition at line 92 of file OgrePlane.h.

References Ogre::Plane::d, and Ogre::Plane::normal.

void Ogre::Plane::redefine const Vector3   rkPoint0,
const Vector3   rkPoint1,
const Vector3   rkPoint2
[inherited]
 

Redefine this plane based on 3 points.

Definition at line 78 of file OgrePlane.cpp.

References Ogre::Vector3::crossProduct(), Ogre::Plane::d, Ogre::Vector3::dotProduct(), Ogre::Plane::normal, and Ogre::Vector3::normalise().

Referenced by Ogre::TerrainRenderable::_calculateMinLevelDist2(), and Ogre::Plane::Plane().

virtual void Ogre::MovableObject::removeQueryFlags unsigned long    flags [virtual, inherited]
 

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 [inherited]
 

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, inherited]
 

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, inherited]
 

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 Ogre::MovableObject::mRenderQueueID, Ogre::MovableObject::mRenderQueueIDSet, and Ogre::RenderQueueGroupID.

virtual void Ogre::MovableObject::setUserObject UserDefinedObject   obj [virtual, inherited]
 

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, inherited]
 

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 Ogre::MovableObject::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().


Friends And Related Function Documentation

_OgreExport friend std::ostream& operator<< std::ostream &    o,
Plane   p
[friend, inherited]
 

Definition at line 88 of file OgrePlane.cpp.


Member Data Documentation

Real Ogre::Plane::d [inherited]
 

Definition at line 90 of file OgrePlane.h.

Referenced by Ogre::GLRenderSystem::_applyObliqueDepthProjection(), Ogre::D3D9RenderSystem::_applyObliqueDepthProjection(), Ogre::D3DRenderSystem::_applyObliqueDepthProjection(), Ogre::TerrainRenderable::_calculateMinLevelDist2(), _getDerivedPlane(), Ogre::Light::_getFrustumClipVolumes(), Ogre::Math::buildReflectionMatrix(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::SceneManager::createSkyboxPlane(), Ogre::SceneManager::createSkydomePlane(), Ogre::Plane::getDistance(), Ogre::Math::intersects(), Ogre::BspLevel::loadQuake3Level(), Ogre::Matrix4::operator *(), Ogre::operator<<(), Ogre::Plane::operator==(), Ogre::Plane::Plane(), Ogre::Plane::redefine(), Ogre::RenderSystem::setClipPlane(), Ogre::GLRenderSystem::setClipPlanes(), Ogre::D3D9RenderSystem::setClipPlanes(), Ogre::D3DRenderSystem::setClipPlanes(), and Ogre::Frustum::updateView().

bool Ogre::MovableObject::mCastShadows [protected, inherited]
 

Does this object cast shadows?

Definition at line 67 of file OgreMovableObject.h.

Referenced by Ogre::BillboardSet::BillboardSet(), and Ogre::MovableObject::MovableObject().

Plane Ogre::MovablePlane::mDerivedPlane [protected]
 

Definition at line 53 of file OgreMovablePlane.h.

Referenced by _getDerivedPlane().

bool Ogre::MovablePlane::mDirty [protected]
 

Definition at line 57 of file OgreMovablePlane.h.

Referenced by _getDerivedPlane().

Quaternion Ogre::MovablePlane::mLastRotate [protected]
 

Definition at line 55 of file OgreMovablePlane.h.

Referenced by _getDerivedPlane().

Vector3 Ogre::MovablePlane::mLastTranlate [protected]
 

Definition at line 54 of file OgreMovablePlane.h.

Referenced by _getDerivedPlane().

String Ogre::MovablePlane::mName [protected]
 

Definition at line 52 of file OgreMovablePlane.h.

Referenced by getName().

AxisAlignedBox Ogre::MovablePlane::mNullBB [protected]
 

Definition at line 56 of file OgreMovablePlane.h.

bool Ogre::MovableObject::mParentIsTagPoint [protected, inherited]
 

Definition at line 49 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::_notifyAttached(), and Ogre::MovableObject::MovableObject().

Node* Ogre::MovableObject::mParentNode [protected, inherited]
 

node to which this object is attached

Definition at line 48 of file OgreMovableObject.h.

Referenced by _getDerivedPlane(), Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::MovableObject::_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(), Ogre::MovableObject::getParentNode(), Ogre::MovableObject::getPointExtrusionDistance(), Ogre::Entity::getShadowVolumeRenderableIterator(), Ogre::Frustum::getSquaredViewDepth(), Ogre::MovableObject::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(), Ogre::MovableObject::isAttached(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Light::Light(), Ogre::MovableObject::MovableObject(), Ogre::SimpleRenderable::SimpleRenderable(), Ogre::Light::update(), and Ogre::Entity::updateAnimation().

unsigned long Ogre::MovableObject::mQueryFlags [protected, inherited]
 

Flags determining whether this object is included / excluded from scene queries.

Definition at line 59 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::MovableObject(), and Ogre::TerrainRenderable::TerrainRenderable().

RenderQueueGroupID Ogre::MovableObject::mRenderQueueID [protected, inherited]
 

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(), Ogre::MovableObject::getRenderQueueGroup(), Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::setRenderQueueGroup().

bool Ogre::MovableObject::mRenderQueueIDSet [protected, inherited]
 

Flags whether the RenderQueue's default should be used.

Definition at line 57 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::setRenderQueueGroup().

String Ogre::MovablePlane::msMovableType = "MovablePlane" [static, protected]
 

Definition at line 31 of file OgreMovablePlane.cpp.

Referenced by getMovableType().

UserDefinedObject* Ogre::MovableObject::mUserObject [protected, inherited]
 

User defined object which is linked to this object.

Definition at line 53 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::MovableObject().

bool Ogre::MovableObject::mVisible [protected, inherited]
 

Is this object visible?

Definition at line 51 of file OgreMovableObject.h.

Referenced by Ogre::Camera::Camera(), Ogre::Frustum::Frustum(), Ogre::MovableObject::isVisible(), Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::setVisible().

AxisAlignedBox Ogre::MovableObject::mWorldAABB [protected, inherited]
 

Cached world AABB of this object.

Definition at line 61 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::getWorldBoundingBox(), and Ogre::MovableObject::MovableObject().

Sphere Ogre::MovableObject::mWorldBoundingSphere [protected, inherited]
 

Definition at line 63 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::getWorldBoundingSphere().

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds [protected, inherited]
 

World space AABB of this object's dark cap.

Definition at line 65 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::getDarkCapBounds().

Vector3 Ogre::Plane::normal [inherited]
 

Definition at line 89 of file OgrePlane.h.

Referenced by Ogre::GLRenderSystem::_applyObliqueDepthProjection(), Ogre::D3D9RenderSystem::_applyObliqueDepthProjection(), Ogre::D3DRenderSystem::_applyObliqueDepthProjection(), Ogre::TerrainRenderable::_calculateMinLevelDist2(), _getDerivedPlane(), Ogre::Light::_getFrustumClipVolumes(), Ogre::Math::buildReflectionMatrix(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), Ogre::SceneManager::createSkyboxPlane(), Ogre::SceneManager::createSkydomePlane(), Ogre::Frustum::disableReflection(), Ogre::Frustum::Frustum(), Ogre::Plane::getDistance(), Ogre::Math::intersects(), Ogre::BspLevel::loadQuake3Level(), Ogre::Matrix4::operator *(), Ogre::operator<<(), Ogre::Plane::operator==(), Ogre::Plane::Plane(), Ogre::Plane::redefine(), Ogre::RenderSystem::setClipPlane(), Ogre::GLRenderSystem::setClipPlanes(), Ogre::D3D9RenderSystem::setClipPlanes(), Ogre::D3DRenderSystem::setClipPlanes(), Ogre::SceneManager::setSkyPlane(), and Ogre::Frustum::updateView().


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

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