![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
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? | |
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. | |
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. | |
TempBlendedBufferInfo * | _getVertexAnimTempBufferInfo (void) |
Advanced method to get the temp buffer information for software morph animation. | |
void | _invalidateCameraCache () |
Invalidate the camera distance cache. | |
void | _markBuffersUnusedForAnimation (void) |
Mark all vertex data as so far unanimated. | |
void | _markBuffersUsedForAnimation (void) |
Mark all vertex data as 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 override |
Overridden from Renderable to provide some custom behaviour. | |
bool | getCastsShadows (void) const override |
Method which reports whether this renderable would normally cast a shadow. | |
size_t | getIndexDataEndIndex () const |
Returns the current value of the start index used for drawing. | |
size_t | getIndexDataStartIndex () const |
Returns the current value of the start index used for drawing. | |
const LightList & | getLights (void) const override |
Gets a list of lights, ordered relative to how close they are to this renderable. | |
const MaterialPtr & | getMaterial (void) const override |
Retrieves a weak reference to the material this renderable object uses. | |
const String & | getMaterialName () const |
Gets the name of the Material in use by this instance. | |
unsigned short | getNumWorldTransforms (void) const override |
Returns the number of world transform matrices this renderable requires. | |
Entity * | getParent (void) const |
Accessor to get parent Entity. | |
void | getRenderOperation (RenderOperation &op) override |
Gets the render operation required to send this object to the frame buffer. | |
uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. | |
ushort | getRenderQueuePriority (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. | |
Real | getSquaredViewDepth (const Camera *cam) const override |
Returns the camera-relative squared depth of this renderable. | |
SubMesh * | getSubMesh (void) |
Accessor method to read mesh data. | |
Technique * | getTechnique (void) const override |
Retrieves a pointer to the Material Technique this renderable object uses. | |
VertexData * | getVertexDataForBinding (void) |
Retrieve the VertexData which should be used for GPU binding. | |
void | getWorldTransforms (Matrix4 *xform) const override |
Gets the world transform matrix / matrices for this renderable object. | |
bool | isRenderQueueGroupSet (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. | |
bool | isRenderQueuePrioritySet (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. | |
bool | isVisible (void) const |
Returns whether or not this SubEntity is supposed to be visible. | |
void | resetIndexDataStartEndIndex () |
Reset the custom start/end index to the default values. | |
void | setIndexDataEndIndex (size_t end_index) |
Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents. | |
void | setIndexDataStartIndex (size_t start_index) |
Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents. | |
void | setMaterial (const MaterialPtr &material) |
Sets the name of the Material to be used. | |
void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Sets the name of the Material to be used. | |
void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this SubEntity will be rendered through. | |
void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this SubEntity will be rendered through. | |
void | setVisible (bool visible) |
Tells this SubEntity whether to be visible or not. | |
![]() | |
Renderable () | |
virtual | ~Renderable () |
Virtual destructor needed as class has virtual methods. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
const RenderSystemDataPtr & | getRenderSystemData () const |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
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. | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. | |
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. | |
void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
void | setRenderSystemData (RenderSystemDataPtr val) const |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
void | setUserAny (const Any &anything) |
Additional Inherited Members | |
![]() | |
enum | { DEFAULT_PRIORITY = 100 } |
typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr |
Utility class which defines the sub-parts of an Entity.
Gets the name of the Material in use by this instance.
void Ogre::SubEntity::setMaterial | ( | const MaterialPtr & | material | ) |
Returns whether or not this SubEntity is supposed to be visible.
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. |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
Gets the queue group for this entity, see setRenderQueueGroup for full details.
Gets the queue group for this entity, see setRenderQueueGroup for full details.
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlineoverridevirtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
|
overridevirtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
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.
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.
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
Returns the number of world transform matrices this renderable requires.
Reimplemented from Ogre::Renderable.
Returns the camera-relative squared depth of this renderable.
Implements Ogre::Renderable.
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
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.
Mark all vertex data as so far unanimated.
Are buffers already marked as vertex animated?
Internal method to copy original vertex data to the morph structures should there be no active animation in use.
|
overridevirtual |
Overridden from Renderable to provide some custom behaviour.
Reimplemented from Ogre::Renderable.
|
inline |
Invalidate the camera distance cache.