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

#include <OgreEntity.h>

Inheritance diagram for Ogre::Entity:

Classes
class	EntityShadowRenderable
	Nested class to allow entity shadows. More...
Public Types
typedef map< String, MovableObject * >::type	ChildObjectList
	Contains the child objects (attached to bones) indexed by name.
typedef MapIterator < ChildObjectList >	ChildObjectListIterator
typedef set< Entity * >::type	EntitySet
typedef map< unsigned short, bool >::type	SchemeHardwareAnimMap
typedef vector < ShadowRenderable * >::type	ShadowRenderableList
typedef VectorIterator < ShadowRenderableList >	ShadowRenderableListIterator
enum	VertexDataBindChoice { BIND_ORIGINAL, BIND_SOFTWARE_SKELETAL, BIND_SOFTWARE_MORPH, BIND_HARDWARE_MORPH }
	Identify which vertex data we should be sending to the renderer. More...
Public Member Functions
	~Entity ()
	Default destructor.
void	_deinitialise (void)
	Tear down the internal structures of this Entity, rendering it uninitialised.
const Matrix4 *	_getBoneMatrices (void) const
	Internal method for retrieving bone matrix information.
bool	_getBuffersMarkedForAnimation (void) const
	Are buffers already marked as vertex animated?
virtual MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only)
VertexData *	_getHardwareVertexAnimVertexData (void) const
	Advanced method to get the hardware morph vertex information.
virtual LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.
virtual SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only)
Real	_getMeshLodFactorTransformed () const
	Get the LOD strategy transformation of the mesh LOD factor.
unsigned short	_getNumBoneMatrices (void) const
	Internal method for retrieving bone matrix information.
virtual const Matrix4 &	_getParentNodeFullTransform (void) const
	return the full transformation of the parent sceneNode or the attachingPoint node
TempBlendedBufferInfo *	_getSkelAnimTempBufferInfo (void)
	Advanced method to get the temp buffer information for software skeletal animation.
VertexData *	_getSkelAnimVertexData (void) const
	Advanced method to get the temporarily blended skeletal vertex information for entities which are software skinned.
VertexData *	_getSoftwareVertexAnimVertexData (void) const
	Advanced method to get the temporarily blended software vertex animation information.
TempBlendedBufferInfo *	_getVertexAnimTempBufferInfo (void)
	Advanced method to get the temp buffer information for software morph animation.
void	_initialise (bool forceReinitialise=false)
	Try to initialise the Entity from the underlying resources.
bool	_isAnimated (void) const
	Tests if any animation applied to this entity.
bool	_isSkeletonAnimated (void) const
	Tests if skeleton was animated.
void	_markBuffersUsedForAnimation (void)
	Mark just this vertex data as animated.
void	_notifyAttached (Node *parent, bool isTagPoint=false)
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only)
void	_notifyCurrentCamera (Camera *cam)
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)
virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved.
void	_updateAnimation (void)
	Advanced method to perform all the updates required for an animated entity.
void	_updateRenderQueue (RenderQueue *queue)
virtual void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	addSoftwareAnimationRequest (bool normalsAlso)
	Add a request for software animation.
virtual void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
TagPoint *	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.
void	backgroundLoadingComplete (Resource *res)
	Resource::Listener hook to notify Entity that a delay-loaded Mesh is complete.
virtual OGRE_DEPRECATED void	backgroundPreparingComplete (Resource *)
	Callback to indicate that background preparing has completed.
VertexDataBindChoice	chooseVertexDataForBinding (bool hasVertexAnim)
	Choose which vertex data to bind to the renderer.
Entity *	clone (const String &newName) const
	Clones this entity and returns a pointer to the clone.
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.
void	detachAllObjectsFromBone (void)
	Detach all MovableObjects previously attached using attachObjectToBone.
virtual void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached.
MovableObject *	detachObjectFromBone (const String &movableName)
	Detach a MovableObject previously attached using attachObjectToBone.
void	detachObjectFromBone (MovableObject *obj)
	Detaches an object by pointer.
AnimationStateSet *	getAllAnimationStates (void) const
	For entities based on animated meshes, gets the AnimationState objects for all animations.
bool	getAlwaysUpdateMainSkeleton () const
	The skeleton of the main entity will be updated even if the an LOD entity is being displayed.
const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.
AnimationState *	getAnimationState (const String &name) const
	For entities based on animated meshes, gets the AnimationState object for a single animation.
ChildObjectListIterator	getAttachedObjectIterator (void)
	Gets an iterator to the list of objects attached to bones on this entity.
const AxisAlignedBox &	getBoundingBox (void) const
Real	getBoundingRadius (void) const
bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object.
AxisAlignedBox	getChildObjectsBoundingBox (void) const
	Merge all the child object Bounds a return it.
ushort	getCurrentLodIndex ()
	Returns the current LOD used to render.
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Overridden member from ShadowCaster.
bool	getDisplaySkeleton (void) const
	Returns whether or not the entity is currently displaying its skeleton.
EdgeData *	getEdgeList (void)
const AxisAlignedBox &	getLightCapBounds (void) const
	Overridden member from ShadowCaster.
virtual uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
virtual Listener *	getListener (void) const
	Gets the current listener for this object.
Entity *	getManualLodLevel (size_t index) const
	Gets a pointer to the entity representing the numbered manual level of detail.
const MeshPtr &	getMesh (void) const
	Gets the Mesh that this Entity is based on.
const String &	getMovableType (void) const
virtual const String &	getName (void) const
	Returns the name of this object.
size_t	getNumManualLodLevels (void) const
	Returns the number of manual levels of detail that this entity supports.
unsigned int	getNumSubEntities (void) const
	Retrieves the number of SubEntity objects making up this entity.
virtual Node *	getParentNode (void) const
	Returns the node to which this object is attached.
virtual SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached.
Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light.
virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.
bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
virtual Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.
virtual Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.
ShadowRenderableListIterator	getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light light, HardwareIndexBufferSharedPtr indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
SkeletonInstance *	getSkeleton (void) const
	Get this Entity's personal skeleton instance.
const EntitySet *	getSkeletonInstanceSharingSet () const
	Returns a pointer to the set of entities which share a SkeletonInstance.
bool	getSkipAnimationStateUpdate () const
	Entity's skeleton's AnimationState will not be automatically updated when set to true.
int	getSoftwareAnimationNormalsRequests (void) const
	Returns the number of requests that have been made for software animation of normals.
int	getSoftwareAnimationRequests (void) const
	Returns the number of requests that have been made for software animation.
SubEntity *	getSubEntity (unsigned int index) const
	Gets a pointer to a SubEntity, ie a part of an Entity.
SubEntity *	getSubEntity (const String &name) const
	Gets a pointer to a SubEntity by name.
uint32	getTypeFlags (void) const
	Override to return specific type flag.
virtual OGRE_DEPRECATED const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
VertexData *	getVertexDataForBinding (void)
	Retrieve the VertexData which should be used for GPU binding.
virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.
virtual bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component.
const AxisAlignedBox &	getWorldBoundingBox (bool derive=false) const
const Sphere &	getWorldBoundingSphere (bool derive=false) const
bool	hasAnimationState (const String &name) const
	Returns whether the AnimationState with the given name exists.
bool	hasEdgeList (void)
bool	hasSkeleton (void) const
	Returns whether or not this entity is skeletally animated.
bool	hasVertexAnimation (void) const
	Returns whether or not this entity is either morph or pose animated.
virtual bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
virtual bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled.
bool	isHardwareAnimationEnabled (void)
	Returns whether or not hardware animation is enabled.
bool	isInitialised (void) const
	Has this Entity been initialised yet?
virtual bool	isInScene (void) const
	Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.
virtual bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode)
virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.
virtual void	loadingComplete (Resource *)
	Called whenever the resource finishes loading.
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	preparingComplete (Resource *)
	Called whenever the resource finishes preparing (paging into memory).
virtual const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.
void	refreshAvailableAnimationState (void)
	Updates the internal animation state set to include the latest available animations from the attached skeleton.
virtual void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	removeSoftwareAnimationRequest (bool normalsAlso)
	Removes a request for software animation.
virtual void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	setAlwaysUpdateMainSkeleton (bool update)
	The skeleton of the main entity will be updated even if the an LOD entity is being displayed.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
virtual void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled.
void	setDisplaySkeleton (bool display)
	Tells the Entity whether or not it should display it's skeleton, if it has one.
virtual void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.
virtual void	setListener (Listener *listener)
	Sets a listener for this object.
void	setMaterial (const MaterialPtr &material)
	Sets the material to use for the whole 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	setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Sets the material to use for the whole of this entity.
void	setMeshLodBias (Real factor, ushort maxDetailIndex=0, ushort minDetailIndex=99)
	Sets a level-of-detail bias for the mesh detail of this entity.
void	setPolygonModeOverrideable (bool PolygonModeOverrideable)
	Sets whether the polygon mode of this entire entity may be overridden by the camera detail settings.
virtual void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
virtual void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
virtual void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
void	setRenderQueueGroup (uint8 queueID)
void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
void	setSkipAnimationStateUpdate (bool skip)
	Entity's skeleton's AnimationState will not be automatically updated when set to true.
virtual OGRE_DEPRECATED void	setUserAny (const Any &anything)
virtual void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.
virtual void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
void	shareSkeletonInstanceWith (Entity *entity)
	Shares the SkeletonInstance with the supplied entity.
bool	sharesSkeletonInstance () const
	Returns whether this entity shares it's SkeltonInstance with other entity instances.
void	stopSharingSkeletonInstance ()
	Stops sharing the SkeletonInstance with other entities.
virtual void	unloadingComplete (Resource *)
	Called whenever the resource has been unloaded.
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
Static Public Member Functions
static void	extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light.
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
Protected Types
typedef map< String, StringVector >::type	AnimableDictionaryMap
typedef vector< Entity * >::type	LODEntityList
	List of LOD Entity instances (for manual LODs).
typedef vector< SubEntity * >::type	SubEntityList
	List of SubEntities (point to SubMeshes).
Protected Member Functions
	Entity ()
	Private constructor (instances cannot be created directly).
	Entity (const String &name, const MeshPtr &mesh)
	Private constructor - specify name (the usual constructor used).
StringVector &	_getAnimableValueNames (void)
	Get an updateable reference to animable value list.
void	applyVertexAnimation (bool hardwareAnimation, bool stencilShadows)
	Apply vertex animation.
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	bindMissingHardwarePoseBuffers (const VertexData srcData, VertexData destData)
	Ensure that any unbound pose animation buffers are bound to a safe default.
void	buildSubEntityList (MeshPtr &mesh, SubEntityList *sublist)
	Builds a list of SubEntities based on the SubMeshes contained in the Mesh.
bool	cacheBoneMatrices (void)
	Private method to cache bone matrices from skeleton.
bool	calcVertexProcessing (void)
	Calculates the kind of vertex processing in use.
VertexData *	cloneVertexDataRemoveBlendInfo (const VertexData *source)
	Internal method to clone vertex data definitions but to remove blend buffers.
void	createAnimableDictionary (void) const
	Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
void	detachAllObjectsImpl (void)
	Internal implementation of detaching all 'child' objects of this entity.
void	detachObjectImpl (MovableObject *pObject)
	Internal implementation of detaching a 'child' object of this entity and clear the parent node of the child entity.
void	extractTempBufferInfo (VertexData sourceData, TempBlendedBufferInfo info)
	Internal method for extracting metadata out of source vertex data for fast assignment of temporary buffers later.
virtual void	extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
	Utility method for extruding a bounding box.
void	finalisePoseNormals (const VertexData srcData, VertexData destData)
	When animating normals for pose animation, finalise normals by filling in with the reference mesh normal where applied normal weights < 1.
const VertexData *	findBlendedVertexData (const VertexData *orig)
	Internal method - given vertex data which could be from the Mesh or any submesh, finds the temporary blend copy.
SubEntity *	findSubEntityForVertexData (const VertexData *orig)
	Internal method - given vertex data which could be from the Mesh or any SubMesh, finds the corresponding SubEntity.
virtual void	generateShadowVolume (EdgeData edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, 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 const String &	getAnimableDictionaryName (void) const
	Get the name of the animable dictionary for this class.
Real	getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
	Helper method for calculating extrusion distance.
ushort	initHardwareAnimationElements (VertexData *vdata, ushort numberOfElements, bool animateNormals)
	Initialise the hardware animation elements for given vertex data.
virtual void	initialiseAnimableDictionary (StringVector &) const
	Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
void	initialisePoseVertexData (const VertexData srcData, VertexData destData, bool animateNormals)
	When performing software pose animation, initialise software copy of vertex data.
void	markBuffersUnusedForAnimation (void)
	Mark all vertex data as so far unanimated.
void	prepareTempBlendBuffers (void)
	Internal method for preparing this Entity for use in animation.
void	reevaluateVertexProcessing (void)
	Ensures reevaluation of the vertex processing usage.
void	restoreBuffersForUnusedAnimation (bool hardwareAnimation)
	Internal method to restore original vertex data where we didn't perform any vertex animation this frame.
bool	tempSkelAnimBuffersBound (bool requestNormals) const
	Are software skeleton animation temp buffers bound?
bool	tempVertexAnimBuffersBound (void) const
	Are software vertex animation temp buffers bound?
void	updateAnimation (void)
	Perform all the updates required for an animated entity.
virtual void	updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
	Tells the caster to perform the tasks necessary to update the edge data's light listing.
Protected Attributes
bool	mAlwaysUpdateMainSkeleton
	Flag indicating whether to update the main entity skeleton even when an LOD is displayed.
AnimationStateSet *	mAnimationState
	State of animation for animable meshes.
bool	mBeyondFarDistance
	Hidden because of distance?
Matrix4 *	mBoneMatrices
	Cached bone matrices in skeleton local space, might shares with other entity instances.
Matrix4 *	mBoneWorldMatrices
	Cached bone matrices, including any world transform.
bool	mCastShadows
	Does this object cast shadows?
ChildObjectList	mChildObjectList
MovableObjectFactory *	mCreator
	Creator of this object (if created by a factory)
bool	mCurrentHWAnimationState
	Current state of the hardware animation as represented by the entities parameters.
bool	mDebugDisplay
	Is debug display enabled?
bool	mDisplaySkeleton
	Flag determines whether or not to display skeleton.
unsigned long	mFrameAnimationLastUpdated
	Records the last frame in which animation was updated.
unsigned long *	mFrameBonesLastUpdated
	Records the last frame in which the bones was updated.
AxisAlignedBox	mFullBoundingBox
	Bounding box that 'contains' all the mesh of each child entity.
ushort	mHardwarePoseCount
	Number of hardware poses supported by materials.
VertexData *	mHardwareVertexAnimVertexData
	Vertex data details for hardware vertex anim of shared geometry.
bool	mInitialised
	Has this entity been initialised yet?
Matrix4	mLastParentXform
	Last parent transform.
LightList	mLightList
	List of lights for this object.
ulong	mLightListUpdated
	The last frame that this light list was updated in.
uint32	mLightMask
	the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Listener *	mListener
	MovableObject listener - only one allowed (no list) for size & performance reasons. */.
LODEntityList	mLodEntityList
SceneManager *	mManager
	SceneManager holding this object (if applicable)
Real	mMaterialLodFactor
	LOD bias factor, not transformed.
Real	mMaterialLodFactorTransformed
	LOD bias factor, transformed for optimisation when calculating adjusted LOD value.
ushort	mMaxMaterialLodIndex
	Index of maximum detail LOD (NB lower index is higher detail).
ushort	mMaxMeshLodIndex
	Index of maximum detail LOD (NB lower index is higher detail).
MeshPtr	mMesh
	The Mesh that this Entity is based on.
Real	mMeshLodFactorTransformed
	LOD bias factor, transformed for optimisation when calculating adjusted LOD value.
ushort	mMeshLodIndex
	The LOD number of the mesh to use, calculated by _notifyCurrentCamera.
size_t	mMeshStateCount
	Mesh state count, used to detect differences.
ushort	mMinMaterialLodIndex
	Index of minimum detail LOD (NB higher index is lower detail).
ushort	mMinMeshLodIndex
	Index of minimum detail LOD (NB higher index is lower detail).
Real	mMinPixelSize
String	mName
	Name of this object.
unsigned short	mNumBoneMatrices
bool	mParentIsTagPoint
Node *	mParentNode
	node to which this object is attached
bool	mPreparedForShadowVolumes
	Have the temp buffers already had their geometry prepared for use in rendering shadow volumes?
uint32	mQueryFlags
	Flags determining whether this object is included / excluded from scene queries.
bool	mRenderingDisabled
	Does rendering this object disabled by listener?
uint8	mRenderQueueID
	The render queue to use when rendering this object.
bool	mRenderQueueIDSet
	Flags whether the RenderQueue's default should be used.
ushort	mRenderQueuePriority
	The render queue group to use when rendering this object.
bool	mRenderQueuePrioritySet
	Flags whether the RenderQueue's default should be used.
SchemeHardwareAnimMap	mSchemeHardwareAnim
	Flag indicating whether hardware animation is supported by this entities materials data is saved per scehme number.
ShadowRenderableList	mShadowRenderables
EntitySet *	mSharedSkeletonEntities
	A set of all the entities which shares a single SkeletonInstance.
VertexData *	mSkelAnimVertexData
	Vertex data details for software skeletal anim of shared geometry.
SkeletonInstance *	mSkeletonInstance
	This Entity's personal copy of the skeleton, if skeletally animated.
bool	mSkipAnimStateUpdates
	Flag indicating whether to skip automatic updating of the Skeleton's AnimationState.
int	mSoftwareAnimationNormalsRequests
	Counter indicating number of requests for software blended normals.
int	mSoftwareAnimationRequests
	Counter indicating number of requests for software animation.
VertexData *	mSoftwareVertexAnimVertexData
	Vertex data details for software vertex anim of shared geometry.
Real	mSquaredUpperDistance
SubEntityList	mSubEntityList
TempBlendedBufferInfo	mTempSkelAnimInfo
	Temp buffer details for software skeletal anim of shared geometry.
TempBlendedBufferInfo	mTempVertexAnimInfo
	Temp buffer details for software vertex anim of shared geometry.
Real	mUpperDistance
	Upper distance to still render.
UserObjectBindings	mUserObjectBindings
	User objects binding.
bool	mVertexAnimationAppliedThisFrame
	Have we applied any vertex animation to shared geometry?
bool	mVertexProgramInUse
	Flag indicating whether we have a vertex program in use on any of our subentities.
uint32	mVisibilityFlags
	Flags determining whether this object is visible (compared to SceneManager mask)
bool	mVisible
	Is this object visible?
AxisAlignedBox	mWorldAABB
	Cached world AABB of this object.
Sphere	mWorldBoundingSphere
AxisAlignedBox	mWorldDarkCapBounds
	World space AABB of this object's dark cap.
Static Protected Attributes
static AnimableDictionaryMap	msAnimableDictionary
	Static map of class name to list of animable value names.
static uint32	msDefaultQueryFlags
	Default query flags.
static uint32	msDefaultVisibilityFlags
	Default visibility flags.
Friends
class	EntityFactory
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 82 of file OgreEntity.h.

Member Typedef Documentation

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap [protected, inherited]

Definition at line 241 of file OgreAnimable.h.

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

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

Definition at line 304 of file OgreEntity.h.

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

Definition at line 584 of file OgreEntity.h.

typedef set<Entity*>::type Ogre::Entity::EntitySet

Definition at line 89 of file OgreEntity.h.

typedef vector<Entity*>::type 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 254 of file OgreEntity.h.

typedef map<unsigned short, bool>::type Ogre::Entity::SchemeHardwareAnimMap

Definition at line 90 of file OgreEntity.h.

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

Definition at line 136 of file OgreShadowCaster.h.

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

Definition at line 137 of file OgreShadowCaster.h.

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

List of SubEntities (point to SubMeshes).

Definition at line 107 of file OgreEntity.h.

Member Enumeration Documentation

enum Ogre::Entity::VertexDataBindChoice

Identify which vertex data we should be sending to the renderer.

Enumerator:

BIND_ORIGINAL
BIND_SOFTWARE_SKELETAL
BIND_SOFTWARE_MORPH
BIND_HARDWARE_MORPH

Definition at line 773 of file OgreEntity.h.

Constructor & Destructor Documentation

Ogre::Entity::Entity ( ) [protected]

Private constructor (instances cannot be created directly).

Ogre::Entity::Entity	(	const String &	name,
		const MeshPtr &	mesh
	)		`[protected]`

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

Ogre::Entity::~Entity ( )

Default destructor.

Member Function Documentation

void Ogre::Entity::_deinitialise ( void )

Tear down the internal structures of this Entity, rendering it uninitialised.

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void ) [protected, inherited]

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

const Matrix4* Ogre::Entity::_getBoneMatrices ( void ) const

Internal method for retrieving bone matrix information.

Definition at line 606 of file OgreEntity.h.

bool Ogre::Entity::_getBuffersMarkedForAnimation ( void ) const

Are buffers already marked as vertex animated?

Definition at line 784 of file OgreEntity.h.

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void ) const [virtual, inherited]

Get the creator of this object, if any (internal use only)

Definition at line 186 of file OgreMovableObject.h.

VertexData* Ogre::Entity::_getHardwareVertexAnimVertexData ( void ) const

Advanced method to get the hardware morph vertex information.

Note:: The positions/normals of the returned vertex data is in object space.

virtual LightList* Ogre::MovableObject::_getLightList ( ) [virtual, inherited]

Returns a pointer to the current list of lights for this object.

Remarks:: You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 491 of file OgreMovableObject.h.

virtual SceneManager* Ogre::MovableObject::_getManager ( void ) const [virtual, inherited]

Get the manager of this object, if any (internal use only)

Definition at line 190 of file OgreMovableObject.h.

Real Ogre::Entity::_getMeshLodFactorTransformed ( ) const

Get the LOD strategy transformation of the mesh LOD factor.

unsigned short Ogre::Entity::_getNumBoneMatrices ( void ) const

Internal method for retrieving bone matrix information.

Definition at line 608 of file OgreEntity.h.

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

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

Reimplemented in Ogre::InstancedEntity.

TempBlendedBufferInfo* Ogre::Entity::_getSkelAnimTempBufferInfo ( void )

Advanced method to get the temp buffer information for software skeletal animation.

VertexData* Ogre::Entity::_getSkelAnimVertexData ( void ) const

Advanced method to get the temporarily blended skeletal vertex information for entities which are software skinned.

Remarks:: Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via addSoftwareAnimationRequest.

Note:: The positions/normals of the returned vertex data is in object space.

VertexData* Ogre::Entity::_getSoftwareVertexAnimVertexData ( void ) const

Advanced method to get the temporarily blended software vertex animation information.

Remarks:: Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via addSoftwareAnimationRequest.

Note:: The positions/normals of the returned vertex data is in object space.

TempBlendedBufferInfo* Ogre::Entity::_getVertexAnimTempBufferInfo ( void )

Advanced method to get the temp buffer information for software morph animation.

void Ogre::Entity::_initialise ( bool forceReinitialise = false )

Try to initialise the Entity from the underlying resources.

Remarks:: This method builds the internal structures of the Entity based on it resources (Mesh, Skeleton). This may or may not succeed if the resources it references have been earmarked for background loading, so you should check isInitialised afterwards to see if it was successful.

Parameters:

forceReinitialise If true, this forces the Entity to tear down it's internal structures and try to rebuild them. Useful if you changed the content of a Mesh or Skeleton at runtime.

bool Ogre::Entity::_isAnimated ( void ) const

Tests if any animation applied to this entity.

Remarks:: An entity is animated if any animation state is enabled, or any manual bone applied to the skeleton.

bool Ogre::Entity::_isSkeletonAnimated ( void ) const

Tests if skeleton was animated.

void Ogre::Entity::_markBuffersUsedForAnimation ( void )

Mark just this vertex data as animated.

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

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

Reimplemented from Ogre::MovableObject.

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory * fact ) [virtual, inherited]

Notify the object of it's creator (internal use only)

Definition at line 184 of file OgreMovableObject.h.

void Ogre::Entity::_notifyCurrentCamera ( Camera * cam ) [virtual]

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

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

.

Reimplemented from Ogre::MovableObject.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager * man ) [virtual, inherited]

Notify the object of it's manager (internal use only)

Definition at line 188 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyMoved ( void ) [virtual, inherited]

Internal method called to notify the object that it has been moved.

Reimplemented in Ogre::Light, and Ogre::InstancedEntity.

void Ogre::Entity::_updateAnimation ( void )

Advanced method to perform all the updates required for an animated entity.

Remarks:: You don't normally need to call this, but it's here in case you wish to manually update the animation of an Entity at a specific point in time. Animation will not be updated more than once a frame no matter how many times you call this method.

void Ogre::Entity::_updateRenderQueue ( RenderQueue * queue ) [virtual]

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

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

.

Implements Ogre::MovableObject.

virtual void Ogre::MovableObject::addQueryFlags ( uint32 flags ) [virtual, inherited]

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 396 of file OgreMovableObject.h.

void Ogre::Entity::addSoftwareAnimationRequest ( bool normalsAlso )

Add a request for software animation.

Remarks:: Tells the entity to perform animation calculations for skeletal/vertex animations in software, regardless of the current setting of isHardwareAnimationEnabled(). Software animation will be performed any time one or more requests have been made. If 'normalsAlso' is 'true', then the entity will also do software blending on normal vectors, in addition to positions. This advanced method useful for situations in which access to actual mesh vertices is required, such as accurate collision detection or certain advanced shading techniques. When software animation is no longer needed, the caller of this method should always remove the request by calling removeSoftwareAnimationRequest(), passing the same value for 'normalsAlso'.

virtual void Ogre::MovableObject::addVisibilityFlags ( uint32 flags ) [virtual, inherited]

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 424 of file OgreMovableObject.h.

void Ogre::Entity::applyVertexAnimation	(	bool	hardwareAnimation,
		bool	stencilShadows
	)		`[protected]`

Apply vertex animation.

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.

TagPoint* 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.

: An exception is thrown if the movable object is already attached to the bone, another bone or scenenode. If the entity has no skeleton or the bone name cannot be found then an exception is thrown.

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.

Returns:: The TagPoint to which the object has been attached

void Ogre::Entity::backgroundLoadingComplete ( Resource * res ) [virtual]

Resource::Listener hook to notify Entity that a delay-loaded Mesh is complete.

Reimplemented from Ogre::Resource::Listener.

virtual OGRE_DEPRECATED void Ogre::Resource::Listener::backgroundPreparingComplete ( Resource * ) [virtual, inherited]

Callback to indicate that background preparing has completed.

Deprecated:: Use preparingComplete instead.

Definition at line 99 of file OgreResource.h.

void Ogre::Entity::bindMissingHardwarePoseBuffers	(	const VertexData *	srcData,
		VertexData *	destData
	)		`[protected]`

Ensure that any unbound pose animation buffers are bound to a safe default.

Parameters:

srcData	Original vertex data containing original positions.
destData	Hardware animation vertex data to be checked.

void Ogre::Entity::buildSubEntityList	(	MeshPtr &	mesh,
		SubEntityList *	sublist
	)		`[protected]`

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

bool Ogre::Entity::cacheBoneMatrices ( void ) [protected]

Private method to cache bone matrices from skeleton.

Returns:: True if the bone matrices cache has been updated. False if note.

bool Ogre::Entity::calcVertexProcessing ( void ) [protected]

Calculates the kind of vertex processing in use.

Remarks:: This function's return value is calculated according to the current active scheme. This is due to the fact that RTSS schemes may be different in their handling of hardware animation.

VertexDataBindChoice Ogre::Entity::chooseVertexDataForBinding ( bool hasVertexAnim )

Choose which vertex data to bind to the renderer.

Entity* Ogre::Entity::clone ( const String & newName ) const

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.

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

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

void Ogre::AnimableObject::createAnimableDictionary ( void ) const [protected, inherited]

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 254 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String & valueName ) [virtual, inherited]

Create a reference-counted AnimableValuePtr for the named value.

Remarks:: You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 320 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

void Ogre::Entity::detachAllObjectsFromBone ( void )

Detach all MovableObjects previously attached using attachObjectToBone.

void Ogre::Entity::detachAllObjectsImpl ( void ) [protected]

Internal implementation of detaching all 'child' objects of this entity.

virtual void Ogre::MovableObject::detachFromParent ( void ) [virtual, inherited]

Detaches an object from a parent SceneNode or TagPoint, if attached.

MovableObject* Ogre::Entity::detachObjectFromBone ( const String & movableName )

Detach a MovableObject previously attached using attachObjectToBone.

If the movable object name is not found then an exception is raised.

Parameters:

movableName The name of the movable object to be detached.

void Ogre::Entity::detachObjectFromBone ( MovableObject * obj )

Detaches an object by pointer.

Remarks:: Use this method to destroy a MovableObject which is attached to a bone of belonging this entity. But sometimes the object may be not in the child object list because it is a LOD entity, this method can safely detect and ignore in this case and won't raise an exception.

void Ogre::Entity::detachObjectImpl ( MovableObject * pObject ) [protected]

Internal implementation of detaching a 'child' object of this entity and clear the parent node of the child entity.

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.

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

static void Ogre::ShadowCaster::extrudeVertices	(	const 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 homogeneous (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, i.e. 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.

void Ogre::Entity::finalisePoseNormals	(	const VertexData *	srcData,
		VertexData *	destData
	)		`[protected]`

When animating normals for pose animation, finalise normals by filling in with the reference mesh normal where applied normal weights < 1.

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.

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.

virtual void Ogre::ShadowCaster::generateShadowVolume	(	EdgeData *	edgeData,
		const HardwareIndexBufferSharedPtr &	indexBuffer,
		size_t &	indexBufferUsedSize,
		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.
indexBufferUsedSize	If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset.
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.

AnimationStateSet* Ogre::Entity::getAllAnimationStates ( void ) const

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

Returns:: In case the entity is animated, this functions returns the pointer to a AnimationStateSet containing all animations of the entries. If the entity is not animated, it returns 0.

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.

bool Ogre::Entity::getAlwaysUpdateMainSkeleton ( ) const

The skeleton of the main entity will be updated even if the an LOD entity is being displayed.

useful if you have entities attached to the main entity. Otherwise position of attached entities will not be updated.

Definition at line 852 of file OgreEntity.h.

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void ) const [protected, virtual, inherited]

Get the name of the animable dictionary for this class.

Remarks:: Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 249 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void ) const [inherited]

Gets a list of animable value names for this object.

Definition at line 295 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

AnimationState* Ogre::Entity::getAnimationState ( const String & name ) const

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.

ChildObjectListIterator Ogre::Entity::getAttachedObjectIterator ( void )

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

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

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

Remarks:: This bounding box is in local coordinates.

.

Implements Ogre::MovableObject.

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

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 521 of file OgreMovableObject.h.

AxisAlignedBox Ogre::Entity::getChildObjectsBoundingBox ( void ) const

Merge all the child object Bounds a return it.

ushort Ogre::Entity::getCurrentLodIndex ( )

Returns the current LOD used to render.

Definition at line 474 of file OgreEntity.h.

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

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( ) [static, inherited]

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( ) [static, inherited]

Get the default visibility flags for all future MovableObject instances.

Definition at line 439 of file OgreMovableObject.h.

bool Ogre::Entity::getDisplaySkeleton ( void ) const

Returns whether or not the entity is currently displaying its skeleton.

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

Returns details of the edges which might be used to determine a silhouette.

.

Reimplemented from Ogre::MovableObject.

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

Helper method for calculating extrusion distance.

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

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getLightMask ( ) const [virtual, inherited]

Get a bitwise mask which will filter the lights affecting this object.

Remarks:: By default, this mask is fully set meaning all lights will affect this object

Definition at line 476 of file OgreMovableObject.h.

virtual Listener* Ogre::MovableObject::getListener ( void ) const [virtual, inherited]

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

Entity* Ogre::Entity::getManualLodLevel ( size_t index ) const

Gets a pointer to the entity representing the numbered manual level of detail.

Remarks:: The zero-based index never includes the original entity, unlike Mesh::getLodLevel.

const MeshPtr& Ogre::Entity::getMesh ( void ) const

Gets the Mesh that this Entity is based on.

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

Returns the type name of this object.

Implements Ogre::MovableObject.

virtual const String& Ogre::MovableObject::getName ( void ) const [virtual, inherited]

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

size_t Ogre::Entity::getNumManualLodLevels ( void ) const

Returns the number of manual levels of detail that this entity supports.

Remarks:: This number never includes the original entity, it is difference with Mesh::getNumLodLevels.

unsigned int Ogre::Entity::getNumSubEntities ( void ) const

Retrieves the number of SubEntity objects making up this entity.

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

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

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light * l ) const [virtual, inherited]

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getQueryFlags ( void ) const [virtual, inherited]

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 403 of file OgreMovableObject.h.

bool Ogre::MovableObject::getReceivesShadows ( ) [inherited]

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

virtual Real Ogre::MovableObject::getRenderingDistance ( void ) const [virtual, inherited]

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

virtual Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const [virtual, inherited]

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 318 of file OgreMovableObject.h.

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const [virtual, inherited]

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

ShadowRenderableListIterator Ogre::Entity::getShadowVolumeRenderableIterator	(	ShadowTechnique	shadowTechnique,
		const Light *	light,
		HardwareIndexBufferSharedPtr *	indexBuffer,
		size_t *	indexBufferUsedSize,
		bool	extrudeVertices,
		Real	extrusionDistance,
		unsigned long	flags = `0`
	)		`[virtual]`

Gets an iterator over the renderables required to render the shadow volume.

Remarks:: Shadowable geometry should ideally be designed such that there is only one ShadowRenderable required to render the the shadow; however this is not a necessary limitation and it can be exceeded if required.

Parameters:

shadowTechnique	The technique being used to generate the shadow.
light	The light to generate the shadow from.
indexBuffer	The index buffer to build the renderables into, the current contents are assumed to be disposable.
extrudeVertices	If `true`, this means this class should extrude the vertices of the back of the volume in software. If false, it will not be done (a vertex program is assumed).
extrusionDistance	The distance to extrude the shadow volume.
flags	Technique-specific flags, see ShadowRenderableFlags.

.

Reimplemented from Ogre::MovableObject.

SkeletonInstance* Ogre::Entity::getSkeleton ( void ) const

Get this Entity's personal skeleton instance.

Definition at line 612 of file OgreEntity.h.

const EntitySet* Ogre::Entity::getSkeletonInstanceSharingSet ( ) const

Returns a pointer to the set of entities which share a SkeletonInstance.

If this instance does not share it's SkeletonInstance with other instances NULL will be returned

Definition at line 701 of file OgreEntity.h.

bool Ogre::Entity::getSkipAnimationStateUpdate ( ) const

Entity's skeleton's AnimationState will not be automatically updated when set to true.

Useful if you wish to handle AnimationState updates manually.

Definition at line 836 of file OgreEntity.h.

int Ogre::Entity::getSoftwareAnimationNormalsRequests ( void ) const

Returns the number of requests that have been made for software animation of normals.

Remarks:: If non-zero, and getSoftwareAnimationRequests() also returns non-zero, then software animation of normals will be performed in updateAnimation regardless of the current setting of isHardwareAnimationEnabled or any internal optimise for eliminate software animation. Currently it is not possible to force software animation of only normals. Consequently this value is always less than or equal to that returned by getSoftwareAnimationRequests(). Requests for software animation of normals are made by calling the addSoftwareAnimationRequest() method with 'true' as the parameter.

Definition at line 651 of file OgreEntity.h.

int Ogre::Entity::getSoftwareAnimationRequests ( void ) const

Returns the number of requests that have been made for software animation.

Remarks:: If non-zero then software animation will be performed in updateAnimation regardless of the current setting of isHardwareAnimationEnabled or any internal optimise for eliminate software animation. Requests for software animation are made by calling the addSoftwareAnimationRequest() method.

Definition at line 639 of file OgreEntity.h.

SubEntity* Ogre::Entity::getSubEntity ( unsigned int index ) const

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

SubEntity* Ogre::Entity::getSubEntity ( const String & name ) const

Gets a pointer to a SubEntity by name.

Remarks:: Names should be initialized during a Mesh creation.

uint32 Ogre::Entity::getTypeFlags ( void ) const [virtual]

Override to return specific type flag.

Reimplemented from Ogre::MovableObject.

virtual OGRE_DEPRECATED const Any& Ogre::MovableObject::getUserAny ( void ) const [virtual, inherited]

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 334 of file OgreMovableObject.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) [inherited]

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also:: UserObjectBindings::setUserAny.

Definition at line 340 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const [inherited]

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also:: UserObjectBindings::setUserAny.

Definition at line 346 of file OgreMovableObject.h.

VertexData* Ogre::Entity::getVertexDataForBinding ( void )

Retrieve the VertexData which should be used for GPU binding.

virtual uint32 Ogre::MovableObject::getVisibilityFlags ( void ) const [virtual, inherited]

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 431 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::getVisible ( void ) const [virtual, inherited]

Gets this object whether to be visible or not, if it has a renderable component.

Remarks:: Returns the value set by MovableObject::setVisible only.

const AxisAlignedBox& Ogre::Entity::getWorldBoundingBox ( bool derive = false ) const [virtual]

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

Reimplemented from Ogre::MovableObject.

const Sphere& Ogre::Entity::getWorldBoundingSphere ( bool derive = false ) const [virtual]

Retrieves the worldspace bounding sphere for this object.

Reimplemented from Ogre::MovableObject.

bool Ogre::Entity::hasAnimationState ( const String & name ) const

Returns whether the AnimationState with the given name exists.

bool Ogre::Entity::hasEdgeList ( void ) [virtual]

Returns whether the object has a valid edge list.

.

Reimplemented from Ogre::MovableObject.

bool Ogre::Entity::hasSkeleton ( void ) const

Returns whether or not this entity is skeletally animated.

Definition at line 610 of file OgreEntity.h.

bool Ogre::Entity::hasVertexAnimation ( void ) const

Returns whether or not this entity is either morph or pose animated.

ushort Ogre::Entity::initHardwareAnimationElements	(	VertexData *	vdata,
		ushort	numberOfElements,
		bool	animateNormals
	)		`[protected]`

Initialise the hardware animation elements for given vertex data.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector & ) const [protected, virtual, inherited]

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Reimplemented in Ogre::Light.

Definition at line 287 of file OgreAnimable.h.

void Ogre::Entity::initialisePoseVertexData	(	const VertexData *	srcData,
		VertexData *	destData,
		bool	animateNormals
	)		`[protected]`

When performing software pose animation, initialise software copy of vertex data.

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

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

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void ) const [virtual, inherited]

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

bool Ogre::Entity::isHardwareAnimationEnabled ( void )

Returns whether or not hardware animation is enabled.

Remarks:: Because fixed-function indexed vertex blending is rarely supported by existing graphics cards, hardware animation 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 'includes_morph_animation true' if using morph animation, 'includes_pose_animation true' if using pose animation and 'includes_skeletal_animation true' if using skeletal animation.

Also note the the function returns value according to the current active scheme. This is due to the fact that RTSS schemes may be different in their handling of hardware animation.

bool Ogre::Entity::isInitialised ( void ) const

Has this Entity been initialised yet?

Remarks:: If this returns false, it means this Entity hasn't been completely constructed yet from the underlying resources (Mesh, Skeleton), which probably means they were delay-loaded and aren't available yet. This Entity won't render until it has been successfully initialised, nor will many of the manipulation methods function.

Definition at line 797 of file OgreEntity.h.

virtual bool Ogre::MovableObject::isInScene ( void ) const [virtual, inherited]

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

Reimplemented in Ogre::InstancedEntity.

virtual bool Ogre::MovableObject::isParentTagPoint ( ) const [virtual, inherited]

Gets whether the parent node is a TagPoint (or a SceneNode)

Definition at line 216 of file OgreMovableObject.h.

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

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

Remarks:: Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

virtual void Ogre::Resource::Listener::loadingComplete ( Resource * ) [virtual, inherited]

Called whenever the resource finishes loading.

Remarks:: If a Resource has been marked as background loaded (

See also:: Resource::setBackgroundLoaded), the call does not itself occur in the thread which is doing the loading; when loading is complete a response indicator is placed with the ResourceGroupManager, which will then be sent back to the listener as part of the application's primary frame loop thread.

Reimplemented in Ogre::GpuProgramUsage.

Definition at line 109 of file OgreResource.h.

void Ogre::Entity::markBuffersUnusedForAnimation ( void ) [protected]

Mark all vertex data as so far unanimated.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		`[inherited]`

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)		`[inherited]`

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Internal method for preparing this Entity for use in animation.

virtual void Ogre::Resource::Listener::preparingComplete ( Resource * ) [virtual, inherited]

Called whenever the resource finishes preparing (paging into memory).

Remarks:: If a Resource has been marked as background loaded (

See also:: Resource::setBackgroundLoaded) the call does not itself occur in the thread which is doing the preparing; when preparing is complete a response indicator is placed with the ResourceGroupManager, which will then be sent back to the listener as part of the application's primary frame loop thread.

Definition at line 120 of file OgreResource.h.

virtual const LightList& Ogre::MovableObject::queryLights ( void ) const [virtual, inherited]

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks:: By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

: The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also:: SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

: This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns:: The list of lights use to lighting this object.

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

Ensures reevaluation of the vertex processing usage.

void Ogre::Entity::refreshAvailableAnimationState ( void )

Updates the internal animation state set to include the latest available animations from the attached skeleton.

Remarks:: Use this method if you manually add animations to a skeleton, or have linked the skeleton to another for animation purposes since creating this entity.

Note:: If you have called getAnimationState prior to calling this method, the pointers will still remain valid.

virtual void Ogre::MovableObject::removeQueryFlags ( uint32 flags ) [virtual, inherited]

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 400 of file OgreMovableObject.h.

void Ogre::Entity::removeSoftwareAnimationRequest ( bool normalsAlso )

Removes a request for software animation.

Remarks:: Calling this decrements the entity's internal counter of the number of requests for software animation. If the counter is already zero then calling this method throws an exception. The 'normalsAlso' flag if set to 'true' will also decrement the internal counter of number of requests for software animation of normals.

virtual void Ogre::MovableObject::removeVisibilityFlags ( uint32 flags ) [virtual, inherited]

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 428 of file OgreMovableObject.h.

void Ogre::Entity::restoreBuffersForUnusedAnimation ( bool hardwareAnimation ) [protected]

Internal method to restore original vertex data where we didn't perform any vertex animation this frame.

void Ogre::Entity::setAlwaysUpdateMainSkeleton ( bool update )

The skeleton of the main entity will be updated even if the an LOD entity is being displayed.

useful if you have entities attached to the main entity. Otherwise position of attached entities will not be updated.

Definition at line 844 of file OgreEntity.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 519 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool enabled ) [virtual, inherited]

Sets whether or not the debug display of this object is enabled.

Remarks:: Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 563 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags ) [static, inherited]

Set the default query flags for all future MovableObject instances.

Definition at line 407 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags ) [static, inherited]

Set the default visibility flags for all future MovableObject instances.

Definition at line 435 of file OgreMovableObject.h.

void Ogre::Entity::setDisplaySkeleton ( bool display )

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

virtual void Ogre::MovableObject::setLightMask ( uint32 lightMask ) [virtual, inherited]

Set a bitwise mask which will filter the lights affecting this object.

Remarks:: This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

virtual void Ogre::MovableObject::setListener ( Listener * listener ) [virtual, inherited]

Sets a listener for this object.

Remarks:: Note for size and performance reasons only one listener per object is allowed.

Definition at line 446 of file OgreMovableObject.h.

void Ogre::Entity::setMaterial ( const MaterialPtr & material )

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.

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

void Ogre::Entity::setMaterialName	(	const String &	name,
		const String &	groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_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.

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

void Ogre::Entity::setPolygonModeOverrideable ( bool PolygonModeOverrideable )

Sets whether the polygon mode of this entire entity may be overridden by the camera detail settings.

virtual void Ogre::MovableObject::setQueryFlags ( uint32 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 392 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingDistance ( Real dist ) [virtual, inherited]

Sets the distance at which the object is no longer rendered.

Note:: Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters:

dist	Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 299 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingMinPixelSize ( Real pixelSize ) [virtual, inherited]

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note:: Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters:

pixelSize Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 312 of file OgreMovableObject.h.

void Ogre::Entity::setRenderQueueGroup ( uint8 queueID ) [virtual]

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

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

: See RenderQueue for more details.

Parameters:

queueID Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

.

Reimplemented from Ogre::MovableObject.

void Ogre::Entity::setRenderQueueGroupAndPriority	(	uint8	queueID,
		ushort	priority
	)		`[virtual]`

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

Remarks:: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), 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. See the enum RenderQueueGroupID for what kind of values can be used here.
priority	The priority within a group to use.

.

Reimplemented from Ogre::MovableObject.

void Ogre::Entity::setSkipAnimationStateUpdate ( bool skip )

Entity's skeleton's AnimationState will not be automatically updated when set to true.

Useful if you wish to handle AnimationState updates manually.

Definition at line 829 of file OgreEntity.h.

virtual OGRE_DEPRECATED void Ogre::MovableObject::setUserAny ( const Any & anything ) [virtual, inherited]

Deprecated:: use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks:: This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.

Definition at line 329 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32 flags ) [virtual, inherited]

Sets the visibility flags for this object.

Remarks:: As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

Definition at line 420 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisible ( bool visible ) [virtual, inherited]

Tells this object whether to be visible or not, if it has a renderable component.

Note:: An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.

void Ogre::Entity::shareSkeletonInstanceWith ( Entity * entity )

Shares the SkeletonInstance with the supplied entity.

Note that in order for this to work, both entities must have the same Skeleton.

bool Ogre::Entity::sharesSkeletonInstance ( ) const

Returns whether this entity shares it's SkeltonInstance with other entity instances.

Definition at line 696 of file OgreEntity.h.

void Ogre::Entity::stopSharingSkeletonInstance ( )

Stops sharing the SkeletonInstance with other entities.

bool Ogre::Entity::tempSkelAnimBuffersBound ( bool requestNormals ) const [protected]

Are software skeleton animation temp buffers bound?

bool Ogre::Entity::tempVertexAnimBuffersBound ( void ) const [protected]

Are software vertex animation temp buffers bound?

virtual void Ogre::Resource::Listener::unloadingComplete ( Resource * ) [virtual, inherited]

Called whenever the resource has been unloaded.

Reimplemented in Ogre::GpuProgramUsage.

Definition at line 123 of file OgreResource.h.

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

Perform all the updates required for an animated entity.

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

void Ogre::Entity::visitRenderables	(	Renderable::Visitor *	visitor,
		bool	debugRenderables = `false`
	)		`[virtual]`

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters:

visitor	Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables	If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Friends And Related Function Documentation

friend class EntityFactory [friend]

Definition at line 85 of file OgreEntity.h.

friend class SubEntity [friend]

Definition at line 86 of file OgreEntity.h.

Member Data Documentation

bool Ogre::Entity::mAlwaysUpdateMainSkeleton [protected]

Flag indicating whether to update the main entity skeleton even when an LOD is displayed.

Definition at line 227 of file OgreEntity.h.

AnimationStateSet* Ogre::Entity::mAnimationState [protected]

State of animation for animable meshes.

Definition at line 112 of file OgreEntity.h.

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

Hidden because of distance?

Definition at line 128 of file OgreMovableObject.h.

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

Cached bone matrices in skeleton local space, might shares with other entity instances.

Definition at line 181 of file OgreEntity.h.

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

Cached bone matrices, including any world transform.

Definition at line 179 of file OgreEntity.h.

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

Does this object cast shadows?

Definition at line 150 of file OgreMovableObject.h.

ChildObjectList Ogre::Entity::mChildObjectList [protected]

Definition at line 306 of file OgreEntity.h.

MovableObjectFactory* Ogre::MovableObject::mCreator [protected, inherited]

Creator of this object (if created by a factory)

Reimplemented in Ogre::InstanceBatch.

Definition at line 112 of file OgreMovableObject.h.

bool Ogre::Entity::mCurrentHWAnimationState [protected]

Current state of the hardware animation as represented by the entities parameters.

Definition at line 214 of file OgreEntity.h.

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

Is debug display enabled?

Definition at line 121 of file OgreMovableObject.h.

bool Ogre::Entity::mDisplaySkeleton [protected]

Flag determines whether or not to display skeleton.

Definition at line 207 of file OgreEntity.h.

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

Records the last frame in which animation was updated.

Definition at line 184 of file OgreEntity.h.

unsigned long* Ogre::Entity::mFrameBonesLastUpdated [protected]

Records the last frame in which the bones was updated.

It's a pointer because it can be shared between different entities with a shared skeleton.

Definition at line 192 of file OgreEntity.h.

AxisAlignedBox Ogre::Entity::mFullBoundingBox [mutable, protected]

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

Definition at line 310 of file OgreEntity.h.

ushort Ogre::Entity::mHardwarePoseCount [protected]

Number of hardware poses supported by materials.

Definition at line 217 of file OgreEntity.h.

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

Vertex data details for hardware vertex anim of shared geometry.

separate since we need to s/w anim for shadows whilst still altering the vertex data for hardware morphing (pos2 binding)

Definition at line 126 of file OgreEntity.h.

bool Ogre::Entity::mInitialised [protected]

Has this entity been initialised yet?

Definition at line 262 of file OgreEntity.h.

Matrix4 Ogre::Entity::mLastParentXform [protected]

Last parent transform.

Definition at line 265 of file OgreEntity.h.

LightList Ogre::MovableObject::mLightList [mutable, protected, inherited]

List of lights for this object.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 158 of file OgreMovableObject.h.

ulong Ogre::MovableObject::mLightListUpdated [mutable, protected, inherited]

The last frame that this light list was updated in.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 160 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mLightMask [protected, inherited]

the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable

Definition at line 163 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener [protected, inherited]

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Definition at line 155 of file OgreMovableObject.h.

LODEntityList Ogre::Entity::mLodEntityList [protected]

Definition at line 255 of file OgreEntity.h.

SceneManager* Ogre::MovableObject::mManager [protected, inherited]

SceneManager holding this object (if applicable)

Definition at line 114 of file OgreMovableObject.h.

Real Ogre::Entity::mMaterialLodFactor [protected]

LOD bias factor, not transformed.

Definition at line 241 of file OgreEntity.h.

Real Ogre::Entity::mMaterialLodFactorTransformed [protected]

LOD bias factor, transformed for optimisation when calculating adjusted LOD value.

Definition at line 243 of file OgreEntity.h.

ushort Ogre::Entity::mMaxMaterialLodIndex [protected]

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

Definition at line 247 of file OgreEntity.h.

ushort Ogre::Entity::mMaxMeshLodIndex [protected]

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

Definition at line 238 of file OgreEntity.h.

MeshPtr Ogre::Entity::mMesh [protected]

The Mesh that this Entity is based on.

Definition at line 103 of file OgreEntity.h.

Real Ogre::Entity::mMeshLodFactorTransformed [protected]

LOD bias factor, transformed for optimisation when calculating adjusted LOD value.

Definition at line 234 of file OgreEntity.h.

ushort Ogre::Entity::mMeshLodIndex [protected]

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

Definition at line 231 of file OgreEntity.h.

size_t Ogre::Entity::mMeshStateCount [protected]

Mesh state count, used to detect differences.

Definition at line 268 of file OgreEntity.h.

ushort Ogre::Entity::mMinMaterialLodIndex [protected]

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

Definition at line 245 of file OgreEntity.h.

ushort Ogre::Entity::mMinMeshLodIndex [protected]

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

Definition at line 236 of file OgreEntity.h.

Real Ogre::MovableObject::mMinPixelSize [protected, inherited]

Definition at line 126 of file OgreMovableObject.h.

String Ogre::MovableObject::mName [protected, inherited]

Name of this object.

Definition at line 110 of file OgreMovableObject.h.

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

Definition at line 182 of file OgreEntity.h.

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

Definition at line 117 of file OgreMovableObject.h.

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

node to which this object is attached

Definition at line 116 of file OgreMovableObject.h.

bool Ogre::Entity::mPreparedForShadowVolumes [protected]

Have the temp buffers already had their geometry prepared for use in rendering shadow volumes?

Definition at line 130 of file OgreEntity.h.

uint32 Ogre::MovableObject::mQueryFlags [protected, inherited]

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

Definition at line 140 of file OgreMovableObject.h.

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

Does rendering this object disabled by listener?

Definition at line 153 of file OgreMovableObject.h.

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

The render queue to use when rendering this object.

Definition at line 132 of file OgreMovableObject.h.

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

Flags whether the RenderQueue's default should be used.

Definition at line 134 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority [protected, inherited]

The render queue group to use when rendering this object.

Definition at line 136 of file OgreMovableObject.h.

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

Flags whether the RenderQueue's default should be used.

Definition at line 138 of file OgreMovableObject.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary [static, protected, inherited]

Static map of class name to list of animable value names.

Definition at line 243 of file OgreAnimable.h.

SchemeHardwareAnimMap Ogre::Entity::mSchemeHardwareAnim [protected]

Flag indicating whether hardware animation is supported by this entities materials data is saved per scehme number.

Definition at line 211 of file OgreEntity.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags [static, protected, inherited]

Default query flags.

Definition at line 167 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags [static, protected, inherited]

Default visibility flags.

Definition at line 169 of file OgreMovableObject.h.

ShadowRenderableList Ogre::Entity::mShadowRenderables [protected]

Definition at line 312 of file OgreEntity.h.

EntitySet* Ogre::Entity::mSharedSkeletonEntities [protected]

A set of all the entities which shares a single SkeletonInstance.

This is only created if the entity is in fact sharing it's SkeletonInstance with other Entities.

Definition at line 198 of file OgreEntity.h.

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

Vertex data details for software skeletal anim of shared geometry.

Definition at line 118 of file OgreEntity.h.

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

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

Definition at line 259 of file OgreEntity.h.

bool Ogre::Entity::mSkipAnimStateUpdates [protected]

Flag indicating whether to skip automatic updating of the Skeleton's AnimationState.

Definition at line 225 of file OgreEntity.h.

int Ogre::Entity::mSoftwareAnimationNormalsRequests [protected]

Counter indicating number of requests for software blended normals.

Definition at line 223 of file OgreEntity.h.

int Ogre::Entity::mSoftwareAnimationRequests [protected]

Counter indicating number of requests for software animation.

Definition at line 221 of file OgreEntity.h.

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

Vertex data details for software vertex anim of shared geometry.

Definition at line 122 of file OgreEntity.h.

Real Ogre::MovableObject::mSquaredUpperDistance [protected, inherited]

Definition at line 124 of file OgreMovableObject.h.

SubEntityList Ogre::Entity::mSubEntityList [protected]

Definition at line 108 of file OgreEntity.h.

TempBlendedBufferInfo Ogre::Entity::mTempSkelAnimInfo [protected]

Temp buffer details for software skeletal anim of shared geometry.

Definition at line 116 of file OgreEntity.h.

TempBlendedBufferInfo Ogre::Entity::mTempVertexAnimInfo [protected]

Temp buffer details for software vertex anim of shared geometry.

Definition at line 120 of file OgreEntity.h.

Real Ogre::MovableObject::mUpperDistance [protected, inherited]

Upper distance to still render.

Definition at line 123 of file OgreMovableObject.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings [protected, inherited]

User objects binding.

Definition at line 130 of file OgreMovableObject.h.

bool Ogre::Entity::mVertexAnimationAppliedThisFrame [protected]

Have we applied any vertex animation to shared geometry?

Definition at line 128 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 219 of file OgreEntity.h.

uint32 Ogre::MovableObject::mVisibilityFlags [protected, inherited]

Flags determining whether this object is visible (compared to SceneManager mask)

Definition at line 142 of file OgreMovableObject.h.

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

Is this object visible?

Definition at line 119 of file OgreMovableObject.h.

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

Cached world AABB of this object.

Reimplemented in Ogre::ParticleSystem.

Definition at line 144 of file OgreMovableObject.h.

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

Definition at line 146 of file OgreMovableObject.h.

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

World space AABB of this object's dark cap.

Definition at line 148 of file OgreMovableObject.h.

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

OgreEntity.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation