|  | OGRE
    1.11.6
    Object-Oriented Graphics Rendering Engine | 
Utility class which defines the sub-parts of an Entity. More...
#include <OgreSubEntity.h>
 Inheritance diagram for Ogre::SubEntity:
 Inheritance diagram for Ogre::SubEntity:| Public Types | |
| typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr | 
| 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... | |
| size_t | getIndexDataEndIndex () const | 
| Returns the current value of the start index used for drawing.  More... | |
| size_t | getIndexDataStartIndex () const | 
| Returns the current value of the start index used for drawing.  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... | |
| 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... | |
| uint8 | getRenderQueueGroup (void) const | 
| Gets the queue group for this entity, see setRenderQueueGroup for full details.  More... | |
| ushort | getRenderQueuePriority (void) const | 
| Gets the queue group for this entity, see setRenderQueueGroup for full details.  More... | |
| const RenderSystemDataPtr & | getRenderSystemData () const | 
| Gets RenderSystem 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... | |
| 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... | |
| bool | hasCustomParameter (size_t index) const | 
| Checks whether a custom value is associated with this Renderable at the given index.  More... | |
| bool | isRenderQueueGroupSet (void) const | 
| Gets the queue group for this entity, see setRenderQueueGroup for full details.  More... | |
| bool | isRenderQueuePrioritySet (void) const | 
| Gets the queue group for this entity, see setRenderQueueGroup for full details.  More... | |
| bool | isVisible (void) const | 
| Returns whether or not this SubEntity is supposed to be visible.  More... | |
| 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 | removeCustomParameter (size_t index) | 
| Removes a custom value which is associated with this Renderable at the given index.  More... | |
| void | resetIndexDataStartEndIndex () | 
| Reset the custom start/end index to the default values.  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 | setIndexDataEndIndex (size_t end_index) | 
| Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents.  More... | |
| void | setIndexDataStartIndex (size_t start_index) | 
| Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents.  More... | |
| void | setMaterial (const MaterialPtr &material) | 
| Sets the name of the 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... | |
| void | setPolygonModeOverrideable (bool override) | 
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.  More... | |
| void | setRenderQueueGroup (uint8 queueID) | 
| Sets the render queue group this SubEntity will be rendered through.  More... | |
| void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) | 
| Sets the render queue group and group priority this SubEntity will be rendered through.  More... | |
| void | setRenderSystemData (RenderSystemDataPtr val) const | 
| Sets RenderSystem 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... | |
| void | setUserAny (const Any &anything) | 
| void | setVisible (bool visible) | 
| Tells this SubEntity whether to be visible or not.  More... | |
| Friends | |
| class | Entity | 
| class | SceneManager | 
Utility class which defines the sub-parts of an Entity.
| 
 | inherited | 
| const String& Ogre::SubEntity::getMaterialName | ( | ) | const | 
Gets the name of the Material in use by this instance.
| void Ogre::SubEntity::setMaterialName | ( | const String & | name, | 
| const String & | groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME | ||
| ) | 
| void Ogre::SubEntity::setMaterial | ( | const MaterialPtr & | material | ) | 
| void Ogre::SubEntity::setVisible | ( | bool | visible | ) | 
Tells this SubEntity whether to be visible or not.
| bool Ogre::SubEntity::isVisible | ( | void | ) | const | 
Returns whether or not this SubEntity is supposed to be visible.
| void Ogre::SubEntity::setRenderQueueGroup | ( | uint8 | queueID | ) | 
Sets the render queue group this SubEntity will be rendered through.
| queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. | 
Sets the render queue group and group priority this SubEntity will be rendered through.
| queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. | 
| priority | The priority within a group to use. | 
| uint8 Ogre::SubEntity::getRenderQueueGroup | ( | void | ) | const | 
Gets the queue group for this entity, see setRenderQueueGroup for full details.
| ushort Ogre::SubEntity::getRenderQueuePriority | ( | void | ) | const | 
Gets the queue group for this entity, see setRenderQueueGroup for full details.
| bool Ogre::SubEntity::isRenderQueueGroupSet | ( | void | ) | const | 
Gets the queue group for this entity, see setRenderQueueGroup for full details.
| bool Ogre::SubEntity::isRenderQueuePrioritySet | ( | void | ) | const | 
Gets the queue group for this entity, see setRenderQueueGroup for full details.
| SubMesh* Ogre::SubEntity::getSubMesh | ( | void | ) | 
Accessor method to read mesh data.
| 
 | virtual | 
Overridden - see Renderable.
Implements Ogre::Renderable.
| 
 | virtual | 
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
| 
 | virtual | 
Overridden - see Renderable.
Implements Ogre::Renderable.
| void Ogre::SubEntity::setIndexDataStartIndex | ( | size_t | start_index | ) | 
Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents.
Default value is zero so that the entire index buffer is used when drawing. Valid values are zero to getIndexDataEndIndex()
| size_t Ogre::SubEntity::getIndexDataStartIndex | ( | ) | const | 
Returns the current value of the start index used for drawing.
| void Ogre::SubEntity::setIndexDataEndIndex | ( | size_t | end_index | ) | 
| size_t Ogre::SubEntity::getIndexDataEndIndex | ( | ) | const | 
Returns the current value of the start index used for drawing.
| void Ogre::SubEntity::resetIndexDataStartEndIndex | ( | ) | 
Reset the custom start/end index to the default values.
| 
 | virtual | 
Overridden - see Renderable.
Implements Ogre::Renderable.
| 
 | virtual | 
Overridden - see Renderable.
Reimplemented from Ogre::Renderable.
Overridden, see Renderable.
Implements Ogre::Renderable.
| 
 | virtual | 
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
| 
 | virtual | 
Method which reports whether this renderable would normally cast a shadow.
Reimplemented from Ogre::Renderable.
| 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.
| 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.
| TempBlendedBufferInfo* Ogre::SubEntity::_getVertexAnimTempBufferInfo | ( | void | ) | 
Advanced method to get the temp buffer information for software morph animation.
| VertexData* Ogre::SubEntity::getVertexDataForBinding | ( | void | ) | 
Retrieve the VertexData which should be used for GPU binding.
| void Ogre::SubEntity::_markBuffersUnusedForAnimation | ( | void | ) | 
Mark all vertex data as so far unanimated.
| void Ogre::SubEntity::_markBuffersUsedForAnimation | ( | void | ) | 
Mark all vertex data as animated.
| 
 | inline | 
Are buffers already marked as vertex 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.
| 
 | inline | 
Invalidate the camera distance cache.
| 
 | inlinevirtualinherited | 
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
| 
 | inlinevirtualinherited | 
Called immediately after the Renderable has been rendered.
| 
 | inlineinherited | 
Sets whether or not to use an 'identity' projection.
| 
 | inlineinherited | 
Returns whether or not to use an 'identity' projection.
| 
 | inlineinherited | 
Sets whether or not to use an 'identity' view.
| 
 | inlineinherited | 
Returns whether or not to use an 'identity' view.
| 
 | 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. | 
| 
 | inlineinherited | 
Removes a custom value which is associated with this Renderable at the given index.
| index | Index of the parameter to remove. | 
| 
 | inlineinherited | 
Checks whether a custom value is associated with this Renderable at the given index.
| index | Index of the parameter to check for existence. | 
| 
 | inlineinherited | 
Gets the custom value associated with this Renderable at the given index.
| index | Index of the parameter to retrieve. | 
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
| 
 | inlineinherited | 
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. | 
| 
 | inlineinherited | 
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().
| 
 | inlineinherited | 
Sets any kind of user value on this object.
Referenced by Ogre::InstanceBatch::getRenderOperation().
| 
 | inlineinherited | 
Retrieves the custom user value associated with this object.
Referenced by Ogre::InstanceBatch::getRenderOperation().
| 
 | 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.
| 
 | 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.
| 
 | inlineinherited | 
Gets RenderSystem private data.
| 
 | inlineinherited | 
Sets RenderSystem private data.
| 
 | friend | 
| 
 | friend |