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 Member Functions

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.
void setMaterial (const MaterialPtr &material)
 Sets a 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.
EntitygetParent (void) const
 Accessor to get parent Entity.
const MaterialPtrgetMaterial (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.
unsigned short getNumWorldTransforms (void) const
 Overridden - see Renderable.
Real getSquaredViewDepth (const Camera *cam) const
 Overridden, see Renderable.
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable.

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

bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow.

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.
VertexDatagetVertexDataForBinding (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 Renderable to provide some custom behaviour.
void _invalidateCameraCache ()
 Invalidate the camera distance cache.
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered.
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered.
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection.
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view.
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view.
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 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.
virtual void setUserAny (const Any &anything)
 Sets any kind of user value on this object.
virtual const AnygetUserAny (void) const
 Retrieves the custom user value associated with this object.
virtual RenderSystemDatagetRenderSystemData () const
 Sets render system private data.
virtual void setRenderSystemData (RenderSystemData *val) const
 gets render system private data
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
void * operator new (size_t sz)
void * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr, const char *, int, const char *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr, const char *, int, const char *)

Protected Types

typedef std::map< size_t, Vector4CustomParameterMap

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

EntitymParentEntity
 Pointer to parent.
String mMaterialName
 Name of Material in use by this SubEntity.
MaterialPtr mpMaterial
 Cached pointer to material.
SubMeshmSubMesh
bool mVisible
 Is this SubEntity visible?
unsigned short mMaterialLodIndex
 The LOD number of the material to use, calculated by Entity::_notifyCurrentCamera.
VertexDatamSkelAnimVertexData
 blend buffer details for dedicated geometry
TempBlendedBufferInfo mTempSkelAnimInfo
 Quick lookup of buffers.
TempBlendedBufferInfo mTempVertexAnimInfo
 Temp buffer details for software Vertex anim geometry.
VertexDatamSoftwareVertexAnimVertexData
 Vertex data details for software Vertex anim of shared geometry.
VertexDatamHardwareVertexAnimVertexData
 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.
Real mCachedCameraDist
 Cached distance to last camera for getSquaredViewDepth.
const CameramCachedCamera
 The camera for which the cached distance is valid.
CustomParameterMap mCustomParameters
bool mPolygonModeOverrideable
bool mUseIdentityProjection
bool mUseIdentityView
Any mUserAny
RenderSystemDatamRenderSystemData

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 56 of file OgreSubEntity.h.


Member Typedef Documentation

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

Definition at line 371 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

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

Internal method for preparing this Entity for use in animation.

const String& Ogre::SubEntity::getMaterialName (  )  const

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

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::setMaterial ( const MaterialPtr material  ) 

Sets a 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::SubEntity::setVisible ( bool  visible  )  [virtual]

Tells this SubEntity whether to be visible or not.

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

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

SubMesh* Ogre::SubEntity::getSubMesh ( void   ) 

Accessor method to read mesh data.

Entity* Ogre::SubEntity::getParent ( void   )  const

Accessor to get parent Entity.

Definition at line 144 of file OgreSubEntity.h.

const MaterialPtr& Ogre::SubEntity::getMaterial ( void   )  const [virtual]

Overridden - see Renderable.

Implements Ogre::Renderable.

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

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

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

Overridden - see Renderable.

Implements Ogre::Renderable.

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

Overridden - see Renderable.

Implements Ogre::Renderable.

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

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

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

Overridden, see Renderable.

Implements Ogre::Renderable.

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

Gets a list of lights, ordered relative to how close they are to this renderable.

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

Implements Ogre::Renderable.

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

Method which reports whether this renderable would normally cast a shadow.

Remarks:
Subclasses should override this if they could have been used to generate 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.

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.

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.

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.

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

Are buffers already marked as vertex animated?

Definition at line 212 of file OgreSubEntity.h.

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

Reimplemented from Ogre::Renderable.

void Ogre::SubEntity::_invalidateCameraCache (  ) 

Invalidate the camera distance cache.

Definition at line 224 of file OgreSubEntity.h.

virtual bool Ogre::Renderable::preRender ( SceneManager sm,
RenderSystem rsys 
) [virtual, inherited]

Called just prior to the Renderable being rendered.

Remarks:
OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.
This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.
Returns:
true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Definition at line 116 of file OgreRenderable.h.

virtual void Ogre::Renderable::postRender ( SceneManager sm,
RenderSystem rsys 
) [virtual, inherited]

Called immediately after the Renderable has been rendered.

Definition at line 119 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityProjection ( bool  useIdentityProjection  )  [inherited]

Sets 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 change this. The default is false.
See also:
Renderable::getUseIdentityProjection

Definition at line 154 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityProjection ( void   )  const [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 change this.
See also:
Renderable::setUseIdentityProjection

Definition at line 168 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityView ( bool  useIdentityView  )  [inherited]

Sets whether or not to use an 'identity' view.

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 change this. The default is false.
See also:
Renderable::getUseIdentityView

Definition at line 179 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView ( void   )  const [inherited]

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

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 change this.
See also:
Renderable::setUseIdentityView

Definition at line 193 of file OgreRenderable.h.

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

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

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

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

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

virtual void Ogre::Renderable::setUserAny ( const Any anything  )  [virtual, inherited]

Sets any kind of user value on this object.

Remarks:
This method allows you to associate any user value you like with this Renderable. This can be a pointer back to one of your own classes for instance.

Definition at line 315 of file OgreRenderable.h.

virtual const Any& Ogre::Renderable::getUserAny ( void   )  const [virtual, inherited]

Retrieves the custom user value associated with this object.

Definition at line 319 of file OgreRenderable.h.

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData (  )  const [virtual, inherited]

Sets render system private data.

Remarks:
This should only be used by a render system

Definition at line 356 of file OgreRenderable.h.

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val  )  const [virtual, inherited]

gets render system private data

Remarks:
This should only be used by a render system

Definition at line 364 of file OgreRenderable.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
) [inherited]

operator new, with debug line info

Definition at line 62 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz  )  [inherited]

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
) [inherited]

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
) [inherited]

array operator new, with debug line info

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz  )  [inherited]

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr  )  [inherited]

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
) [inherited]

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr  )  [inherited]

Definition at line 106 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.


Friends And Related Function Documentation

friend class Entity [friend]

Definition at line 59 of file OgreSubEntity.h.

friend class SceneManager [friend]

Definition at line 60 of file OgreSubEntity.h.


Member Data Documentation

Pointer to parent.

Definition at line 71 of file OgreSubEntity.h.

Name of Material in use by this SubEntity.

Definition at line 74 of file OgreSubEntity.h.

Cached pointer to material.

Definition at line 77 of file OgreSubEntity.h.

Definition at line 80 of file OgreSubEntity.h.

bool Ogre::SubEntity::mVisible [protected]

Is this SubEntity visible?

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

blend buffer details for dedicated geometry

Definition at line 89 of file OgreSubEntity.h.

Quick lookup of buffers.

Definition at line 91 of file OgreSubEntity.h.

Temp buffer details for software Vertex anim geometry.

Definition at line 93 of file OgreSubEntity.h.

Vertex data details for software Vertex anim of shared geometry.

Definition at line 95 of file OgreSubEntity.h.

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 99 of file OgreSubEntity.h.

Have we applied any vertex animation to geometry?

Definition at line 101 of file OgreSubEntity.h.

Number of hardware blended poses supported by material.

Definition at line 103 of file OgreSubEntity.h.

Cached distance to last camera for getSquaredViewDepth.

Definition at line 105 of file OgreSubEntity.h.

const Camera* Ogre::SubEntity::mCachedCamera [mutable, protected]

The camera for which the cached distance is valid.

Definition at line 107 of file OgreSubEntity.h.

Definition at line 372 of file OgreRenderable.h.

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

Definition at line 373 of file OgreRenderable.h.

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

Definition at line 374 of file OgreRenderable.h.

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

Definition at line 375 of file OgreRenderable.h.

Any Ogre::Renderable::mUserAny [protected, inherited]

Definition at line 376 of file OgreRenderable.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData [mutable, protected, inherited]

Definition at line 377 of file OgreRenderable.h.


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

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:07:42 2009