Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class 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:

Ogre::Renderable List of all members.

Public Member Functions

const String & getMaterialName () 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.

SubMesh * getSubMesh (void)
 Accessor method to read mesh data.

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.

const Quaternion & getWorldOrientation (void) const
 

const Vector3 & getWorldPosition (void) const
 

bool getNormaliseNormals (void) 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
 
Remarks:
Directional lights, which have no position, will always be first on this list.


bool getCastsShadows (void) const
 
Remarks:
Subclasses should override this if they could have been used to generate a shadow.


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 Renderble to provide some custom behaviour.

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 PlaneList & getClipPlanes () 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 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.


Protected Types

typedef std::map< size_t,
Vector4 > 		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 - separate since we need to s/w anim for shadows whilst still altering the vertex data for hardware morphing (pos2 binding).

bool mVertexAnimationAppliedThisFrame
 Have we applied any vertex animation to geometry?

ushort mHardwarePoseCount
 Number of hardware blended poses supported by material.

CustomParameterMap mCustomParameters
bool mPolygonModeOverrideable

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 247 of file OgreRenderable.h.

Constructor & Destructor Documentation

Ogre::SubEntity::SubEntity (  Entity *  parent,
SubMesh *  subMeshBasis
)  [protected]
 

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

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

Private destructor.

Member Function Documentation

bool Ogre::SubEntity::_getBuffersMarkedForAnimation (  void   )  const
 

Are buffers already marked as vertex animated?

Definition at line 200 of file OgreSubEntity.h.

VertexData* Ogre::SubEntity::_getHardwareVertexAnimVertexData (  void   ) 
 

Advanced method to get the hardware morph vertex information.

Note:
The positions/normals of the returned vertex data is in object space.

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.

Remarks:
Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via Entity::addSoftwareAnimationRequest.
Note:
The positions/normals of the returned vertex data is in object space.

VertexData* Ogre::SubEntity::_getSoftwareVertexAnimVertexData (  void   ) 
 

Advanced method to get the temporarily blended software morph vertex information.

Remarks:
Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via Entity::addSoftwareAnimationRequest.
Note:
The positions/normals of the returned vertex data is in object space.

TempBlendedBufferInfo* Ogre::SubEntity::_getVertexAnimTempBufferInfo (  void   ) 
 

Advanced method to get the temp buffer information for software morph animation.

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 Renderble to provide some custom behaviour.

Reimplemented from Ogre::Renderable.

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

Remarks:
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented from Ogre::Renderable.

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

Definition at line 142 of file OgreRenderable.h.

References Ogre::PlaneList.

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 176 of file OgreRenderable.h.

References OGRE_EXCEPT.

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

Remarks:
Directional lights, which have no position, will always be first on this list.

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.

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

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

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

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

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 239 of file OgreRenderable.h.

void Ogre::SubEntity::getRenderOperation (  RenderOperation &  op  )  [virtual]
 

Overridden - see Renderable.

Implements Ogre::Renderable.

Real Ogre::SubEntity::getSquaredViewDepth (  const Camera *  cam  )  const [virtual]
 

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.

VertexData* Ogre::SubEntity::getVertexDataForBinding (  void   ) 
 

Retrieve the VertexData which should be used for GPU binding.

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

Implements Ogre::Renderable.

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

Implements Ogre::Renderable.

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::SubEntity::prepareTempBlendBuffers (  void   )  [protected]
 

Internal method for preparing this Entity for use in animation.

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 167 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.

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.

Parameters:
override true means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 231 of file OgreRenderable.h.

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

Tells this SubEntity whether to be visible or not.

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::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.

Definition at line 114 of file OgreRenderable.h.

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::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.

Definition at line 124 of file OgreRenderable.h.

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

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

Definition at line 248 of file OgreRenderable.h.

ushort Ogre::SubEntity::mHardwarePoseCount [protected]
 

Number of hardware blended poses supported by material.

Definition at line 99 of file OgreSubEntity.h.

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

Vertex data details for hardware Vertex anim of shared geometry - separate since we need to s/w anim for shadows whilst still altering the vertex data for hardware morphing (pos2 binding).

Definition at line 95 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 82 of file OgreSubEntity.h.

String Ogre::SubEntity::mMaterialName [protected]
 

Name of Material in use by this SubEntity.

Definition at line 70 of file OgreSubEntity.h.

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

Pointer to parent.

Definition at line 67 of file OgreSubEntity.h.

MaterialPtr Ogre::SubEntity::mpMaterial [protected]
 

Cached pointer to material.

Definition at line 73 of file OgreSubEntity.h.

bool Ogre::Renderable::mPolygonModeOverrideable [protected, inherited]
 

Definition at line 249 of file OgreRenderable.h.

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

Definition at line 246 of file OgreRenderable.h.

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

blend buffer details for dedicated geometry

Definition at line 85 of file OgreSubEntity.h.

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

Vertex data details for software Vertex anim of shared geometry.

Definition at line 91 of file OgreSubEntity.h.

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

Definition at line 76 of file OgreSubEntity.h.

TempBlendedBufferInfo Ogre::SubEntity::mTempSkelAnimInfo [protected]
 

Quick lookup of buffers.

Definition at line 87 of file OgreSubEntity.h.

TempBlendedBufferInfo Ogre::SubEntity::mTempVertexAnimInfo [protected]
 

Temp buffer details for software Vertex anim geometry.

Definition at line 89 of file OgreSubEntity.h.

bool Ogre::SubEntity::mVertexAnimationAppliedThisFrame [protected]
 

Have we applied any vertex animation to geometry?

Definition at line 97 of file OgreSubEntity.h.

bool Ogre::SubEntity::mVisible [protected]
 

Is this SubEntity visible?

Definition at line 79 of file OgreSubEntity.h.

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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:45:03 2006