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

Ogre::Entity Class Reference

Defines an instance of a discrete, movable object based on a Mesh. More...

#include <OgreEntity.h>

Inheritance diagram for Ogre::Entity:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::map< String,
MovableObject * > 
ChildObjectList
 Contains the child objects (attached to bones) indexed by name.

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

Public Methods

 ~Entity ()
 Default destructor.

MeshgetMesh (void)
 Gets the Mesh that this Entity is based on.

SubEntitygetSubEntity (unsigned int index)
 Gets a pointer to a SubEntity, ie a part of an Entity.

SubEntitygetSubEntity (const String &name)
 Gets a pointer to a SubEntity by name.

unsigned int getNumSubEntities (void) const
 Retrieves the number of SubEntity objects making up this entity.

Entity * clone (const String &newName)
 Clones this entity and returns a pointer to the clone.

void setMaterialName (const String &name)
 Sets the material to use for the whole of this entity.

void _notifyCurrentCamera (Camera *cam)
 Overridden - see MovableObject.

const AxisAlignedBoxgetBoundingBox (void) const
 Overridden - see MovableObject.

AxisAlignedBox getChildObjectsBoundingBox (void) const
 merge all the child object Bounds a return it

void _updateRenderQueue (RenderQueue *queue)
 Overridden - see MovableObject.

const StringgetName (void) const
 Overridden from MovableObject.

const StringgetMovableType (void) const
 Overridden from MovableObject.

AnimationStategetAnimationState (const String &name)
 For entities based on animated meshes, gets the AnimationState object for a single animation.

AnimationStateSetgetAllAnimationStates (void)
 For entities based on animated meshes, gets the AnimationState objects for all animations.

void setDisplaySkeleton (bool display)
 Tells the Entity whether or not it should display it's skeleton, if it has one.

void setMeshLodBias (Real factor, ushort maxDetailIndex=0, ushort minDetailIndex=99)
 Sets a level-of-detail bias for the mesh detail of this entity.

void setMaterialLodBias (Real factor, ushort maxDetailIndex=0, ushort minDetailIndex=99)
 Sets a level-of-detail bias for the material detail of this entity.

void setRenderDetail (SceneDetailLevel renderDetail)
 Sets the rendering detail of this entire entity (solid, wireframe etc).

void attachObjectToBone (const String &boneName, MovableObject *pMovable, const Quaternion &offsetOrientation=Quaternion::IDENTITY, const Vector3 &offsetPosition=Vector3::ZERO)
 Attaches another object to a certain bone of the skeleton which this entity uses.

MovableObjectdetachObjectFromBone (const String &movableName)
 detach a MovableObject previously attached using attachObjectToBone

ChildObjectListIterator getAttachedObjectIterator (void)
 Gets an iterator to the list of objects attached to bones on this entity.

Real getBoundingRadius (void) const
void setNormaliseNormals (bool normalise)
 If set to true, this forces normals of this entity to be normalised dynamically by the hardware.

bool getNormaliseNormals (void) const
 Returns true if this entity has auto-normalisation of normals set.

EdgeDatagetEdgeList (void)
 Overridden member from ShadowCaster.

ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 Overridden member from ShadowCaster.

const Matrix4_getBoneMatrices (void)
 Internal method for retrieving bone matrix information.

unsigned short _getNumBoneMatrices (void)
 Internal method for retrieving bone matrix information.

bool hasSkeleton (void)
 Returns whether or not this entity is skeletally animated.

SkeletonInstancegetSkeleton (void)
 Get this Entity's personal skeleton instance.

bool isHardwareSkinningEnabled (void)
 Returns whether or not hardware skinning is enabled.

void _notifyAttached (Node *parent, bool isTagPoint=false)
 Overridden from MovableObject.

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

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.

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.


Protected Types

typedef std::vector< SubEntity * > SubEntityList
 List of SubEntities (point to SubMeshes).

typedef std::vector< Entity * > LODEntityList
 List of LOD Entity instances (for manual LODs).


Protected Methods

 Entity ()
 Private constructor (instances cannot be created directly).

 Entity (const String &name, Mesh *mesh, SceneManager *creator)
 Private constructor - specify name (the usual constructor used).

const VertexDatafindBlendedVertexData (const VertexData *orig)
 Internal method - given vertex data which could be from the Mesh or any submesh, finds the temporary blend copy.

SubEntityfindSubEntityForVertexData (const VertexData *orig)
 Internal method - given vertex data which could be from the Mesh or any SubMesh, finds the corresponding SubEntity.

void extractTempBufferInfo (VertexData *sourceData, TempBlendedBufferInfo *info)
 Internal method for extracting metadata out of source vertex data for fast assignment of temporary buffers later.

VertexDatacloneVertexDataRemoveBlendInfo (const VertexData *source)
 Internal method to clone vertex data definitions but to remove blend buffers.

void prepareTempBlendBuffers (void)
 Internal method for preparing this Entity for use in animation.

void updateAnimation (void)
 Perform all the updates required for an animated entity.

void cacheBoneMatrices (void)
 Private method to cache bone matrices from skeleton.

void buildSubEntityList (Mesh *mesh, SubEntityList *sublist)
 Builds a list of SubEntities based on the SubMeshes contained in the Mesh.

void attachObjectImpl (MovableObject *pMovable, TagPoint *pAttachingPoint)
 internal implementation of attaching a 'child' object to this entity and assign the parent node to the child entity

void reevaluateVertexProcessing (void)
 Trigger reevaluation of the kind of vertex processing in use.

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
 Name of the entity; used for location in the scene.

MeshmMesh
 The Mesh that this Entity is based on.

SubEntityList mSubEntityList
SceneManagermCreatorSceneManager
 Pointer back to the SceneManager that created this instance, for notification purposes.

AnimationStateSet mAnimationState
 State of animation for animable meshes.

TempBlendedBufferInfo mTempBlendedBuffer
 Temp blend buffer details for shared geometry.

VertexDatamSharedBlendedVertexData
 Temp blend buffer details for shared geometry.

Matrix4mBoneMatrices
 Cached bone matrices, including any world transform.

unsigned short mNumBoneMatrices
unsigned long mFrameAnimationLastUpdated
 Records the last frame in which animation was updated.

bool mDisplaySkeleton
 Flag determines whether or not to display skeleton.

bool mHardwareSkinning
 Flag indicating whether hardware skinning is supported by this entities materials.

bool mVertexProgramInUse
 Flag indicating whether we have a vertex program in use on any of our subentities.

ushort mMeshLodIndex
 The LOD number of the mesh to use, calculated by _notifyCurrentCamera.

Real mMeshLodFactorInv
 LOD bias factor, inverted for optimisation when calculating adjusted depth.

ushort mMinMeshLodIndex
 Index of minimum detail LOD (NB higher index is lower detail).

ushort mMaxMeshLodIndex
 Index of maximum detail LOD (NB lower index is higher detail).

Real mMaterialLodFactorInv
 LOD bias factor, inverted for optimisation when calculating adjusted depth.

ushort mMinMaterialLodIndex
 Index of minimum detail LOD (NB higher index is lower detail).

ushort mMaxMaterialLodIndex
 Index of maximum detail LOD (NB lower index is higher detail).

bool mUsingManualLOD
 Flag indicating that mesh uses manual LOD and so might have multiple SubEntity versions.

LODEntityList mLodEntityList
SkeletonInstancemSkeletonInstance
 This Entity's personal copy of the skeleton, if skeletally animated.

ChildObjectList mChildObjectList
AxisAlignedBoxmFullBoundingBox
 Bounding box that 'contains' all the mesh of each child entity.

bool mNormaliseNormals
ShadowRenderableList mShadowRenderables
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.

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 = "Entity"
 Shared class-level name for Movable type.


Friends

class SceneManager
class SubEntity

Detailed Description

Defines an instance of a discrete, movable object based on a Mesh.

Remarks:
Ogre generally divides renderable objects into 2 groups, discrete (separate) and relatively small objects which move around the world, and large, sprawling geometry which makes up generally immovable scenery, aka 'level geometry'.

The Mesh and SubMesh classes deal with the definition of the geometry used by discrete movable objects. Entities are actual instances of objects based on this geometry in the world. Therefore there is usually a single set Mesh for a car, but there may be multiple entities based on it in the world. Entities are able to override aspects of the Mesh it is defined by, such as changing material properties per instance (so you can have many cars using the same geometry but different textures for example). Because a Mesh is split into SubMeshes for this purpose, the Entity class is a grouping class (much like the Mesh class) and much of the detail regarding individual changes is kept in the SubEntity class. There is a 1:1 relationship between SubEntity instances and the SubMesh instances associated with the Mesh the Entity is based on.

Entity and SubEntity classes are never created directly. Use the createEntity method of the SceneManager (passing a model name) to create one.

Entities are included in the scene by associating them with a SceneNode, using the attachEntity method. See the SceneNode class for full information.

Note:
No functions were declared virtual to improve performance.

Definition at line 70 of file OgreEntity.h.


Member Typedef Documentation

typedef std::map<String, MovableObject*> Ogre::Entity::ChildObjectList
 

Contains the child objects (attached to bones) indexed by name.

Definition at line 192 of file OgreEntity.h.

typedef MapIterator<ChildObjectList> Ogre::Entity::ChildObjectListIterator
 

Definition at line 398 of file OgreEntity.h.

Referenced by getAttachedObjectIterator().

typedef std::vector<Entity*> Ogre::Entity::LODEntityList [protected]
 

List of LOD Entity instances (for manual LODs).

We don't know when the mesh is using manual LODs whether one LOD to the next will have the same number of SubMeshes, therefore we have to allow a separate Entity list with each alternate one.

Definition at line 174 of file OgreEntity.h.

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 getShadowVolumeRenderableIterator().

typedef std::vector<SubEntity*> Ogre::Entity::SubEntityList [protected]
 

List of SubEntities (point to SubMeshes).

Definition at line 94 of file OgreEntity.h.

Referenced by Entity().


Constructor & Destructor Documentation

Ogre::Entity::Entity   [protected]
 

Private constructor (instances cannot be created directly).

Definition at line 51 of file OgreEntity.cpp.

References mFrameAnimationLastUpdated, mFullBoundingBox, mHardwareSkinning, mNormaliseNormals, and mSkeletonInstance.

Referenced by Entity().

Ogre::Entity::Entity const String   name,
Mesh   mesh,
SceneManager   creator
[protected]
 

Private constructor - specify name (the usual constructor used).

Definition at line 60 of file OgreEntity.cpp.

References Ogre::Mesh::_initAnimationState(), buildSubEntityList(), Entity(), Ogre::Mesh::getLodLevel(), Ogre::Skeleton::getNumBones(), Ogre::Mesh::getNumLodLevels(), Ogre::Mesh::getSkeleton(), hasSkeleton(), Ogre::Mesh::hasSkeleton(), Ogre::Mesh::isLodManual(), Ogre::SkeletonInstance::load(), mAnimationState, Ogre::Mesh::MeshLodUsage::manualMesh, mBoneMatrices, mCreatorSceneManager, mDisplaySkeleton, mFrameAnimationLastUpdated, mFullBoundingBox, mHardwareSkinning, mLodEntityList, mMaterialLodFactorInv, mMaxMaterialLodIndex, mMaxMeshLodIndex, mMesh, mMeshLodFactorInv, mMeshLodIndex, mMinMaterialLodIndex, mMinMeshLodIndex, mNumBoneMatrices, mSharedBlendedVertexData, mSkeletonInstance, mSubEntityList, prepareTempBlendBuffers(), reevaluateVertexProcessing(), SubEntityList, and Ogre::ushort.

Ogre::Entity::~Entity  
 

Default destructor.

Definition at line 133 of file OgreEntity.cpp.

References mBoneMatrices, mFullBoundingBox, mLodEntityList, mShadowRenderables, mSkeletonInstance, and mSubEntityList.


Member Function Documentation

const Matrix4* Ogre::Entity::_getBoneMatrices void   
 

Internal method for retrieving bone matrix information.

Definition at line 427 of file OgreEntity.h.

unsigned short Ogre::Entity::_getNumBoneMatrices void   
 

Internal method for retrieving bone matrix information.

Definition at line 429 of file OgreEntity.h.

Referenced by Ogre::Entity::EntityShadowRenderable::getWorldTransforms().

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

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

Definition at line 94 of file OgreMovableObject.cpp.

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

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

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

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

Definition at line 964 of file OgreEntity.cpp.

References mLodEntityList.

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

Overridden - see MovableObject.

Implements Ogre::MovableObject.

Definition at line 224 of file OgreEntity.cpp.

References Ogre::Camera::_getLodBiasInverse(), Ogre::Mesh::getLodIndexSquaredDepth(), Ogre::Node::getSquaredViewDepth(), mChildObjectList, mMaterialLodFactorInv, mMaxMaterialLodIndex, mMaxMeshLodIndex, mMesh, mMeshLodFactorInv, mMeshLodIndex, mMinMaterialLodIndex, mMinMeshLodIndex, Ogre::MovableObject::mParentNode, mSubEntityList, and Ogre::Real.

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

Overridden - see MovableObject.

Implements Ogre::MovableObject.

Definition at line 305 of file OgreEntity.cpp.

References Ogre::RenderQueue::addRenderable(), Ogre::Skeleton::getBone(), Ogre::Skeleton::getNumBones(), hasSkeleton(), Ogre::Mesh::isLodManual(), mChildObjectList, mDisplaySkeleton, mLodEntityList, mMesh, mMeshLodIndex, Ogre::MovableObject::mRenderQueueID, mSkeletonInstance, mSubEntityList, RENDERABLE_DEFAULT_PRIORITY, and updateAnimation().

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 174 of file OgreMovableObject.h.

void Ogre::Entity::attachObjectImpl MovableObject   pMovable,
TagPoint   pAttachingPoint
[protected]
 

internal implementation of attaching a 'child' object to this entity and assign the parent node to the child entity

Definition at line 571 of file OgreEntity.cpp.

References Ogre::MovableObject::_notifyAttached(), Ogre::MovableObject::getName(), and mChildObjectList.

Referenced by attachObjectToBone().

void Ogre::Entity::attachObjectToBone const String   boneName,
MovableObject   pMovable,
const Quaternion   offsetOrientation = Quaternion::IDENTITY,
const Vector3   offsetPosition = Vector3::ZERO
 

Attaches another object to a certain bone of the skeleton which this entity uses.

Remarks:
This method can be used to attach another object to an animated part of this entity, by attaching it to a bone in the skeleton (with an offset if required). As this entity is animated, the attached object will move relative to the bone to which it is attached.
Parameters:
boneName  The name of the bone (in the skeleton) to attach this object
pMovable  Pointer to the object to attach
offsetOrientation  An adjustment to the orientation of the attached object, relative to the bone.
offsetPosition  An adjustment to the position of the attached object, relative to the bone.

Definition at line 543 of file OgreEntity.cpp.

References attachObjectImpl(), Ogre::SkeletonInstance::createTagPointOnBone(), Except, Ogre::Skeleton::getBone(), hasSkeleton(), Ogre::MovableObject::isAttached(), mSkeletonInstance, Ogre::TagPoint::setChildObject(), and Ogre::TagPoint::setParentEntity().

void Ogre::Entity::buildSubEntityList Mesh   mesh,
SubEntityList   sublist
[protected]
 

Builds a list of SubEntities based on the SubMeshes contained in the Mesh.

Definition at line 513 of file OgreEntity.cpp.

References Ogre::SubMesh::getMaterialName(), Ogre::Mesh::getNumSubMeshes(), Ogre::Mesh::getSubMesh(), Ogre::SubMesh::isMatInitialised(), Ogre::SubEntity::setMaterialName(), and SubEntity.

Referenced by Entity().

void Ogre::Entity::cacheBoneMatrices void    [protected]
 

Private method to cache bone matrices from skeleton.

Definition at line 442 of file OgreEntity.cpp.

References Ogre::Skeleton::_getBoneMatrices(), Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::Mesh::getLodLevel(), Ogre::Skeleton::getNumBones(), Ogre::Mesh::hasSkeleton(), Ogre::Mesh::isLodManual(), mAnimationState, mBoneMatrices, mChildObjectList, mMesh, mMeshLodIndex, mNumBoneMatrices, mSkeletonInstance, and Ogre::Skeleton::setAnimationState().

Referenced by updateAnimation().

Entity * Ogre::Entity::clone const String   newName
 

Clones this entity and returns a pointer to the clone.

Remarks:
Useful method for duplicating an entity. The new entity must be given a unique name, and is not attached to the scene in any way so must be attached to a SceneNode to be visible (exactly as entities returned from SceneManager::createEntity).
Parameters:
newName  Name for the new entity.

Definition at line 198 of file OgreEntity.cpp.

References Ogre::SceneManager::createEntity(), getMesh(), getName(), getSubEntity(), mAnimationState, mCreatorSceneManager, mSubEntityList, and Ogre::SubEntity::setMaterialName().

VertexData * Ogre::Entity::cloneVertexDataRemoveBlendInfo const VertexData   source [protected]
 

Internal method to clone vertex data definitions but to remove blend buffers.

Definition at line 678 of file OgreEntity.cpp.

References Ogre::VertexData::clone(), Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexElement::getSource(), Ogre::VertexData::hardwareShadowVolWBuffer, Ogre::SharedPtr< HardwareVertexBuffer >::isNull(), Ogre::VertexDeclaration::removeElement(), Ogre::VertexBufferBinding::unsetBinding(), Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexDeclaration, Ogre::VES_BLEND_INDICES, and Ogre::VES_BLEND_WEIGHTS.

Referenced by Ogre::SubEntity::prepareTempBlendBuffers(), and prepareTempBlendBuffers().

MovableObject * Ogre::Entity::detachObjectFromBone const String   movableName
 

detach a MovableObject previously attached using attachObjectToBone

Definition at line 578 of file OgreEntity.cpp.

References Except, and mChildObjectList.

void Ogre::Entity::extractTempBufferInfo VertexData   sourceData,
TempBlendedBufferInfo   info
[protected]
 

Internal method for extracting metadata out of source vertex data for fast assignment of temporary buffers later.

Definition at line 645 of file OgreEntity.cpp.

References Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexBufferBinding::getBuffer(), Ogre::VertexElement::getSource(), Ogre::TempBlendedBufferInfo::normBindIndex, Ogre::TempBlendedBufferInfo::posBindIndex, Ogre::TempBlendedBufferInfo::posNormalShareBuffer, Ogre::SharedPtr< HardwareVertexBuffer >::release(), Ogre::TempBlendedBufferInfo::srcNormalBuffer, Ogre::TempBlendedBufferInfo::srcPositionBuffer, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexDeclaration, Ogre::VES_NORMAL, and Ogre::VES_POSITION.

Referenced by Ogre::SubEntity::prepareTempBlendBuffers(), and prepareTempBlendBuffers().

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 274 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 235 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 getShadowVolumeRenderableIterator().

const VertexData * Ogre::Entity::findBlendedVertexData const VertexData   orig [protected]
 

Internal method - given vertex data which could be from the Mesh or any submesh, finds the temporary blend copy.

Definition at line 920 of file OgreEntity.cpp.

References Except, Ogre::SubEntity::getBlendedVertexData(), Ogre::SubEntity::getSubMesh(), mMesh, mSharedBlendedVertexData, mSubEntityList, Ogre::Mesh::sharedVertexData, and Ogre::SubMesh::vertexData.

Referenced by getShadowVolumeRenderableIterator().

SubEntity * Ogre::Entity::findSubEntityForVertexData const VertexData   orig [protected]
 

Internal method - given vertex data which could be from the Mesh or any SubMesh, finds the corresponding SubEntity.

Definition at line 942 of file OgreEntity.cpp.

References Ogre::SubEntity::getSubMesh(), mMesh, mSubEntityList, Ogre::Mesh::sharedVertexData, and Ogre::SubMesh::vertexData.

Referenced by 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 getShadowVolumeRenderableIterator().

AnimationStateSet * Ogre::Entity::getAllAnimationStates void   
 

For entities based on animated meshes, gets the AnimationState objects for all animations.

Remarks:
You animate an entity by updating the animation state objects. Each of these represents the current state of each animation available to the entity. The AnimationState objects are initialised from the Mesh object.

Definition at line 373 of file OgreEntity.cpp.

References Ogre::AnimationStateSet, and mAnimationState.

AnimationState * Ogre::Entity::getAnimationState const String   name
 

For entities based on animated meshes, gets the AnimationState object for a single animation.

Remarks:
You animate an entity by updating the animation state objects. Each of these represents the current state of each animation available to the entity. The AnimationState objects are initialised from the Mesh object.

Definition at line 360 of file OgreEntity.cpp.

References Except, and mAnimationState.

Entity::ChildObjectListIterator Ogre::Entity::getAttachedObjectIterator void   
 

Gets an iterator to the list of objects attached to bones on this entity.

Definition at line 593 of file OgreEntity.cpp.

References ChildObjectListIterator, and mChildObjectList.

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

Overridden - see MovableObject.

Implements Ogre::MovableObject.

Definition at line 273 of file OgreEntity.cpp.

References Ogre::Mesh::getBounds(), getChildObjectsBoundingBox(), Ogre::AxisAlignedBox::merge(), mFullBoundingBox, and mMesh.

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

See also:
MovableObject::getBoundingRadius

Implements Ogre::MovableObject.

Definition at line 598 of file OgreEntity.cpp.

References Ogre::Node::_getDerivedScale(), Ogre::Mesh::getBoundingSphereRadius(), mMesh, Ogre::MovableObject::mParentNode, Ogre::Real, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Definition at line 212 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().

AxisAlignedBox Ogre::Entity::getChildObjectsBoundingBox void    const
 

merge all the child object Bounds a return it

Definition at line 284 of file OgreEntity.cpp.

References Ogre::TagPoint::_getFullLocalTransform(), mChildObjectList, Ogre::AxisAlignedBox::merge(), Ogre::AxisAlignedBox::setNull(), and Ogre::AxisAlignedBox::transform().

Referenced by getBoundingBox().

const AxisAlignedBox & Ogre::MovableObject::getDarkCapBounds const Light   light,
Real    dirLightExtrusionDist
const [virtual, inherited]
 

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

Definition at line 135 of file OgreMovableObject.cpp.

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

EdgeData * Ogre::Entity::getEdgeList void    [virtual]
 

Overridden member from ShadowCaster.

Reimplemented from Ogre::MovableObject.

Definition at line 710 of file OgreEntity.cpp.

References Ogre::Mesh::getEdgeList(), mMesh, and mMeshLodIndex.

Referenced by getShadowVolumeRenderableIterator().

Real Ogre::ShadowCaster::getExtrusionDistance const Vector3   objectPos,
const Light   light
const [protected, inherited]
 

Helper moethod for calculating extrusion distance.

Definition at line 320 of file OgreShadowCaster.cpp.

References Ogre::Light::getAttenuationRange(), Ogre::Light::getDerivedPosition(), Ogre::Vector3::length(), and Ogre::Real.

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

const AxisAlignedBox & Ogre::MovableObject::getLightCapBounds void    const [virtual, inherited]
 

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

Definition at line 129 of file OgreMovableObject.cpp.

References Ogre::MovableObject::getWorldBoundingBox().

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

Mesh * Ogre::Entity::getMesh void   
 

Gets the Mesh that this Entity is based on.

Definition at line 168 of file OgreEntity.cpp.

References mMesh.

Referenced by clone().

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 378 of file OgreEntity.cpp.

References msMovableType.

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 173 of file OgreEntity.cpp.

References mName.

Referenced by clone(), and Ogre::SubEntity::setMaterialName().

bool Ogre::Entity::getNormaliseNormals void    const
 

Returns true if this entity has auto-normalisation of normals set.

Definition at line 414 of file OgreEntity.h.

unsigned int Ogre::Entity::getNumSubEntities void    const
 

Retrieves the number of SubEntity objects making up this entity.

Definition at line 193 of file OgreEntity.cpp.

References mSubEntityList.

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

Returns the node to which this object is attached.

Remarks:
An object is not visible in the scene unless attached to a SceneNode.

Attaching an object is done via the SceneNode::attachObject method.

Definition at line 62 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentNode.

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

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 145 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 181 of file OgreMovableObject.h.

Referenced by 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 89 of file OgreMovableObject.cpp.

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

ShadowCaster::ShadowRenderableListIterator Ogre::Entity::getShadowVolumeRenderableIterator ShadowTechnique    shadowTechnique,
const Light   light,
HardwareIndexBufferSharedPtr   indexBuffer,
bool    extrudeVertices,
Real    extrusionDistance,
unsigned long    flags = 0
[virtual]
 

Overridden member from ShadowCaster.

Reimplemented from Ogre::MovableObject.

Definition at line 765 of file OgreEntity.cpp.

References Ogre::Node::_getFullTransform(), Ogre::EdgeData::edgeGroups, Ogre::ShadowCaster::extrudeVertices(), findBlendedVertexData(), findSubEntityForVertexData(), Ogre::ShadowCaster::generateShadowVolume(), Ogre::Light::getAs4DVector(), getEdgeList(), Ogre::Entity::EntityShadowRenderable::getPositionBuffer(), hasSkeleton(), Ogre::Matrix4::inverse(), Ogre::Mesh::isLodManual(), Ogre::Mesh::isPreparedForShadowVolumes(), mFrameAnimationLastUpdated, mLodEntityList, mMesh, mMeshLodIndex, Ogre::MovableObject::mParentNode, mShadowRenderables, mVertexProgramInUse, Ogre::Mesh::prepareForShadowVolume(), prepareTempBlendBuffers(), Ogre::Real, Ogre::ShadowCaster::ShadowRenderableListIterator, Ogre::ShadowTechnique, Ogre::Mesh::sharedVertexData, updateAnimation(), Ogre::ShadowCaster::updateEdgeListLightFacing(), and Ogre::EdgeData::updateFaceNormals().

SkeletonInstance* Ogre::Entity::getSkeleton void   
 

Get this Entity's personal skeleton instance.

Definition at line 433 of file OgreEntity.h.

SubEntity * Ogre::Entity::getSubEntity const String   name
 

Gets a pointer to a SubEntity by name.

Remarks:
- names should be initialized during a Mesh creation.

Definition at line 187 of file OgreEntity.cpp.

References Ogre::Mesh::_getSubMeshIndex(), getSubEntity(), mMesh, and Ogre::ushort.

SubEntity * Ogre::Entity::getSubEntity unsigned int    index
 

Gets a pointer to a SubEntity, ie a part of an Entity.

Definition at line 178 of file OgreEntity.cpp.

References Except, and mSubEntityList.

Referenced by Ogre::SceneManager::_queueSkiesForRendering(), clone(), and getSubEntity().

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 142 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 106 of file OgreMovableObject.cpp.

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

Referenced by 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 118 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::Entity::hasSkeleton void   
 

Returns whether or not this entity is skeletally animated.

Definition at line 431 of file OgreEntity.h.

Referenced by _updateRenderQueue(), attachObjectToBone(), Entity(), Ogre::SubEntity::getRenderOperation(), getShadowVolumeRenderableIterator(), and prepareTempBlendBuffers().

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

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

Definition at line 67 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentNode.

Referenced by attachObjectToBone().

bool Ogre::Entity::isHardwareSkinningEnabled void   
 

Returns whether or not hardware skinning is enabled.

Remarks:
Because fixed-function indexed vertex blending is rarely supported by existing graphics cards, hardware skinning can only be done if the vertex programs in the materials used to render an entity support it. Therefore, this method will only return true if all the materials assigned to this entity have vertex programs assigned, and all those vertex programs must support 'include_skeletal_animation true'.

Definition at line 443 of file OgreEntity.h.

Referenced by updateAnimation().

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

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

Definition at line 78 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mVisible.

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

void Ogre::Entity::prepareTempBlendBuffers void    [protected]
 

Internal method for preparing this Entity for use in animation.

Definition at line 610 of file OgreEntity.cpp.

References cloneVertexDataRemoveBlendInfo(), extractTempBufferInfo(), hasSkeleton(), mMesh, mSharedBlendedVertexData, mSubEntityList, mTempBlendedBuffer, Ogre::SubEntity::prepareTempBlendBuffers(), and Ogre::Mesh::sharedVertexData.

Referenced by Entity(), and getShadowVolumeRenderableIterator().

void Ogre::Entity::reevaluateVertexProcessing void    [protected]
 

Trigger reevaluation of the kind of vertex processing in use.

Definition at line 716 of file OgreEntity.cpp.

References Ogre::Material::getBestTechnique(), Ogre::Technique::getPass(), Ogre::Pass::getVertexProgram(), Ogre::Pass::hasVertexProgram(), Ogre::GpuProgram::isSkeletalAnimationIncluded(), Ogre::Material::load(), mHardwareSkinning, mSubEntityList, and mVertexProgramInUse.

Referenced by Entity(), and Ogre::SubEntity::setMaterialName().

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 178 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 210 of file OgreMovableObject.h.

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

void Ogre::Entity::setDisplaySkeleton bool    display
 

Tells the Entity whether or not it should display it's skeleton, if it has one.

Definition at line 490 of file OgreEntity.cpp.

References mDisplaySkeleton.

void Ogre::Entity::setMaterialLodBias Real    factor,
ushort    maxDetailIndex = 0,
ushort    minDetailIndex = 99
 

Sets a level-of-detail bias for the material detail of this entity.

Remarks:
Level of detail reduction is normally applied automatically based on the Material settings. However, it is possible to influence this behaviour for this entity by adjusting the LOD bias. This 'nudges' the material level of detail used for this entity up or down depending on your requirements. You might want to use this if there was a particularly important entity in your scene which you wanted to detail better than the others, such as a player model.

There are three parameters to this method; the first is a factor to apply; it defaults to 1.0 (no change), by increasing this to say 2.0, this entity would take twice as long to use a lower detail material, whilst at 0.5 this entity would use lower detail versions twice as quickly. The other 2 parameters are hard limits which let you set the maximum and minimum level-of-detail index to use, after all other calculations have been made. This lets you say that this entity should never be simplified, or that it can only use LODs below a certain level even when right next to the camera.

Parameters:
factor  Proportional factor to apply to the distance at which LOD is changed. Higher values increase the distance at which higher LODs are displayed (2.0 is twice the normal distance, 0.5 is half).
maxDetailIndex  The index of the maximum LOD this entity is allowed to use (lower indexes are higher detail: index 0 is the original full detail model).
minDetailIndex  The index of the minimum LOD this entity is allowed to use (higher indexes are lower detail. Use something like 99 if you want unlimited LODs (the actual LOD will be limited by the number of lod indexes used in the Material)

Definition at line 504 of file OgreEntity.cpp.

References mMaterialLodFactorInv, mMaxMaterialLodIndex, mMinMaterialLodIndex, Ogre::Real, and Ogre::ushort.

void Ogre::Entity::setMaterialName const String   name
 

Sets the material to use for the whole of this entity.

Remarks:
This is a shortcut method to set all the materials for all subentities of this entity. Only use this method is you want to set the same material for all subentities or if you know there is only one. Otherwise call getSubEntity() and call the same method on the individual SubEntity.

Definition at line 213 of file OgreEntity.cpp.

References mSubEntityList.

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

void Ogre::Entity::setMeshLodBias Real    factor,
ushort    maxDetailIndex = 0,
ushort    minDetailIndex = 99
 

Sets a level-of-detail bias for the mesh detail of this entity.

Remarks:
Level of detail reduction is normally applied automatically based on the Mesh settings. However, it is possible to influence this behaviour for this entity by adjusting the LOD bias. This 'nudges' the mesh level of detail used for this entity up or down depending on your requirements. You might want to use this if there was a particularly important entity in your scene which you wanted to detail better than the others, such as a player model.

There are three parameters to this method; the first is a factor to apply; it defaults to 1.0 (no change), by increasing this to say 2.0, this model would take twice as long to reduce in detail, whilst at 0.5 this entity would use lower detail versions twice as quickly. The other 2 parameters are hard limits which let you set the maximum and minimum level-of-detail version to use, after all other calculations have been made. This lets you say that this entity should never be simplified, or that it can only use LODs below a certain level even when right next to the camera.

Parameters:
factor  Proportional factor to apply to the distance at which LOD is changed. Higher values increase the distance at which higher LODs are displayed (2.0 is twice the normal distance, 0.5 is half).
maxDetailIndex  The index of the maximum LOD this entity is allowed to use (lower indexes are higher detail: index 0 is the original full detail model).
minDetailIndex  The index of the minimum LOD this entity is allowed to use (higher indexes are lower detail. Use something like 99 if you want unlimited LODs (the actual LOD will be limited by the number in the Mesh)

Definition at line 495 of file OgreEntity.cpp.

References mMaxMeshLodIndex, mMeshLodFactorInv, mMinMeshLodIndex, Ogre::Real, and Ogre::ushort.

void Ogre::Entity::setNormaliseNormals bool    normalise
 

If set to true, this forces normals of this entity to be normalised dynamically by the hardware.

Remarks:
This option can be used to prevent lighting variations when scaling an Entity using a SceneNode - normally because this scaling is hardware based, the normals get scaled too which causes lighting to become inconsistent. However, this has an overhead so only do this if you really need to.

Definition at line 411 of file OgreEntity.h.

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 170 of file OgreMovableObject.h.

void Ogre::Entity::setRenderDetail SceneDetailLevel    renderDetail
 

Sets the rendering detail of this entire entity (solid, wireframe etc).

Definition at line 531 of file OgreEntity.cpp.

References mSubEntityList, and Ogre::SceneDetailLevel.

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 RENDER_QUEUE_MAIN 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.

Definition at line 84 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mRenderQueueID, 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 138 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 73 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mVisible.

void Ogre::Entity::updateAnimation void    [protected]
 

Perform all the updates required for an animated entity.

Definition at line 383 of file OgreEntity.cpp.

References Ogre::Root::_getCurrentSceneManager(), Ogre::TempBlendedBufferInfo::bindTempCopies(), cacheBoneMatrices(), Ogre::TempBlendedBufferInfo::checkoutTempCopies(), Ogre::Root::getCurrentFrameNumber(), Ogre::SceneManager::getShadowTechnique(), isHardwareSkinningEnabled(), Ogre::SubEntity::isVisible(), Ogre::SubEntity::mBlendedVertexData, mBoneMatrices, mChildObjectList, mFrameAnimationLastUpdated, mHardwareSkinning, mMesh, Ogre::MovableObject::mParentNode, mSharedBlendedVertexData, mSubEntityList, Ogre::SubEntity::mSubMesh, Ogre::SubEntity::mTempBlendedBuffer, mTempBlendedBuffer, Ogre::Node::needUpdate(), Ogre::SHADOWTYPE_STENCIL_ADDITIVE, Ogre::SHADOWTYPE_STENCIL_MODULATIVE, Ogre::Mesh::sharedVertexData, and Ogre::SubMesh::vertexData.

Referenced by _updateRenderQueue(), and getShadowVolumeRenderableIterator().

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 getShadowVolumeRenderableIterator().


Friends And Related Function Documentation

friend class SceneManager [friend]
 

Definition at line 73 of file OgreEntity.h.

friend class SubEntity [friend]
 

Definition at line 74 of file OgreEntity.h.

Referenced by buildSubEntityList().


Member Data Documentation

AnimationStateSet Ogre::Entity::mAnimationState [protected]
 

State of animation for animable meshes.

Definition at line 104 of file OgreEntity.h.

Referenced by cacheBoneMatrices(), clone(), Entity(), getAllAnimationStates(), and getAnimationState().

Matrix4* Ogre::Entity::mBoneMatrices [protected]
 

Cached bone matrices, including any world transform.

Definition at line 131 of file OgreEntity.h.

Referenced by cacheBoneMatrices(), Entity(), Ogre::SubEntity::getWorldTransforms(), updateAnimation(), and ~Entity().

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

Does this object cast shadows?

Definition at line 65 of file OgreMovableObject.h.

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

ChildObjectList Ogre::Entity::mChildObjectList [protected]
 

Definition at line 194 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), _updateRenderQueue(), attachObjectImpl(), cacheBoneMatrices(), detachObjectFromBone(), getAttachedObjectIterator(), getChildObjectsBoundingBox(), and updateAnimation().

SceneManager* Ogre::Entity::mCreatorSceneManager [protected]
 

Pointer back to the SceneManager that created this instance, for notification purposes.

Definition at line 100 of file OgreEntity.h.

Referenced by clone(), and Entity().

bool Ogre::Entity::mDisplaySkeleton [protected]
 

Flag determines whether or not to display skeleton.

Definition at line 143 of file OgreEntity.h.

Referenced by _updateRenderQueue(), Entity(), and setDisplaySkeleton().

unsigned long Ogre::Entity::mFrameAnimationLastUpdated [protected]
 

Records the last frame in which animation was updated.

Definition at line 134 of file OgreEntity.h.

Referenced by Entity(), getShadowVolumeRenderableIterator(), and updateAnimation().

AxisAlignedBox* Ogre::Entity::mFullBoundingBox [protected]
 

Bounding box that 'contains' all the mesh of each child entity.

Definition at line 198 of file OgreEntity.h.

Referenced by Entity(), getBoundingBox(), and ~Entity().

bool Ogre::Entity::mHardwareSkinning [protected]
 

Flag indicating whether hardware skinning is supported by this entities materials.

Definition at line 145 of file OgreEntity.h.

Referenced by Entity(), Ogre::SubEntity::getRenderOperation(), reevaluateVertexProcessing(), and updateAnimation().

LODEntityList Ogre::Entity::mLodEntityList [protected]
 

Definition at line 175 of file OgreEntity.h.

Referenced by _notifyAttached(), _updateRenderQueue(), Entity(), getShadowVolumeRenderableIterator(), and ~Entity().

Real Ogre::Entity::mMaterialLodFactorInv [protected]
 

LOD bias factor, inverted for optimisation when calculating adjusted depth.

Definition at line 161 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMaterialLodBias().

ushort Ogre::Entity::mMaxMaterialLodIndex [protected]
 

Index of maximum detail LOD (NB lower index is higher detail).

Definition at line 165 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMaterialLodBias().

ushort Ogre::Entity::mMaxMeshLodIndex [protected]
 

Index of maximum detail LOD (NB lower index is higher detail).

Definition at line 158 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMeshLodBias().

Mesh* Ogre::Entity::mMesh [protected]
 

The Mesh that this Entity is based on.

Definition at line 90 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), _updateRenderQueue(), cacheBoneMatrices(), Entity(), findBlendedVertexData(), findSubEntityForVertexData(), getBoundingBox(), getBoundingRadius(), getEdgeList(), getMesh(), getShadowVolumeRenderableIterator(), getSubEntity(), prepareTempBlendBuffers(), and updateAnimation().

Real Ogre::Entity::mMeshLodFactorInv [protected]
 

LOD bias factor, inverted for optimisation when calculating adjusted depth.

Definition at line 154 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMeshLodBias().

ushort Ogre::Entity::mMeshLodIndex [protected]
 

The LOD number of the mesh to use, calculated by _notifyCurrentCamera.

Definition at line 151 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), _updateRenderQueue(), cacheBoneMatrices(), Entity(), getEdgeList(), Ogre::SubEntity::getRenderOperation(), and getShadowVolumeRenderableIterator().

ushort Ogre::Entity::mMinMaterialLodIndex [protected]
 

Index of minimum detail LOD (NB higher index is lower detail).

Definition at line 163 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMaterialLodBias().

ushort Ogre::Entity::mMinMeshLodIndex [protected]
 

Index of minimum detail LOD (NB higher index is lower detail).

Definition at line 156 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), Entity(), and setMeshLodBias().

String Ogre::Entity::mName [protected]
 

Name of the entity; used for location in the scene.

Definition at line 86 of file OgreEntity.h.

Referenced by getName().

bool Ogre::Entity::mNormaliseNormals [protected]
 

Definition at line 200 of file OgreEntity.h.

Referenced by Entity(), and Ogre::SubEntity::getNormaliseNormals().

unsigned short Ogre::Entity::mNumBoneMatrices [protected]
 

Definition at line 132 of file OgreEntity.h.

Referenced by cacheBoneMatrices(), Entity(), Ogre::SubEntity::getNumWorldTransforms(), and Ogre::SubEntity::getWorldTransforms().

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

Definition at line 49 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::_notifyAttached(), Ogre::MovableObject::MovableObject(), 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 Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::MovableObject::_notifyAttached(), _notifyCurrentCamera(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::BillboardSet::_updateBounds(), Ogre::Camera::Camera(), Ogre::Frustum::Frustum(), Ogre::BillboardSet::genBillboardAxes(), getBoundingRadius(), Ogre::TerrainRenderable::getLights(), Ogre::SimpleRenderable::getLights(), Ogre::BillboardSet::getLights(), Ogre::MovableObject::getParentNode(), Ogre::MovableObject::getPointExtrusionDistance(), getShadowVolumeRenderableIterator(), Ogre::Frustum::getSquaredViewDepth(), Ogre::BillboardSet::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(), updateAnimation(), and Ogre::MovableObject::~MovableObject().

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

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

Definition at line 57 of file OgreMovableObject.h.

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

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

ShadowRenderableList Ogre::Entity::mShadowRenderables [protected]
 

Definition at line 202 of file OgreEntity.h.

Referenced by getShadowVolumeRenderableIterator(), and ~Entity().

VertexData* Ogre::Entity::mSharedBlendedVertexData [protected]
 

Temp blend buffer details for shared geometry.

Definition at line 113 of file OgreEntity.h.

Referenced by Entity(), findBlendedVertexData(), Ogre::SubEntity::getRenderOperation(), prepareTempBlendBuffers(), and updateAnimation().

SkeletonInstance* Ogre::Entity::mSkeletonInstance [protected]
 

This Entity's personal copy of the skeleton, if skeletally animated.

Definition at line 179 of file OgreEntity.h.

Referenced by _updateRenderQueue(), attachObjectToBone(), cacheBoneMatrices(), Entity(), and ~Entity().

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

Shared class-level name for Movable type.

Definition at line 49 of file OgreEntity.cpp.

Referenced by getMovableType().

SubEntityList Ogre::Entity::mSubEntityList [protected]
 

Definition at line 95 of file OgreEntity.h.

Referenced by _notifyCurrentCamera(), _updateRenderQueue(), clone(), Entity(), findBlendedVertexData(), findSubEntityForVertexData(), getNumSubEntities(), getSubEntity(), prepareTempBlendBuffers(), reevaluateVertexProcessing(), setMaterialName(), setRenderDetail(), updateAnimation(), and ~Entity().

TempBlendedBufferInfo Ogre::Entity::mTempBlendedBuffer [protected]
 

Temp blend buffer details for shared geometry.

Definition at line 111 of file OgreEntity.h.

Referenced by prepareTempBlendBuffers(), and updateAnimation().

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::Entity::mUsingManualLOD [protected]
 

Flag indicating that mesh uses manual LOD and so might have multiple SubEntity versions.

Definition at line 168 of file OgreEntity.h.

bool Ogre::Entity::mVertexProgramInUse [protected]
 

Flag indicating whether we have a vertex program in use on any of our subentities.

Definition at line 147 of file OgreEntity.h.

Referenced by getShadowVolumeRenderableIterator(), and reevaluateVertexProcessing().

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 59 of file OgreMovableObject.h.

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

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

Definition at line 61 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 63 of file OgreMovableObject.h.

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


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:26:03 2004