# Ogre::SubEntity Class Reference

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

`#include <OgreSubEntity.h>`

Inheritance diagram for Ogre::SubEntity:

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.
void | setRenderDetail (SceneDetailLevel renderDetail)
| Sets the rendering level (solid, wireframe) of this SubEntity.
SceneDetailLevel | getRenderDetail () const
| Overridden, see Renderable.
const LightList & | getLights (void) const

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

const VertexData * | getBlendedVertexData (void)
| Get the temporary blended vertex data for this subentity.
bool | getCastsShadows (void) const

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

const VertexData * | _getBlendedVertexData (void) const
| Advanced method to get the temporarily blended vertex information for entities which are software skinned.
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 | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
virtual void | setRenderDetailOverrideable (bool override)
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool | getRenderDetailOverrideable (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?
SceneDetailLevel | mRenderDetail
unsigned short | mMaterialLodIndex
| The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.
VertexData * | mBlendedVertexData
| blend buffer details for dedicated geometry
TempBlendedBufferInfo | mTempBlendedBuffer
| Quick lookup of buffers.
CustomParameterMap | mCustomParameters
bool | mRenderDetailOverrideable

## 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 251 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

const VertexData* Ogre::SubEntity::_getBlendedVertexData | ( | void |  | ) | const

| Advanced method to get the temporarily blended vertex information for entities which are software skinned.

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

References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, and params.

const VertexData* Ogre::SubEntity::getBlendedVertexData | ( | void |  | ) |

| Get the temporary blended vertex data for this subentity. Definition at line 149 of file OgreSubEntity.h.

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 146 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 180 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.

SceneDetailLevel Ogre::SubEntity::getRenderDetail | ( |  | ) | const`[virtual]`

| Overridden, see Renderable. Reimplemented from Ogre::Renderable. Definition at line 145 of file OgreSubEntity.h. References Ogre::SceneDetailLevel.

virtual bool Ogre::Renderable::getRenderDetailOverrideable | ( | 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 243 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.

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

void Ogre::SubEntity::setRenderDetail | ( | SceneDetailLevel | renderDetail | ) |

| Sets the rendering level (solid, wireframe) of this SubEntity. Definition at line 143 of file OgreSubEntity.h.

virtual void Ogre::Renderable::setRenderDetailOverrideable | ( | 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 235 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

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

| blend buffer details for dedicated geometry Definition at line 86 of file OgreSubEntity.h.

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

| Definition at line 252 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.

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.

SceneDetailLevel Ogre::SubEntity::mRenderDetail `[protected]`

| Definition at line 81 of file OgreSubEntity.h.

bool Ogre::Renderable::mRenderDetailOverrideable `[protected, inherited]`

| Definition at line 253 of file OgreRenderable.h.

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

| Definition at line 250 of file OgreRenderable.h.

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

| Definition at line 76 of file OgreSubEntity.h.

TempBlendedBufferInfo Ogre::SubEntity::mTempBlendedBuffer `[protected]`

| Quick lookup of buffers. Definition at line 88 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:

- OgreSubEntity.h

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