Defines an instance of a discrete, movable object based on a Mesh. More...
#include <OgreEntity.h>
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. More... | |
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. More... | |
void | _deinitialise (void) |
Tear down the internal structures of this Entity, rendering it uninitialised. More... | |
const Matrix4 * | _getBoneMatrices (void) const |
Internal method for retrieving bone matrix information. More... | |
bool | _getBuffersMarkedForAnimation (void) const |
Are buffers already marked as vertex animated? More... | |
virtual MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) More... | |
VertexData * | _getHardwareVertexAnimVertexData (void) const |
Advanced method to get the hardware morph vertex information. More... | |
virtual LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. More... | |
virtual SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) More... | |
Real | _getMeshLodFactorTransformed () const |
Get the LOD strategy transformation of the mesh LOD factor. More... | |
unsigned short | _getNumBoneMatrices (void) const |
Internal method for retrieving bone matrix information. More... | |
virtual const Matrix4 & | _getParentNodeFullTransform (void) const |
return the full transformation of the parent sceneNode or the attachingPoint node More... | |
TempBlendedBufferInfo * | _getSkelAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software skeletal animation. More... | |
VertexData * | _getSkelAnimVertexData (void) const |
Advanced method to get the temporarily blended skeletal vertex information for entities which are software skinned. More... | |
VertexData * | _getSoftwareVertexAnimVertexData (void) const |
Advanced method to get the temporarily blended software vertex animation information. More... | |
TempBlendedBufferInfo * | _getVertexAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software morph animation. More... | |
void | _initialise (bool forceReinitialise=false) |
Try to initialise the Entity from the underlying resources. More... | |
bool | _isAnimated (void) const |
Tests if any animation applied to this entity. More... | |
bool | _isSkeletonAnimated (void) const |
Tests if skeleton was animated. More... | |
void | _markBuffersUsedForAnimation (void) |
Mark just this vertex data as animated. More... | |
void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. More... | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) More... | |
void | _notifyCurrentCamera (Camera *cam) |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) More... | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. More... | |
void | _updateAnimation (void) |
Advanced method to perform all the updates required for an animated entity. More... | |
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. More... | |
void | addSoftwareAnimationRequest (bool normalsAlso) |
Add a request for software animation. More... | |
virtual void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
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. More... | |
void | backgroundLoadingComplete (Resource *res) |
Resource::Listener hook to notify Entity that a delay-loaded Mesh is complete. More... | |
virtual OGRE_DEPRECATED void | backgroundPreparingComplete (Resource *) |
Callback to indicate that background preparing has completed. More... | |
VertexDataBindChoice | chooseVertexDataForBinding (bool hasVertexAnim) |
Choose which vertex data to bind to the renderer. More... | |
Entity * | clone (const String &newName) const |
Clones this entity and returns a pointer to the clone. More... | |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. More... | |
void | detachAllObjectsFromBone (void) |
Detach all MovableObjects previously attached using attachObjectToBone. More... | |
virtual void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. More... | |
MovableObject * | detachObjectFromBone (const String &movableName) |
Detach a MovableObject previously attached using attachObjectToBone. More... | |
void | detachObjectFromBone (MovableObject *obj) |
Detaches an object by pointer. More... | |
AnimationStateSet * | getAllAnimationStates (void) const |
For entities based on animated meshes, gets the AnimationState objects for all animations. More... | |
bool | getAlwaysUpdateMainSkeleton () const |
The skeleton of the main entity will be updated even if the an LOD entity is being displayed. More... | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
AnimationState * | getAnimationState (const String &name) const |
For entities based on animated meshes, gets the AnimationState object for a single animation. More... | |
ChildObjectListIterator | getAttachedObjectIterator (void) |
Gets an iterator to the list of objects attached to bones on this entity. More... | |
const AxisAlignedBox & | getBoundingBox (void) const |
Real | getBoundingRadius (void) const |
Retrieves the radius of the origin-centered bounding sphere for this object. More... | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. More... | |
AxisAlignedBox | getChildObjectsBoundingBox (void) const |
Merge all the child object Bounds a return it. More... | |
ushort | getCurrentLodIndex () |
Returns the current LOD used to render. More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
bool | getDisplaySkeleton (void) const |
Returns whether or not the entity is currently displaying its skeleton. More... | |
EdgeData * | getEdgeList (void) |
const AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. More... | |
virtual uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
Entity * | getManualLodLevel (size_t index) const |
Gets a pointer to the entity representing the numbered manual level of detail. More... | |
const MeshPtr & | getMesh (void) const |
Gets the Mesh that this Entity is based on. More... | |
const String & | getMovableType (void) const |
Returns the type name of this object. More... | |
virtual const String & | getName (void) const |
Returns the name of this object. More... | |
size_t | getNumManualLodLevels (void) const |
Returns the number of manual levels of detail that this entity supports. More... | |
unsigned int | getNumSubEntities (void) const |
Retrieves the number of SubEntity objects making up this entity. More... | |
virtual Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. More... | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. More... | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant for this object. More... | |
bool | getReceivesShadows () |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More... | |
virtual Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. More... | |
virtual Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
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. More... | |
const EntitySet * | getSkeletonInstanceSharingSet () const |
Returns a pointer to the set of entities which share a SkeletonInstance. More... | |
bool | getSkipAnimationStateUpdate () const |
Entity's skeleton's AnimationState will not be automatically updated when set to true. More... | |
int | getSoftwareAnimationNormalsRequests (void) const |
Returns the number of requests that have been made for software animation of normals. More... | |
int | getSoftwareAnimationRequests (void) const |
Returns the number of requests that have been made for software animation. More... | |
SubEntity * | getSubEntity (unsigned int index) const |
Gets a pointer to a SubEntity, ie a part of an Entity. More... | |
SubEntity * | getSubEntity (const String &name) const |
Gets a pointer to a SubEntity by name. More... | |
uint32 | getTypeFlags (void) const |
Override to return specific type flag. More... | |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
VertexData * | getVertexDataForBinding (void) |
Retrieve the VertexData which should be used for GPU binding. More... | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. More... | |
virtual bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. More... | |
const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
bool | hasAnimationState (const String &name) const |
Returns whether the AnimationState with the given name exists. More... | |
bool | hasEdgeList (void) |
bool | hasSkeleton (void) const |
Returns whether or not this entity is skeletally animated. More... | |
bool | hasVertexAnimation (void) const |
Returns whether or not this entity is either morph or pose animated. More... | |
virtual bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. More... | |
virtual bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. More... | |
bool | isHardwareAnimationEnabled (void) |
Returns whether or not hardware animation is enabled. More... | |
bool | isInitialised (void) const |
Has this Entity been initialised yet? More... | |
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. More... | |
virtual bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) More... | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. More... | |
virtual void | loadingComplete (Resource *) |
Called whenever the resource finishes loading. More... | |
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 More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | preparingComplete (Resource *) |
Called whenever the resource finishes preparing (paging into memory). More... | |
virtual const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. More... | |
void | refreshAvailableAnimationState (void) |
Updates the internal animation state set to include the latest available animations from the attached skeleton. More... | |
virtual void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
void | removeSoftwareAnimationRequest (bool normalsAlso) |
Removes a request for software animation. More... | |
virtual void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
void | setAlwaysUpdateMainSkeleton (bool update) |
The skeleton of the main entity will be updated even if the an LOD entity is being displayed. More... | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. More... | |
virtual void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. More... | |
void | setDisplaySkeleton (bool display) |
Tells the Entity whether or not it should display it's skeleton, if it has one. More... | |
virtual void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. More... | |
virtual void | setListener (Listener *listener) |
Sets a listener for this object. More... | |
void | setMaterial (const MaterialPtr &material) |
Sets the material to use for the whole of this entity. More... | |
void | setMaterialLodBias (Real factor, ushort maxDetailIndex=0, ushort minDetailIndex=99) |
Sets a level-of-detail bias for the material detail of this entity. More... | |
void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Sets the material to use for the whole of this entity. More... | |
void | setMeshLodBias (Real factor, ushort maxDetailIndex=0, ushort minDetailIndex=99) |
Sets a level-of-detail bias for the mesh detail of this entity. More... | |
void | setPolygonModeOverrideable (bool PolygonModeOverrideable) |
Sets whether the polygon mode of this entire entity may be overridden by the camera detail settings. More... | |
virtual void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. More... | |
virtual void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. More... | |
virtual void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
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. More... | |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. More... | |
virtual void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. More... | |
void | shareSkeletonInstanceWith (Entity *entity) |
Shares the SkeletonInstance with the supplied entity. More... | |
bool | sharesSkeletonInstance () const |
Returns whether this entity shares it's SkeltonInstance with other entity instances. More... | |
void | stopSharingSkeletonInstance () |
Stops sharing the SkeletonInstance with other entities. More... | |
virtual void | unloadingComplete (Resource *) |
Called whenever the resource has been unloaded. More... | |
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) |
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. More... | |
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. More... | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. More... | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. More... | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. More... | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. More... | |
Protected Types | |
typedef map< String, StringVector >::type | AnimableDictionaryMap |
typedef vector< Entity * >::type | LODEntityList |
List of LOD Entity instances (for manual LODs). More... | |
typedef vector< SubEntity * >::type | SubEntityList |
List of SubEntities (point to SubMeshes). More... | |
Protected Member Functions | |
Entity () | |
Private constructor (instances cannot be created directly). More... | |
Entity (const String &name, const MeshPtr &mesh) | |
Private constructor - specify name (the usual constructor used). More... | |
StringVector & | _getAnimableValueNames (void) |
Get an updateable reference to animable value list. More... | |
void | applyVertexAnimation (bool hardwareAnimation, bool stencilShadows) |
Apply vertex animation. More... | |
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. More... | |
void | bindMissingHardwarePoseBuffers (const VertexData *srcData, VertexData *destData) |
Ensure that any unbound pose animation buffers are bound to a safe default. More... | |
void | buildSubEntityList (MeshPtr &mesh, SubEntityList *sublist) |
Builds a list of SubEntities based on the SubMeshes contained in the Mesh. More... | |
bool | cacheBoneMatrices (void) |
Private method to cache bone matrices from skeleton. More... | |
bool | calcVertexProcessing (void) |
Calculates the kind of vertex processing in use. More... | |
VertexData * | cloneVertexDataRemoveBlendInfo (const VertexData *source) |
Internal method to clone vertex data definitions but to remove blend buffers. More... | |
void | createAnimableDictionary (void) const |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More... | |
void | detachAllObjectsImpl (void) |
Internal implementation of detaching all 'child' objects of this entity. More... | |
void | detachObjectImpl (MovableObject *pObject) |
Internal implementation of detaching a 'child' object of this entity and clear the parent node of the child entity. More... | |
void | extractTempBufferInfo (VertexData *sourceData, TempBlendedBufferInfo *info) |
Internal method for extracting metadata out of source vertex data for fast assignment of temporary buffers later. More... | |
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const |
Utility method for extruding a bounding box. More... | |
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. More... | |
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. More... | |
SubEntity * | findSubEntityForVertexData (const VertexData *orig) |
Internal method - given vertex data which could be from the Mesh or any SubMesh, finds the corresponding SubEntity. More... | |
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. More... | |
virtual const String & | getAnimableDictionaryName (void) const |
Get the name of the animable dictionary for this class. More... | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper method for calculating extrusion distance. More... | |
ushort | initHardwareAnimationElements (VertexData *vdata, ushort numberOfElements, bool animateNormals) |
Initialise the hardware animation elements for given vertex data. More... | |
virtual void | initialiseAnimableDictionary (StringVector &) const |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More... | |
void | initialisePoseVertexData (const VertexData *srcData, VertexData *destData, bool animateNormals) |
When performing software pose animation, initialise software copy of vertex data. More... | |
void | markBuffersUnusedForAnimation (void) |
Mark all vertex data as so far unanimated. More... | |
void | prepareTempBlendBuffers (void) |
Internal method for preparing this Entity for use in animation. More... | |
void | reevaluateVertexProcessing (void) |
Ensures reevaluation of the vertex processing usage. More... | |
void | restoreBuffersForUnusedAnimation (bool hardwareAnimation) |
Internal method to restore original vertex data where we didn't perform any vertex animation this frame. More... | |
bool | tempSkelAnimBuffersBound (bool requestNormals) const |
Are software skeleton animation temp buffers bound? More... | |
bool | tempVertexAnimBuffersBound (void) const |
Are software vertex animation temp buffers bound? More... | |
void | updateAnimation (void) |
Perform all the updates required for an animated entity. More... | |
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos) |
Tells the caster to perform the tasks necessary to update the edge data's light listing. More... | |
Protected Attributes | |
bool | mAlwaysUpdateMainSkeleton |
Flag indicating whether to update the main entity skeleton even when an LOD is displayed. More... | |
AnimationStateSet * | mAnimationState |
State of animation for animable meshes. More... | |
bool | mBeyondFarDistance |
Hidden because of distance? More... | |
Matrix4 * | mBoneMatrices |
Cached bone matrices in skeleton local space, might shares with other entity instances. More... | |
Matrix4 * | mBoneWorldMatrices |
Cached bone matrices, including any world transform. More... | |
bool | mCastShadows |
Does this object cast shadows? More... | |
ChildObjectList | mChildObjectList |
MovableObjectFactory * | mCreator |
Creator of this object (if created by a factory) More... | |
bool | mCurrentHWAnimationState |
Current state of the hardware animation as represented by the entities parameters. More... | |
bool | mDebugDisplay |
Is debug display enabled? More... | |
bool | mDisplaySkeleton |
Flag determines whether or not to display skeleton. More... | |
unsigned long | mFrameAnimationLastUpdated |
Records the last frame in which animation was updated. More... | |
unsigned long * | mFrameBonesLastUpdated |
Records the last frame in which the bones was updated. More... | |
AxisAlignedBox | mFullBoundingBox |
Bounding box that 'contains' all the mesh of each child entity. More... | |
ushort | mHardwarePoseCount |
Number of hardware poses supported by materials. More... | |
VertexData * | mHardwareVertexAnimVertexData |
Vertex data details for hardware vertex anim of shared geometry. More... | |
bool | mInitialised |
Has this entity been initialised yet? More... | |
Matrix4 | mLastParentXform |
Last parent transform. More... | |
LightList | mLightList |
List of lights for this object. More... | |
ulong | mLightListUpdated |
The last frame that this light list was updated in. More... | |
uint32 | mLightMask |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More... | |
Listener * | mListener |
MovableObject listener - only one allowed (no list) for size & performance reasons. */. More... | |
LODEntityList | mLodEntityList |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
Real | mMaterialLodFactor |
LOD bias factor, not transformed. More... | |
Real | mMaterialLodFactorTransformed |
LOD bias factor, transformed for optimisation when calculating adjusted LOD value. More... | |
ushort | mMaxMaterialLodIndex |
Index of maximum detail LOD (NB lower index is higher detail). More... | |
ushort | mMaxMeshLodIndex |
Index of maximum detail LOD (NB lower index is higher detail). More... | |
MeshPtr | mMesh |
The Mesh that this Entity is based on. More... | |
Real | mMeshLodFactorTransformed |
LOD bias factor, transformed for optimisation when calculating adjusted LOD value. More... | |
ushort | mMeshLodIndex |
The LOD number of the mesh to use, calculated by _notifyCurrentCamera. More... | |
size_t | mMeshStateCount |
Mesh state count, used to detect differences. More... | |
ushort | mMinMaterialLodIndex |
Index of minimum detail LOD (NB higher index is lower detail). More... | |
ushort | mMinMeshLodIndex |
Index of minimum detail LOD (NB higher index is lower detail). More... | |
Real | mMinPixelSize |
String | mName |
Name of this object. More... | |
unsigned short | mNumBoneMatrices |
bool | mParentIsTagPoint |
Node * | mParentNode |
node to which this object is attached More... | |
bool | mPreparedForShadowVolumes |
Have the temp buffers already had their geometry prepared for use in rendering shadow volumes? More... | |
uint32 | mQueryFlags |
Flags determining whether this object is included / excluded from scene queries. More... | |
bool | mRenderingDisabled |
Does rendering this object disabled by listener? More... | |
uint8 | mRenderQueueID |
The render queue to use when rendering this object. More... | |
bool | mRenderQueueIDSet |
Flags whether the RenderQueue's default should be used. More... | |
ushort | mRenderQueuePriority |
The render queue group to use when rendering this object. More... | |
bool | mRenderQueuePrioritySet |
Flags whether the RenderQueue's default should be used. More... | |
SchemeHardwareAnimMap | mSchemeHardwareAnim |
Flag indicating whether hardware animation is supported by this entities materials data is saved per scehme number. More... | |
ShadowRenderableList | mShadowRenderables |
EntitySet * | mSharedSkeletonEntities |
A set of all the entities which shares a single SkeletonInstance. More... | |
VertexData * | mSkelAnimVertexData |
Vertex data details for software skeletal anim of shared geometry. More... | |
SkeletonInstance * | mSkeletonInstance |
This Entity's personal copy of the skeleton, if skeletally animated. More... | |
bool | mSkipAnimStateUpdates |
Flag indicating whether to skip automatic updating of the Skeleton's AnimationState. More... | |
int | mSoftwareAnimationNormalsRequests |
Counter indicating number of requests for software blended normals. More... | |
int | mSoftwareAnimationRequests |
Counter indicating number of requests for software animation. More... | |
VertexData * | mSoftwareVertexAnimVertexData |
Vertex data details for software vertex anim of shared geometry. More... | |
Real | mSquaredUpperDistance |
SubEntityList | mSubEntityList |
TempBlendedBufferInfo | mTempSkelAnimInfo |
Temp buffer details for software skeletal anim of shared geometry. More... | |
TempBlendedBufferInfo | mTempVertexAnimInfo |
Temp buffer details for software vertex anim of shared geometry. More... | |
Real | mUpperDistance |
Upper distance to still render. More... | |
UserObjectBindings | mUserObjectBindings |
User objects binding. More... | |
bool | mVertexAnimationAppliedThisFrame |
Have we applied any vertex animation to shared geometry? More... | |
bool | mVertexProgramInUse |
Flag indicating whether we have a vertex program in use on any of our subentities. More... | |
uint32 | mVisibilityFlags |
Flags determining whether this object is visible (compared to SceneManager mask) More... | |
bool | mVisible |
Is this object visible? More... | |
AxisAlignedBox | mWorldAABB |
Cached world AABB of this object. More... | |
Sphere | mWorldBoundingSphere |
AxisAlignedBox | mWorldDarkCapBounds |
World space AABB of this object's dark cap. More... | |
Static Protected Attributes | |
static AnimableDictionaryMap | msAnimableDictionary |
Static map of class name to list of animable value names. More... | |
static uint32 | msDefaultQueryFlags |
Default query flags. More... | |
static uint32 | msDefaultVisibilityFlags |
Default visibility flags. More... | |
Friends | |
class | EntityFactory |
class | SubEntity |
Defines an instance of a discrete, movable object based on a Mesh.
Definition at line 82 of file OgreEntity.h.
|
protectedinherited |
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.
Definition at line 584 of file OgreEntity.h.
typedef set<Entity*>::type Ogre::Entity::EntitySet |
Definition at line 89 of file OgreEntity.h.
|
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.
|
inherited |
Definition at line 136 of file OgreShadowCaster.h.
|
inherited |
Definition at line 137 of file OgreShadowCaster.h.
|
protected |
List of SubEntities (point to SubMeshes).
Definition at line 107 of file OgreEntity.h.
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.
|
protected |
Private constructor (instances cannot be created directly).
Private constructor - specify name (the usual constructor used).
Ogre::Entity::~Entity | ( | ) |
Default destructor.
void Ogre::Entity::_deinitialise | ( | void | ) |
Tear down the internal structures of this Entity, rendering it uninitialised.
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inline |
Internal method for retrieving bone matrix information.
Definition at line 606 of file OgreEntity.h.
|
inline |
Are buffers already marked as vertex animated?
Definition at line 784 of file OgreEntity.h.
|
inlinevirtualinherited |
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.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 491 of file OgreMovableObject.h.
|
inlinevirtualinherited |
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.
|
inline |
Internal method for retrieving bone matrix information.
Definition at line 608 of file OgreEntity.h.
|
virtualinherited |
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.
VertexData* Ogre::Entity::_getSoftwareVertexAnimVertexData | ( | void | ) | const |
Advanced method to get the temporarily blended software vertex animation information.
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.
bool Ogre::Entity::_isAnimated | ( | void | ) | const |
Tests if any animation applied to this entity.
bool Ogre::Entity::_isSkeletonAnimated | ( | void | ) | const |
Tests if skeleton was animated.
void Ogre::Entity::_markBuffersUsedForAnimation | ( | void | ) |
Mark just this vertex data as animated.
|
virtual |
Internal method called to notify the object that it has been attached to a node.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 184 of file OgreMovableObject.h.
|
virtual |
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 188 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, Ogre::InstancedEntity, and Ogre::PCZLight.
void Ogre::Entity::_updateAnimation | ( | void | ) |
Advanced method to perform all the updates required for an animated entity.
|
virtual |
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
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.
|
inlinevirtualinherited |
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.
|
protected |
Apply vertex animation.
|
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.
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. |
|
virtual |
Resource::Listener hook to notify Entity that a delay-loaded Mesh is complete.
Reimplemented from Ogre::Resource::Listener.
|
inlinevirtualinherited |
Callback to indicate that background preparing has completed.
Definition at line 99 of file OgreResource.h.
|
protected |
Ensure that any unbound pose animation buffers are bound to a safe default.
srcData | Original vertex data containing original positions. |
destData | Hardware animation vertex data to be checked. |
|
protected |
Builds a list of SubEntities based on the SubMeshes contained in the Mesh.
|
protected |
Private method to cache bone matrices from skeleton.
|
protected |
Calculates the kind of vertex processing in use.
VertexDataBindChoice Ogre::Entity::chooseVertexDataForBinding | ( | bool | hasVertexAnim | ) |
Choose which vertex data to bind to the renderer.
Clones this entity and returns a pointer to the clone.
newName | Name for the new entity. |
|
protected |
Internal method to clone vertex data definitions but to remove blend buffers.
|
inlineprotectedinherited |
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.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 320 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
void Ogre::Entity::detachAllObjectsFromBone | ( | void | ) |
Detach all MovableObjects previously attached using attachObjectToBone.
|
protected |
Internal implementation of detaching all 'child' objects of this entity.
|
virtualinherited |
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.
movableName | The name of the movable object to be detached. |
void Ogre::Entity::detachObjectFromBone | ( | MovableObject * | obj | ) |
Detaches an object by pointer.
|
protected |
Internal implementation of detaching a 'child' object of this entity and clear the parent node of the child entity.
|
protected |
Internal method for extracting metadata out of source vertex data for fast assignment of temporary buffers later.
|
protectedvirtualinherited |
Utility method for extruding a bounding box.
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. |
|
staticinherited |
Utility method for extruding vertices based on a light.
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. |
|
protected |
When animating normals for pose animation, finalise normals by filling in with the reference mesh normal where applied normal weights < 1.
|
protected |
Internal method - given vertex data which could be from the Mesh or any submesh, finds the temporary blend copy.
|
protected |
|
protectedvirtualinherited |
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
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.
|
inline |
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.
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 249 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
inlineinherited |
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, and OGRE_EXCEPT.
AnimationState* Ogre::Entity::getAnimationState | ( | const String & | name | ) | const |
For entities based on animated meshes, gets the AnimationState object for a single animation.
ChildObjectListIterator Ogre::Entity::getAttachedObjectIterator | ( | void | ) |
Gets an iterator to the list of objects attached to bones on this entity.
|
virtual |
Implements Ogre::MovableObject.
|
virtual |
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
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.
|
inline |
Returns the current LOD used to render.
Definition at line 474 of file OgreEntity.h.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 411 of file OgreMovableObject.h.
|
inlinestaticinherited |
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.
|
virtual |
Implements Ogre::ShadowCaster.
|
protectedinherited |
Helper method for calculating extrusion distance.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 476 of file OgreMovableObject.h.
|
inlinevirtualinherited |
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.
|
virtual |
Returns the type name of this object.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
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.
unsigned int Ogre::Entity::getNumSubEntities | ( | void | ) | const |
Retrieves the number of SubEntity objects making up this entity.
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 403 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 305 of file OgreMovableObject.h.
|
inlinevirtualinherited |
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.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
virtual |
Implements Ogre::ShadowCaster.
|
inline |
Get this Entity's personal skeleton instance.
Definition at line 612 of file OgreEntity.h.
|
inline |
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.
|
inline |
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.
|
inline |
Returns the number of requests that have been made for software animation of normals.
Definition at line 651 of file OgreEntity.h.
|
inline |
Returns the number of requests that have been made for software animation.
Definition at line 639 of file OgreEntity.h.
SubEntity* Ogre::Entity::getSubEntity | ( | unsigned int | index | ) | const |
|
virtual |
Override to return specific type flag.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Definition at line 334 of file OgreMovableObject.h.
|
inlineinherited |
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.
Definition at line 340 of file OgreMovableObject.h.
|
inlineinherited |
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.
Definition at line 346 of file OgreMovableObject.h.
VertexData* Ogre::Entity::getVertexDataForBinding | ( | void | ) |
Retrieve the VertexData which should be used for GPU binding.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 431 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtual |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Reimplemented from Ogre::MovableObject.
|
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.
|
virtual |
Implements Ogre::ShadowCaster.
|
inline |
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.
|
protected |
Initialise the hardware animation elements for given vertex data.
|
inlineprotectedvirtualinherited |
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.
|
protected |
When performing software pose animation, initialise software copy of vertex data.
|
virtualinherited |
|
inlinevirtualinherited |
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.
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.
|
inline |
Has this Entity been initialised yet?
Definition at line 797 of file OgreEntity.h.
|
virtualinherited |
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.
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 216 of file OgreMovableObject.h.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
inlinevirtualinherited |
Called whenever the resource finishes loading.
Reimplemented in Ogre::GpuProgramUsage.
Definition at line 109 of file OgreResource.h.
|
protected |
Mark all vertex data as so far unanimated.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
protected |
Internal method for preparing this Entity for use in animation.
|
inlinevirtualinherited |
Called whenever the resource finishes preparing (paging into memory).
Definition at line 120 of file OgreResource.h.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
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.
|
inlinevirtualinherited |
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.
|
inlinevirtualinherited |
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.
|
protected |
Internal method to restore original vertex data where we didn't perform any vertex animation this frame.
|
inline |
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.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 519 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 563 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 407 of file OgreMovableObject.h.
|
inlinestaticinherited |
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.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
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.
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.
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.
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.
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.
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 392 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the distance at which the object is no longer rendered.
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.
|
inlinevirtualinherited |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered). |
Definition at line 312 of file OgreMovableObject.h.
|
virtual |
Reimplemented from Ogre::MovableObject.
Reimplemented from Ogre::MovableObject.
|
inline |
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.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 329 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the visibility flags for this object.
Definition at line 420 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
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.
|
inline |
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.
|
protected |
Are software skeleton animation temp buffers bound?
|
protected |
Are software vertex animation temp buffers bound?
|
inlinevirtualinherited |
Called whenever the resource has been unloaded.
Reimplemented in Ogre::GpuProgramUsage.
Definition at line 123 of file OgreResource.h.
|
protected |
Perform all the updates required for an animated entity.
|
protectedvirtualinherited |
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.
edgeData | The edge information to update. |
lightPos | 4D vector representing the light, a directional light has w=0.0. |
|
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.
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.
|
friend |
Definition at line 85 of file OgreEntity.h.
|
friend |
Definition at line 86 of file OgreEntity.h.
|
protected |
Flag indicating whether to update the main entity skeleton even when an LOD is displayed.
Definition at line 227 of file OgreEntity.h.
|
protected |
State of animation for animable meshes.
Definition at line 112 of file OgreEntity.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 128 of file OgreMovableObject.h.
|
protected |
Cached bone matrices in skeleton local space, might shares with other entity instances.
Definition at line 181 of file OgreEntity.h.
|
protected |
Cached bone matrices, including any world transform.
Definition at line 179 of file OgreEntity.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 150 of file OgreMovableObject.h.
|
protected |
Definition at line 306 of file OgreEntity.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 112 of file OgreMovableObject.h.
|
protected |
Current state of the hardware animation as represented by the entities parameters.
Definition at line 214 of file OgreEntity.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 121 of file OgreMovableObject.h.
|
protected |
Flag determines whether or not to display skeleton.
Definition at line 207 of file OgreEntity.h.
|
protected |
Records the last frame in which animation was updated.
Definition at line 184 of file OgreEntity.h.
|
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.
|
mutableprotected |
Bounding box that 'contains' all the mesh of each child entity.
Definition at line 310 of file OgreEntity.h.
|
protected |
Number of hardware poses supported by materials.
Definition at line 217 of file OgreEntity.h.
|
protected |
Vertex data details for hardware vertex anim of shared geometry.
Definition at line 126 of file OgreEntity.h.
|
protected |
Has this entity been initialised yet?
Definition at line 262 of file OgreEntity.h.
|
protected |
Last parent transform.
Definition at line 265 of file OgreEntity.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 158 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 160 of file OgreMovableObject.h.
|
protectedinherited |
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.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 155 of file OgreMovableObject.h.
|
protected |
Definition at line 255 of file OgreEntity.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 114 of file OgreMovableObject.h.
|
protected |
LOD bias factor, not transformed.
Definition at line 241 of file OgreEntity.h.
|
protected |
LOD bias factor, transformed for optimisation when calculating adjusted LOD value.
Definition at line 243 of file OgreEntity.h.
|
protected |
Index of maximum detail LOD (NB lower index is higher detail).
Definition at line 247 of file OgreEntity.h.
|
protected |
Index of maximum detail LOD (NB lower index is higher detail).
Definition at line 238 of file OgreEntity.h.
|
protected |
The Mesh that this Entity is based on.
Definition at line 103 of file OgreEntity.h.
|
protected |
LOD bias factor, transformed for optimisation when calculating adjusted LOD value.
Definition at line 234 of file OgreEntity.h.
|
protected |
The LOD number of the mesh to use, calculated by _notifyCurrentCamera.
Definition at line 231 of file OgreEntity.h.
|
protected |
Mesh state count, used to detect differences.
Definition at line 268 of file OgreEntity.h.
|
protected |
Index of minimum detail LOD (NB higher index is lower detail).
Definition at line 245 of file OgreEntity.h.
|
protected |
Index of minimum detail LOD (NB higher index is lower detail).
Definition at line 236 of file OgreEntity.h.
|
protectedinherited |
Definition at line 126 of file OgreMovableObject.h.
|
protectedinherited |
Name of this object.
Definition at line 110 of file OgreMovableObject.h.
|
protected |
Definition at line 182 of file OgreEntity.h.
|
protectedinherited |
Definition at line 117 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 116 of file OgreMovableObject.h.
|
protected |
Have the temp buffers already had their geometry prepared for use in rendering shadow volumes?
Definition at line 130 of file OgreEntity.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 140 of file OgreMovableObject.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 153 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 132 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 134 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 136 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 138 of file OgreMovableObject.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
|
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.
|
staticprotectedinherited |
Default query flags.
Definition at line 167 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 169 of file OgreMovableObject.h.
|
protected |
Definition at line 312 of file OgreEntity.h.
|
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.
|
protected |
Vertex data details for software skeletal anim of shared geometry.
Definition at line 118 of file OgreEntity.h.
|
protected |
This Entity's personal copy of the skeleton, if skeletally animated.
Definition at line 259 of file OgreEntity.h.
|
protected |
Flag indicating whether to skip automatic updating of the Skeleton's AnimationState.
Definition at line 225 of file OgreEntity.h.
|
protected |
Counter indicating number of requests for software blended normals.
Definition at line 223 of file OgreEntity.h.
|
protected |
Counter indicating number of requests for software animation.
Definition at line 221 of file OgreEntity.h.
|
protected |
Vertex data details for software vertex anim of shared geometry.
Definition at line 122 of file OgreEntity.h.
|
protectedinherited |
Definition at line 124 of file OgreMovableObject.h.
|
protected |
Definition at line 108 of file OgreEntity.h.
|
protected |
Temp buffer details for software skeletal anim of shared geometry.
Definition at line 116 of file OgreEntity.h.
|
protected |
Temp buffer details for software vertex anim of shared geometry.
Definition at line 120 of file OgreEntity.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 123 of file OgreMovableObject.h.
|
protectedinherited |
User objects binding.
Definition at line 130 of file OgreMovableObject.h.
|
protected |
Have we applied any vertex animation to shared geometry?
Definition at line 128 of file OgreEntity.h.
|
protected |
Flag indicating whether we have a vertex program in use on any of our subentities.
Definition at line 219 of file OgreEntity.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 142 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 119 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 144 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 146 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 148 of file OgreMovableObject.h.