Utility class which defines the sub-parts of an Entity. More...
#include <OgreSubEntity.h>
Public Member Functions | |
bool | _getBuffersMarkedForAnimation (void) const |
Are buffers already marked as vertex animated? More... | |
VertexData * | _getHardwareVertexAnimVertexData (void) |
Advanced method to get the hardware morph vertex information. More... | |
TempBlendedBufferInfo * | _getSkelAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software skeletal animation. More... | |
VertexData * | _getSkelAnimVertexData (void) |
Advanced method to get the temporarily blended vertex information for entities which are software skinned. More... | |
VertexData * | _getSoftwareVertexAnimVertexData (void) |
Advanced method to get the temporarily blended software morph vertex information. More... | |
TempBlendedBufferInfo * | _getVertexAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software morph animation. More... | |
void | _invalidateCameraCache () |
Invalidate the camera distance cache. More... | |
void | _markBuffersUnusedForAnimation (void) |
Mark all vertex data as so far unanimated. More... | |
void | _markBuffersUsedForAnimation (void) |
Mark all vertex data as animated. More... | |
void | _restoreBuffersForUnusedAnimation (bool hardwareAnimation) |
Internal method to copy original vertex data to the morph structures should there be no active animation in use. More... | |
void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Overridden from Renderable to provide some custom behaviour. More... | |
bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. More... | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
const MaterialPtr & | getMaterial (void) const |
Overridden - see Renderable. More... | |
const String & | getMaterialName () const |
Gets the name of the Material in use by this instance. More... | |
unsigned short | getNumWorldTransforms (void) const |
Overridden - see Renderable. More... | |
Entity * | getParent (void) const |
Accessor to get parent Entity. More... | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
void | getRenderOperation (RenderOperation &op) |
Overridden - see Renderable. More... | |
virtual RenderSystemData * | getRenderSystemData () const |
Sets render system private data. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden, see Renderable. More... | |
SubMesh * | getSubMesh (void) |
Accessor method to read mesh data. More... | |
Technique * | getTechnique (void) const |
Overridden - see Renderable. More... | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. More... | |
virtual 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... | |
void | getWorldTransforms (Matrix4 *xform) const |
Overridden - see Renderable. More... | |
virtual bool | isVisible (void) const |
Returns whether or not this SubEntity is supposed to be visible. 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 | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. More... | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. More... | |
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. More... | |
void | setMaterial (const MaterialPtr &material) |
Sets a Material to be used. More... | |
void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Sets the name of the Material to be used. More... | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
virtual void | setRenderSystemData (RenderSystemData *val) const |
gets render system private data More... | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. More... | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. More... | |
virtual void | setUserAny (const Any &anything) |
virtual void | setVisible (bool visible) |
Tells this SubEntity whether to be visible or not. More... | |
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. More... | |
virtual | ~SubEntity () |
Private destructor. More... | |
void | prepareTempBlendBuffers (void) |
Internal method for preparing this Entity for use in animation. More... | |
Protected Attributes | |
const Camera * | mCachedCamera |
The camera for which the cached distance is valid. More... | |
Real | mCachedCameraDist |
Cached distance to last camera for getSquaredViewDepth. More... | |
CustomParameterMap | mCustomParameters |
ushort | mHardwarePoseCount |
Number of hardware blended poses supported by material. More... | |
VertexData * | mHardwareVertexAnimVertexData |
Vertex data details for hardware Vertex anim of shared geometry. More... | |
unsigned short | mMaterialLodIndex |
The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera. More... | |
String | mMaterialName |
Name of Material in use by this SubEntity. More... | |
Entity * | mParentEntity |
Pointer to parent. More... | |
MaterialPtr | mpMaterial |
Cached pointer to material. More... | |
bool | mPolygonModeOverrideable |
RenderSystemData * | mRenderSystemData |
VertexData * | mSkelAnimVertexData |
blend buffer details for dedicated geometry More... | |
VertexData * | mSoftwareVertexAnimVertexData |
Vertex data details for software Vertex anim of shared geometry. More... | |
SubMesh * | mSubMesh |
TempBlendedBufferInfo | mTempSkelAnimInfo |
Quick lookup of buffers. More... | |
TempBlendedBufferInfo | mTempVertexAnimInfo |
Temp buffer details for software Vertex anim geometry. More... | |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
bool | mVertexAnimationAppliedThisFrame |
Have we applied any vertex animation to geometry? More... | |
bool | mVisible |
Is this SubEntity visible? More... | |
Friends | |
class | Entity |
class | SceneManager |
Utility class which defines the sub-parts of an Entity.
Definition at line 62 of file OgreSubEntity.h.
|
protectedinherited |
Definition at line 395 of file OgreRenderable.h.
Private constructor - don't allow creation by anybody else.
|
protectedvirtual |
Private destructor.
|
inline |
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.
|
inline |
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.
|
virtual |
Overridden from Renderable to provide some custom behaviour.
Reimplemented from Ogre::Renderable.
|
virtual |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented from Ogre::Renderable.
|
inlineinherited |
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.
|
virtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
virtual |
Overridden - see Renderable.
Implements Ogre::Renderable.
const String& Ogre::SubEntity::getMaterialName | ( | ) | const |
Gets the name of the Material in use by this instance.
|
virtual |
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
|
inline |
Accessor to get parent Entity.
Definition at line 150 of file OgreSubEntity.h.
|
inlinevirtualinherited |
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.
|
virtual |
Overridden - see Renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
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.
|
virtual |
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 177 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 202 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 330 of file OgreRenderable.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 336 of file OgreRenderable.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 342 of file OgreRenderable.h.
VertexData* Ogre::SubEntity::getVertexDataForBinding | ( | void | ) |
Retrieve the VertexData which should be used for GPU binding.
|
virtual |
Overridden - see Renderable.
Implements Ogre::Renderable.
|
virtual |
Returns whether or not this SubEntity is supposed to be visible.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 127 of file OgreRenderable.h.
|
protected |
Internal method for preparing this Entity for use in animation.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Definition at line 122 of file OgreRenderable.h.
|
inlineinherited |
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 |
||
) |
|
inlinevirtualinherited |
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.
|
inlinevirtualinherited |
gets render system private data
Definition at line 388 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 163 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 188 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 325 of file OgreRenderable.h.
|
virtual |
Tells this SubEntity whether to be visible or not.
|
friend |
Definition at line 65 of file OgreSubEntity.h.
|
friend |
Definition at line 66 of file OgreSubEntity.h.
|
mutableprotected |
The camera for which the cached distance is valid.
Definition at line 113 of file OgreSubEntity.h.
|
mutableprotected |
Cached distance to last camera for getSquaredViewDepth.
Definition at line 111 of file OgreSubEntity.h.
|
protectedinherited |
Definition at line 396 of file OgreRenderable.h.
|
protected |
Number of hardware blended poses supported by material.
Definition at line 109 of file OgreSubEntity.h.
|
protected |
Vertex data details for hardware Vertex anim of shared geometry.
Definition at line 105 of file OgreSubEntity.h.
|
protected |
The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.
Definition at line 92 of file OgreSubEntity.h.
|
protected |
Name of Material in use by this SubEntity.
Definition at line 80 of file OgreSubEntity.h.
|
protected |
Pointer to parent.
Definition at line 77 of file OgreSubEntity.h.
|
protected |
Cached pointer to material.
Definition at line 83 of file OgreSubEntity.h.
|
protectedinherited |
Definition at line 397 of file OgreRenderable.h.
|
mutableprotectedinherited |
Definition at line 401 of file OgreRenderable.h.
|
protected |
blend buffer details for dedicated geometry
Definition at line 95 of file OgreSubEntity.h.
|
protected |
Vertex data details for software Vertex anim of shared geometry.
Definition at line 101 of file OgreSubEntity.h.
|
protected |
Definition at line 86 of file OgreSubEntity.h.
|
protected |
Quick lookup of buffers.
Definition at line 97 of file OgreSubEntity.h.
|
protected |
Temp buffer details for software Vertex anim geometry.
Definition at line 99 of file OgreSubEntity.h.
|
protectedinherited |
Definition at line 398 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 399 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 400 of file OgreRenderable.h.
|
protected |
Have we applied any vertex animation to geometry?
Definition at line 107 of file OgreSubEntity.h.
|
protected |
Is this SubEntity visible?
Definition at line 89 of file OgreSubEntity.h.