Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::SubEntity Class Reference

Utility class which defines the sub-parts of an Entity. More...

#include <OgreSubEntity.h>

Inheritance diagram for Ogre::SubEntity:

Inheritance graph
[legend]
List of all members.

Public Methods

const StringgetMaterialName () const
 Gets the name of the Material in use by this instance.

void setMaterialName (const String &name)
 Sets the name of the 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.

SubMeshgetSubMesh (void)
 Accessor method to read mesh data.

MaterialgetMaterial (void) const
 Overridden - see Renderable.

TechniquegetTechnique (void) const
 Overridden - see Renderable.

void getRenderOperation (RenderOperation &op)
 Overridden - see Renderable.

void getWorldTransforms (Matrix4 *xform) const
 Overridden - see Renderable.

const QuaterniongetWorldOrientation (void) const
 @copydoc Renderable::getWorldOrientation

const Vector3getWorldPosition (void) const
 @copydoc Renderable::getWorldPosition

bool getNormaliseNormals (void) const
 Overridden - see Renderable.

unsigned short getNumWorldTransforms (void) const
 Overridden - see Renderable.

Real getSquaredViewDepth (const Camera *cam) const
 Overridden, see Renderable.

void setRenderDetail (SceneDetailLevel renderDetail)
 Sets the rendering level (solid, wireframe) of this SubEntity.

SceneDetailLevel getRenderDetail () const
 Overridden, see Renderable.

const LightListgetLights (void) const
 @copydoc Renderable::getLights

const VertexDatagetBlendedVertexData (void)
 Get the temporary blended vertex data for this subentity.

bool getCastsShadows (void) const
 @copydoc Renderable::getCastsShadows

virtual bool useIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.

virtual bool useIdentityView (void) const
 Returns whether or not to use an 'identity' projection.

virtual const PlaneListgetClipPlanes () const
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 Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index.

virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.


Protected Types

typedef std::map< size_t,
Vector4
CustomParameterMap

Protected Methods

 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

EntitymParentEntity
 Pointer to parent.

String mMaterialName
 Name of Material in use by this SubEntity.

MaterialmpMaterial
 Cached pointer to material.

SubMeshmSubMesh
bool mVisible
 Is this SubEntity visible?

SceneDetailLevel mRenderDetail
unsigned short mMaterialLodIndex
 The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.

VertexDatamBlendedVertexData
 blend buffer details for dedicated geometry

TempBlendedBufferInfo mTempBlendedBuffer
 Quick lookup of buffers.

CustomParameterMap mCustomParameters

Static Protected Attributes

const PlaneList msDummyPlaneList

Friends

class Entity
class SceneManager

Detailed Description

Utility class which defines the sub-parts of an Entity.

Remarks:
Just as meshes are split into submeshes, an Entity is made up of potentially multiple SubMeshes. These are mainly here to provide the link between the Material which the SubEntity uses (which may be the default Material for the SubMesh or may have been changed for this object) and the SubMesh data.

The SubEntity also allows the application some flexibility in the material properties for this section of a particular instance of this Mesh, e.g. tinting the windows on a car model.

SubEntity instances are never created manually. They are created at the same time as their parent Entity by the SceneManager method createEntity.

Definition at line 52 of file OgreSubEntity.h.


Member Typedef Documentation

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited]
 

Definition at line 232 of file OgreRenderable.h.


Constructor & Destructor Documentation

Ogre::SubEntity::SubEntity Entity   parent,
SubMesh   subMeshBasis
[protected]
 

Private constructor - don't allow creation by anybody else.

Definition at line 39 of file OgreSubEntity.cpp.

References mBlendedVertexData, mMaterialLodIndex, mpMaterial, mRenderDetail, mVisible, and Ogre::SDL_SOLID.

Ogre::SubEntity::~SubEntity   [protected, virtual]
 

Private destructor.

Definition at line 53 of file OgreSubEntity.cpp.

References mBlendedVertexData.


Member Function Documentation

virtual void Ogre::Renderable::_updateCustomGpuParameter const GpuProgramParameters::AutoConstantEntry   constantEntry,
GpuProgramParameters   params
const [virtual, inherited]
 

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks:
This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters:
constantEntry  The auto constant entry referring to the parameter being updated
params  The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::TerrainRenderable.

Definition at line 218 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, params, and Ogre::GpuProgramParameters::setConstant().

Referenced by Ogre::GpuProgramParameters::_updateAutoParamsNoLights().

const VertexData* Ogre::SubEntity::getBlendedVertexData void   
 

Get the temporary blended vertex data for this subentity.

Definition at line 149 of file OgreSubEntity.h.

Referenced by Ogre::Entity::findBlendedVertexData().

bool Ogre::SubEntity::getCastsShadows void    const [virtual]
 

@copydoc Renderable::getCastsShadows

Reimplemented from Ogre::Renderable.

Definition at line 221 of file OgreSubEntity.cpp.

References Ogre::MovableObject::getCastShadows(), and mParentEntity.

virtual const PlaneList& Ogre::Renderable::getClipPlanes   const [virtual, inherited]
 

Definition at line 145 of file OgreRenderable.h.

References Ogre::PlaneList.

Referenced by Ogre::SceneManager::renderSingleObject().

const Vector4& Ogre::Renderable::getCustomParameter size_t    index const [inherited]
 

Gets the custom value associated with this Renderable at the given index.

Parameters:
see  setCustomParaemter for full details.

Definition at line 179 of file OgreRenderable.h.

References Except.

const LightList & Ogre::SubEntity::getLights void    const [virtual]
 

@copydoc Renderable::getLights

Implements Ogre::Renderable.

Definition at line 190 of file OgreSubEntity.cpp.

References Ogre::SceneNode::findLights(), Ogre::Entity::getBoundingRadius(), Ogre::MovableObject::getParentSceneNode(), Ogre::LightList, and mParentEntity.

Material * Ogre::SubEntity::getMaterial void    const [virtual]
 

Overridden - see Renderable.

Implements Ogre::Renderable.

Definition at line 102 of file OgreSubEntity.cpp.

References mpMaterial.

const String & Ogre::SubEntity::getMaterialName   const
 

Gets the name of the Material in use by this instance.

Definition at line 64 of file OgreSubEntity.cpp.

References mMaterialName, and Ogre::String.

bool Ogre::SubEntity::getNormaliseNormals void    const [virtual]
 

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

Definition at line 185 of file OgreSubEntity.cpp.

References Ogre::Entity::mNormaliseNormals, and mParentEntity.

unsigned short Ogre::SubEntity::getNumWorldTransforms void    const [virtual]
 

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

Definition at line 163 of file OgreSubEntity.cpp.

References Ogre::Entity::isHardwareSkinningEnabled(), Ogre::Entity::mNumBoneMatrices, and mParentEntity.

SceneDetailLevel Ogre::SubEntity::getRenderDetail   const [virtual]
 

Overridden, see Renderable.

Reimplemented from Ogre::Renderable.

Definition at line 145 of file OgreSubEntity.h.

References Ogre::SceneDetailLevel.

void Ogre::SubEntity::getRenderOperation RenderOperation   op [virtual]
 

Overridden - see Renderable.

Implements Ogre::Renderable.

Definition at line 112 of file OgreSubEntity.cpp.

References Ogre::SubMesh::_getRenderOperation(), Ogre::Entity::hasSkeleton(), mBlendedVertexData, Ogre::Entity::mHardwareSkinning, Ogre::Entity::mMeshLodIndex, mParentEntity, Ogre::Entity::mSharedBlendedVertexData, mSubMesh, Ogre::SubMesh::useSharedVertices, and Ogre::RenderOperation::vertexData.

Real Ogre::SubEntity::getSquaredViewDepth const Camera   cam const [virtual]
 

Overridden, see Renderable.

Implements Ogre::Renderable.

Definition at line 178 of file OgreSubEntity.cpp.

References Ogre::MovableObject::getParentNode(), Ogre::Node::getSquaredViewDepth(), mParentEntity, and Ogre::Real.

SubMesh * Ogre::SubEntity::getSubMesh void   
 

Accessor method to read mesh data.

Definition at line 59 of file OgreSubEntity.cpp.

References mSubMesh.

Referenced by Ogre::Entity::findBlendedVertexData(), and Ogre::Entity::findSubEntityForVertexData().

Technique * Ogre::SubEntity::getTechnique void    const [virtual]
 

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

Definition at line 107 of file OgreSubEntity.cpp.

References Ogre::Material::getBestTechnique(), mMaterialLodIndex, and mpMaterial.

const Quaternion & Ogre::SubEntity::getWorldOrientation void    const [virtual]
 

@copydoc Renderable::getWorldOrientation

Implements Ogre::Renderable.

Definition at line 152 of file OgreSubEntity.cpp.

References Ogre::Node::_getDerivedOrientation(), mParentEntity, and Ogre::MovableObject::mParentNode.

const Vector3 & Ogre::SubEntity::getWorldPosition void    const [virtual]
 

@copydoc Renderable::getWorldPosition

Implements Ogre::Renderable.

Definition at line 157 of file OgreSubEntity.cpp.

References Ogre::Node::_getDerivedPosition(), mParentEntity, and Ogre::MovableObject::mParentNode.

void Ogre::SubEntity::getWorldTransforms Matrix4   xform const [virtual]
 

Overridden - see Renderable.

Implements Ogre::Renderable.

Definition at line 125 of file OgreSubEntity.cpp.

References Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::Entity::isHardwareSkinningEnabled(), Ogre::Entity::mBoneMatrices, Ogre::Entity::mNumBoneMatrices, and mParentEntity.

bool Ogre::SubEntity::isVisible void    const [virtual]
 

Returns whether or not this SubEntity is supposed to be visible.

Definition at line 202 of file OgreSubEntity.cpp.

References mVisible.

Referenced by Ogre::Entity::EntityShadowRenderable::isVisible(), and Ogre::Entity::updateAnimation().

void Ogre::SubEntity::prepareTempBlendBuffers void    [protected]
 

Internal method for preparing this Entity for use in animation.

Definition at line 208 of file OgreSubEntity.cpp.

References Ogre::Entity::cloneVertexDataRemoveBlendInfo(), Ogre::Entity::extractTempBufferInfo(), mBlendedVertexData, mParentEntity, mSubMesh, mTempBlendedBuffer, and Ogre::SubMesh::vertexData.

Referenced by Ogre::Entity::prepareTempBlendBuffers().

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.

Remarks:
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.
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 170 of file OgreRenderable.h.

void Ogre::SubEntity::setMaterialName const String   name
 

Sets the name of the Material to be used.

Remarks:
By default a SubEntity uses the default Material that the SubMesh uses. This call can alter that so that the Material is different for this instance.

Definition at line 69 of file OgreSubEntity.cpp.

References Except, Ogre::Entity::getName(), Ogre::Material::load(), mMaterialName, mParentEntity, mpMaterial, Ogre::Entity::reevaluateVertexProcessing(), and Ogre::String.

Referenced by Ogre::Entity::buildSubEntityList(), and Ogre::Entity::clone().

void Ogre::SubEntity::setRenderDetail SceneDetailLevel    renderDetail
 

Sets the rendering level (solid, wireframe) of this SubEntity.

Definition at line 143 of file OgreSubEntity.h.

References Ogre::SceneDetailLevel.

void Ogre::SubEntity::setVisible bool    visible [virtual]
 

Tells this SubEntity whether to be visible or not.

Definition at line 197 of file OgreSubEntity.cpp.

References mVisible.

virtual bool Ogre::Renderable::useIdentityProjection void    const [virtual, inherited]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::GuiElement, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 113 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

virtual bool Ogre::Renderable::useIdentityView void    const [virtual, inherited]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::GuiElement, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 123 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().


Friends And Related Function Documentation

friend class Entity [friend]
 

Definition at line 55 of file OgreSubEntity.h.

friend class SceneManager [friend]
 

Definition at line 56 of file OgreSubEntity.h.


Member Data Documentation

VertexData* Ogre::SubEntity::mBlendedVertexData [protected]
 

blend buffer details for dedicated geometry

Definition at line 86 of file OgreSubEntity.h.

Referenced by getRenderOperation(), prepareTempBlendBuffers(), SubEntity(), Ogre::Entity::updateAnimation(), and ~SubEntity().

CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited]
 

Definition at line 233 of file OgreRenderable.h.

unsigned short Ogre::SubEntity::mMaterialLodIndex [protected]
 

The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.

Definition at line 83 of file OgreSubEntity.h.

Referenced by getTechnique(), and SubEntity().

String Ogre::SubEntity::mMaterialName [protected]
 

Name of Material in use by this SubEntity.

Definition at line 70 of file OgreSubEntity.h.

Referenced by getMaterialName(), and setMaterialName().

Entity* Ogre::SubEntity::mParentEntity [protected]
 

Pointer to parent.

Definition at line 67 of file OgreSubEntity.h.

Referenced by getCastsShadows(), getLights(), getNormaliseNormals(), getNumWorldTransforms(), getRenderOperation(), getSquaredViewDepth(), getWorldOrientation(), getWorldPosition(), getWorldTransforms(), prepareTempBlendBuffers(), and setMaterialName().

Material* Ogre::SubEntity::mpMaterial [protected]
 

Cached pointer to material.

Definition at line 73 of file OgreSubEntity.h.

Referenced by getMaterial(), getTechnique(), setMaterialName(), and SubEntity().

SceneDetailLevel Ogre::SubEntity::mRenderDetail [protected]
 

Definition at line 81 of file OgreSubEntity.h.

Referenced by SubEntity().

const PlaneList Ogre::Renderable::msDummyPlaneList [static, protected, inherited]
 

Definition at line 45 of file OgreRenderSystem.cpp.

SubMesh* Ogre::SubEntity::mSubMesh [protected]
 

Definition at line 76 of file OgreSubEntity.h.

Referenced by getRenderOperation(), getSubMesh(), prepareTempBlendBuffers(), and Ogre::Entity::updateAnimation().

TempBlendedBufferInfo Ogre::SubEntity::mTempBlendedBuffer [protected]
 

Quick lookup of buffers.

Definition at line 88 of file OgreSubEntity.h.

Referenced by prepareTempBlendBuffers(), and Ogre::Entity::updateAnimation().

bool Ogre::SubEntity::mVisible [protected]
 

Is this SubEntity visible?

Definition at line 79 of file OgreSubEntity.h.

Referenced by isVisible(), setVisible(), and SubEntity().


The documentation for this class was generated from the following files:

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:42 2004