Utility class which defines the sub-parts of an Entity. More...
#include <OgreSubEntity.h>
Public Member Functions | |
const String & | getMaterialName () const |
Gets the name of the Material in use by this instance. | |
void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Sets the name of the Material to be used. | |
void | setMaterial (const MaterialPtr &material) |
Sets a Material to be used. | |
virtual void | setVisible (bool visible) |
Tells this SubEntity whether to be visible or not. | |
virtual bool | isVisible (void) const |
Returns whether or not this SubEntity is supposed to be visible. | |
SubMesh * | getSubMesh (void) |
Accessor method to read mesh data. | |
Entity * | getParent (void) const |
Accessor to get parent Entity. | |
const MaterialPtr & | getMaterial (void) const |
Overridden - see Renderable. | |
Technique * | getTechnique (void) const |
Overridden - see Renderable. | |
void | getRenderOperation (RenderOperation &op) |
Overridden - see Renderable. | |
void | getWorldTransforms (Matrix4 *xform) const |
Overridden - see Renderable. | |
unsigned short | getNumWorldTransforms (void) const |
Overridden - see Renderable. | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden, see Renderable. | |
const LightList & | getLights (void) const |
bool | getCastsShadows (void) const |
VertexData * | _getSkelAnimVertexData (void) |
Advanced method to get the temporarily blended vertex information for entities which are software skinned. | |
VertexData * | _getSoftwareVertexAnimVertexData (void) |
Advanced method to get the temporarily blended software morph vertex information. | |
VertexData * | _getHardwareVertexAnimVertexData (void) |
Advanced method to get the hardware morph vertex information. | |
TempBlendedBufferInfo * | _getSkelAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software skeletal animation. | |
TempBlendedBufferInfo * | _getVertexAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software morph animation. | |
VertexData * | getVertexDataForBinding (void) |
Retrieve the VertexData which should be used for GPU binding. | |
void | _markBuffersUnusedForAnimation (void) |
Mark all vertex data as so far unanimated. | |
void | _markBuffersUsedForAnimation (void) |
Mark all vertex data as animated. | |
bool | _getBuffersMarkedForAnimation (void) const |
Are buffers already marked as vertex animated? | |
void | _restoreBuffersForUnusedAnimation (bool hardwareAnimation) |
Internal method to copy original vertex data to the morph structures should there be no active animation in use. | |
void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Overridden from Renderable to provide some custom behaviour. | |
void | _invalidateCameraCache () |
Invalidate the camera distance cache. | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
void | setCustomParameter (size_t index, const Vector4 &value) |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
virtual void | setUserAny (const Any &anything) |
virtual 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. | |
virtual RenderSystemData * | getRenderSystemData () const |
Sets render system private data. | |
virtual void | setRenderSystemData (RenderSystemData *val) const |
gets render system private data | |
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) |
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 *) |
Protected Types | |
typedef map< size_t, Vector4 > ::type | CustomParameterMap |
Protected Member Functions | |
SubEntity (Entity *parent, SubMesh *subMeshBasis) | |
Private constructor - don't allow creation by anybody else. | |
virtual | ~SubEntity () |
Private destructor. | |
void | prepareTempBlendBuffers (void) |
Internal method for preparing this Entity for use in animation. | |
Protected Attributes | |
Entity * | mParentEntity |
Pointer to parent. | |
String | mMaterialName |
Name of Material in use by this SubEntity. | |
MaterialPtr | mpMaterial |
Cached pointer to material. | |
SubMesh * | mSubMesh |
bool | mVisible |
Is this SubEntity visible? | |
unsigned short | mMaterialLodIndex |
The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera. | |
VertexData * | mSkelAnimVertexData |
blend buffer details for dedicated geometry | |
TempBlendedBufferInfo | mTempSkelAnimInfo |
Quick lookup of buffers. | |
TempBlendedBufferInfo | mTempVertexAnimInfo |
Temp buffer details for software Vertex anim geometry. | |
VertexData * | mSoftwareVertexAnimVertexData |
Vertex data details for software Vertex anim of shared geometry. | |
VertexData * | mHardwareVertexAnimVertexData |
Vertex data details for hardware Vertex anim of shared geometry. | |
bool | mVertexAnimationAppliedThisFrame |
Have we applied any vertex animation to geometry? | |
ushort | mHardwarePoseCount |
Number of hardware blended poses supported by material. | |
Real | mCachedCameraDist |
Cached distance to last camera for getSquaredViewDepth. | |
const Camera * | mCachedCamera |
The camera for which the cached distance is valid. | |
CustomParameterMap | mCustomParameters |
bool | mPolygonModeOverrideable |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
RenderSystemData * | mRenderSystemData |
Friends | |
class | Entity |
class | SceneManager |
Utility class which defines the sub-parts of an Entity.
Definition at line 62 of file OgreSubEntity.h.
typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap [protected, inherited] |
Definition at line 395 of file OgreRenderable.h.
Private constructor - don't allow creation by anybody else.
virtual Ogre::SubEntity::~SubEntity | ( | ) | [protected, virtual] |
Private destructor.
bool Ogre::SubEntity::_getBuffersMarkedForAnimation | ( | void | ) | const |
Are buffers already marked as vertex animated?
Definition at line 218 of file OgreSubEntity.h.
VertexData* Ogre::SubEntity::_getHardwareVertexAnimVertexData | ( | void | ) |
Advanced method to get the hardware morph vertex information.
TempBlendedBufferInfo* Ogre::SubEntity::_getSkelAnimTempBufferInfo | ( | void | ) |
Advanced method to get the temp buffer information for software skeletal animation.
VertexData* Ogre::SubEntity::_getSkelAnimVertexData | ( | void | ) |
Advanced method to get the temporarily blended vertex information for entities which are software skinned.
VertexData* Ogre::SubEntity::_getSoftwareVertexAnimVertexData | ( | void | ) |
Advanced method to get the temporarily blended software morph vertex information.
TempBlendedBufferInfo* Ogre::SubEntity::_getVertexAnimTempBufferInfo | ( | void | ) |
Advanced method to get the temp buffer information for software morph animation.
void Ogre::SubEntity::_invalidateCameraCache | ( | ) |
Invalidate the camera distance cache.
Definition at line 230 of file OgreSubEntity.h.
void Ogre::SubEntity::_markBuffersUnusedForAnimation | ( | void | ) |
Mark all vertex data as so far unanimated.
void Ogre::SubEntity::_markBuffersUsedForAnimation | ( | void | ) |
Mark all vertex data as animated.
void Ogre::SubEntity::_restoreBuffersForUnusedAnimation | ( | bool | hardwareAnimation | ) |
Internal method to copy original vertex data to the morph structures should there be no active animation in use.
void Ogre::SubEntity::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry, |
GpuProgramParameters * | params | ||
) | const [virtual] |
Overridden from Renderable to provide some custom behaviour.
Reimplemented from Ogre::Renderable.
bool Ogre::SubEntity::getCastsShadows | ( | void | ) | const [virtual] |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented from Ogre::Renderable.
const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const [inherited] |
Gets the custom value associated with this Renderable at the given index.
@see | setCustomParameter for full details. |
Definition at line 249 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
const LightList& Ogre::SubEntity::getLights | ( | void | ) | const [virtual] |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
const MaterialPtr& Ogre::SubEntity::getMaterial | ( | void | ) | const [virtual] |
Overridden - see Renderable.
Implements Ogre::Renderable.
const String& Ogre::SubEntity::getMaterialName | ( | ) | const |
Gets the name of the Material in use by this instance.
unsigned short Ogre::SubEntity::getNumWorldTransforms | ( | void | ) | const [virtual] |
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
Entity* Ogre::SubEntity::getParent | ( | void | ) | const |
Accessor to get parent Entity.
Definition at line 150 of file OgreSubEntity.h.
virtual bool Ogre::Renderable::getPolygonModeOverrideable | ( | void | ) | const [virtual, inherited] |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 313 of file OgreRenderable.h.
void Ogre::SubEntity::getRenderOperation | ( | RenderOperation & | op | ) | [virtual] |
Overridden - see Renderable.
Implements Ogre::Renderable.
virtual RenderSystemData* Ogre::Renderable::getRenderSystemData | ( | ) | const [virtual, inherited] |
Sets render system private data.
Definition at line 380 of file OgreRenderable.h.
Overridden, see Renderable.
Implements Ogre::Renderable.
SubMesh* Ogre::SubEntity::getSubMesh | ( | void | ) |
Accessor method to read mesh data.
Technique* Ogre::SubEntity::getTechnique | ( | void | ) | const [virtual] |
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
bool Ogre::Renderable::getUseIdentityProjection | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' projection.
Definition at line 177 of file OgreRenderable.h.
bool Ogre::Renderable::getUseIdentityView | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' view.
Definition at line 202 of file OgreRenderable.h.
virtual const Any& Ogre::Renderable::getUserAny | ( | void | ) | const [virtual, inherited] |
Retrieves the custom user value associated with this object.
Definition at line 330 of file OgreRenderable.h.
const UserObjectBindings& Ogre::Renderable::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.
Definition at line 342 of file OgreRenderable.h.
UserObjectBindings& Ogre::Renderable::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.
Definition at line 336 of file OgreRenderable.h.
VertexData* Ogre::SubEntity::getVertexDataForBinding | ( | void | ) |
Retrieve the VertexData which should be used for GPU binding.
void Ogre::SubEntity::getWorldTransforms | ( | Matrix4 * | xform | ) | const [virtual] |
Overridden - see Renderable.
Implements Ogre::Renderable.
virtual bool Ogre::SubEntity::isVisible | ( | void | ) | const [virtual] |
Returns whether or not this SubEntity is supposed to be visible.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
const char * | , | ||
int | , | ||
const char * | |||
) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
void * | |||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
const char * | , | ||
int | , | ||
const char * | |||
) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
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 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
void * | ptr | ||
) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
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 85 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
virtual void Ogre::Renderable::postRender | ( | SceneManager * | sm, |
RenderSystem * | rsys | ||
) | [virtual, inherited] |
Called immediately after the Renderable has been rendered.
Definition at line 127 of file OgreRenderable.h.
void Ogre::SubEntity::prepareTempBlendBuffers | ( | void | ) | [protected] |
Internal method for preparing this Entity for use in animation.
virtual bool Ogre::Renderable::preRender | ( | SceneManager * | sm, |
RenderSystem * | rsys | ||
) | [virtual, inherited] |
Called just prior to the Renderable being rendered.
Definition at line 122 of file OgreRenderable.h.
void Ogre::Renderable::setCustomParameter | ( | size_t | index, |
const Vector4 & | value | ||
) | [inherited] |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. |
value | The value to associate. |
Definition at line 240 of file OgreRenderable.h.
void Ogre::SubEntity::setMaterial | ( | const MaterialPtr & | material | ) |
void Ogre::SubEntity::setMaterialName | ( | const String & | name, |
const String & | groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME |
||
) |
virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) | [virtual, inherited] |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
Definition at line 305 of file OgreRenderable.h.
virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const [virtual, inherited] |
gets render system private data
Definition at line 388 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityProjection | ( | bool | useIdentityProjection | ) | [inherited] |
Sets whether or not to use an 'identity' projection.
Definition at line 163 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityView | ( | bool | useIdentityView | ) | [inherited] |
Sets whether or not to use an 'identity' view.
Definition at line 188 of file OgreRenderable.h.
virtual void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) | [virtual, inherited] |
Sets any kind of user value on this object.
Definition at line 325 of file OgreRenderable.h.
virtual void Ogre::SubEntity::setVisible | ( | bool | visible | ) | [virtual] |
Tells this SubEntity whether to be visible or not.
friend class Entity [friend] |
Definition at line 65 of file OgreSubEntity.h.
friend class SceneManager [friend] |
Definition at line 66 of file OgreSubEntity.h.
const Camera* Ogre::SubEntity::mCachedCamera [mutable, protected] |
The camera for which the cached distance is valid.
Definition at line 113 of file OgreSubEntity.h.
Real Ogre::SubEntity::mCachedCameraDist [mutable, protected] |
Cached distance to last camera for getSquaredViewDepth.
Definition at line 111 of file OgreSubEntity.h.
CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited] |
Definition at line 396 of file OgreRenderable.h.
ushort Ogre::SubEntity::mHardwarePoseCount [protected] |
Number of hardware blended poses supported by material.
Definition at line 109 of file OgreSubEntity.h.
VertexData* Ogre::SubEntity::mHardwareVertexAnimVertexData [protected] |
Vertex data details for hardware Vertex anim of shared geometry.
Definition at line 105 of file OgreSubEntity.h.
unsigned short Ogre::SubEntity::mMaterialLodIndex [protected] |
The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.
Definition at line 92 of file OgreSubEntity.h.
String Ogre::SubEntity::mMaterialName [protected] |
Name of Material in use by this SubEntity.
Definition at line 80 of file OgreSubEntity.h.
Entity* Ogre::SubEntity::mParentEntity [protected] |
Pointer to parent.
Definition at line 77 of file OgreSubEntity.h.
MaterialPtr Ogre::SubEntity::mpMaterial [protected] |
Cached pointer to material.
Definition at line 83 of file OgreSubEntity.h.
bool Ogre::Renderable::mPolygonModeOverrideable [protected, inherited] |
Definition at line 397 of file OgreRenderable.h.
RenderSystemData* Ogre::Renderable::mRenderSystemData [mutable, protected, inherited] |
Definition at line 401 of file OgreRenderable.h.
VertexData* Ogre::SubEntity::mSkelAnimVertexData [protected] |
blend buffer details for dedicated geometry
Definition at line 95 of file OgreSubEntity.h.
VertexData* Ogre::SubEntity::mSoftwareVertexAnimVertexData [protected] |
Vertex data details for software Vertex anim of shared geometry.
Definition at line 101 of file OgreSubEntity.h.
SubMesh* Ogre::SubEntity::mSubMesh [protected] |
Definition at line 86 of file OgreSubEntity.h.
Quick lookup of buffers.
Definition at line 97 of file OgreSubEntity.h.
Temp buffer details for software Vertex anim geometry.
Definition at line 99 of file OgreSubEntity.h.
bool Ogre::Renderable::mUseIdentityProjection [protected, inherited] |
Definition at line 398 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityView [protected, inherited] |
Definition at line 399 of file OgreRenderable.h.
UserObjectBindings Ogre::Renderable::mUserObjectBindings [protected, inherited] |
Definition at line 400 of file OgreRenderable.h.
bool Ogre::SubEntity::mVertexAnimationAppliedThisFrame [protected] |
Have we applied any vertex animation to geometry?
Definition at line 107 of file OgreSubEntity.h.
bool Ogre::SubEntity::mVisible [protected] |
Is this SubEntity visible?
Definition at line 89 of file OgreSubEntity.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Jan 14 2012 18:40:55