Ogre::ManualObject::ManualObjectSection Class Reference

Built, renderable section of geometry. More...

`#include <OgreManualObject.h>`

Inheritance diagram for Ogre::ManualObject::ManualObjectSection:
[legend]

## Public Member Functions

| ManualObjectSection (ManualObject *parent, const String &materialName, RenderOperation::OperationType opType, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
virtual | ~ManualObjectSection ()
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
bool | get32BitIndices () const
| Get whether we need 32-bit indices. More...
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow. More...
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index. More...
const LightList & | getLights (void) const
const MaterialPtr & | getMaterial (void) const
const String & | getMaterialGroup (void) const
| Retrieve the material group in use. More...
const String & | getMaterialName (void) const
| Retrieve the material name in use. More...
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires. More...
virtual bool | getPolygonModeOverrideable (void) const
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
RenderOperation * | getRenderOperation (void)
| Retrieve render operation for manipulation. More...
void | getRenderOperation (RenderOperation &op)
virtual RenderSystemData * | getRenderSystemData () const
| Gets RenderSystem private data. More...
Real | getSquaredViewDepth (const Ogre::Camera *) const
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses. More...
bool | getUseIdentityProjection (void) const
| Returns whether or not to use an 'identity' projection. More...
bool | getUseIdentityView (void) const
| Returns whether or not to use an 'identity' view. More...
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class. More...
const UserObjectBindings & | getUserObjectBindings () const
| Return an instance of user objects binding associated with this class. More...
void | getWorldTransforms (Matrix4 *xform) const
bool | hasCustomParameter (size_t index) const
| Checks whether a custom value is associated with this Renderable at the given index. More...
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 *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
virtual void | postRender (SceneManager *sm, RenderSystem *rsys)
| Called immediately after the Renderable has been rendered. More...
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys)
| Called just prior to the Renderable being rendered. More...
void | removeCustomParameter (size_t index)
| Removes a custom value which is associated with this Renderable at the given index. More...
void | set32BitIndices (bool n32)
| Set whether we need 32-bit indices. More...
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. More...
void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| update the material name in use More...
virtual void | setPolygonModeOverrideable (bool override)
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
virtual void | setRenderSystemData (RenderSystemData *val) const
| Sets RenderSystem private data. More...
void | setUseIdentityProjection (bool useIdentityProjection)
| Sets whether or not to use an 'identity' projection. More...
void | setUseIdentityView (bool useIdentityView)
| Sets whether or not to use an 'identity' view. More...
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything)

## Protected Types

typedef map< size_t, Vector4 >::type | CustomParameterMap

## Protected Attributes

bool | m32BitIndices
CustomParameterMap | mCustomParameters
String | mGroupName
MaterialPtr | mMaterial
String | mMaterialName
ManualObject * | mParent
bool | mPolygonModeOverrideable
RenderOperation | mRenderOperation
RenderSystemData * | mRenderSystemData
| User objects binding. More...
bool | mUseIdentityProjection
bool | mUseIdentityView
UserObjectBindings | mUserObjectBindings

## Detailed Description

Built, renderable section of geometry.

Definition at line 402 of file OgreManualObject.h.

## Member Typedef Documentation

## CustomParameterMap

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap

protected inherited

Definition at line 414 of file OgreRenderable.h.

## Constructor & Destructor Documentation

## ManualObjectSection()

Ogre::ManualObject::ManualObjectSection::ManualObjectSection | ( | ManualObject * | parent,
|  | const String & | materialName,
|  | RenderOperation::OperationType | opType,
|  | const String & | groupName = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
| ) |  |

## ~ManualObjectSection()

virtual Ogre::ManualObject::ManualObjectSection::~ManualObjectSection | ( |  | ) |

virtual

## Member Function Documentation

## _updateCustomGpuParameter()

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::SubEntity.

Definition at line 307 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

## get32BitIndices()

bool Ogre::ManualObject::ManualObjectSection::get32BitIndices | ( |  | ) | const

Get whether we need 32-bit indices.

Definition at line 429 of file OgreManualObject.h.

## getCastsShadows()

virtual bool Ogre::Renderable::getCastsShadows | ( | void |  | ) | const

virtual inherited

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 in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.

Definition at line 224 of file OgreRenderable.h.

## getCustomParameter()

const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const

inherited

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

Parameters

  index | Index of the parameter to retrieve.

See also
  setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

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

## getLights()

const LightList& Ogre::ManualObject::ManualObjectSection::getLights | ( | void |  | ) | const

virtual

Implements Ogre::Renderable.

## getMaterial()

const MaterialPtr& Ogre::ManualObject::ManualObjectSection::getMaterial | ( | void |  | ) | const

virtual

Implements Ogre::Renderable.

## getMaterialGroup()

const String& Ogre::ManualObject::ManualObjectSection::getMaterialGroup | ( | void |  | ) | const

Retrieve the material group in use.

Definition at line 423 of file OgreManualObject.h.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME.

## getMaterialName()

const String& Ogre::ManualObject::ManualObjectSection::getMaterialName | ( | void |  | ) | const

Retrieve the material name in use.

Definition at line 421 of file OgreManualObject.h.

## getNumWorldTransforms()

virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void |  | ) | const

virtual inherited

Returns the number of world transform matrices this renderable requires.

Remarks
  When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

Definition at line 153 of file OgreRenderable.h.

## getPolygonModeOverrideable()

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

Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().

## getRenderOperation() [1/2]

RenderOperation* Ogre::ManualObject::ManualObjectSection::getRenderOperation | ( | void |  | ) |

Retrieve render operation for manipulation.

## getRenderOperation() [2/2]

void Ogre::ManualObject::ManualObjectSection::getRenderOperation | ( | RenderOperation & | op | ) |

virtual

Implements Ogre::Renderable.

## getRenderSystemData()

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData | ( |  | ) | const

virtual inherited

Gets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

## getSquaredViewDepth()

Real Ogre::ManualObject::ManualObjectSection::getSquaredViewDepth | ( | const Ogre::Camera * |  | ) | const

virtual

Implements Ogre::Renderable.

## getTechnique()

virtual Technique* Ogre::Renderable::getTechnique | ( | void |  | ) | const

virtual inherited

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks
  This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 94 of file OgreRenderable.h.

## getUseIdentityProjection()

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

## getUseIdentityView()

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

## getUserAny()

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

Referenced by Ogre::InstanceBatch::getRenderOperation().

## getUserObjectBindings() [1/2]

UserObjectBindings& Ogre::Renderable::getUserObjectBindings | ( |  | ) |

inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
  UserObjectBindings::setUserAny.

Definition at line 355 of file OgreRenderable.h.

## getUserObjectBindings() [2/2]

const UserObjectBindings& Ogre::Renderable::getUserObjectBindings | ( |  | ) | const

inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
  UserObjectBindings::setUserAny.

Definition at line 361 of file OgreRenderable.h.

## getWorldTransforms()

void Ogre::ManualObject::ManualObjectSection::getWorldTransforms | ( | Matrix4 * | xform | ) | const

virtual

Implements Ogre::Renderable.

## hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter | ( | size_t | index | ) | const

inherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters

  index | Index of the parameter to check for existence.

See also
  setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

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 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## postRender()

virtual void Ogre::Renderable::postRender | ( | SceneManager * | sm,
|  | RenderSystem * | rsys
| ) |  |

virtual inherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

## preRender()

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.

Reimplemented in Ogre::BillboardChain.

Definition at line 123 of file OgreRenderable.h.

## removeCustomParameter()

void Ogre::Renderable::removeCustomParameter | ( | size_t | index | ) |

inherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters

  index | Index of the parameter to remove.

See also
  setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

## set32BitIndices()

void Ogre::ManualObject::ManualObjectSection::set32BitIndices | ( | bool | n32 | ) |

Set whether we need 32-bit indices.

Definition at line 427 of file OgreManualObject.h.

## setCustomParameter()

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

## setMaterialName()

void Ogre::ManualObject::ManualObjectSection::setMaterialName | ( | const String & | name,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  |

update the material name in use

## setPolygonModeOverrideable()

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

## setRenderSystemData()

virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const

virtual inherited

Sets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

## setUseIdentityProjection()

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

## setUseIdentityView()

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

## setUserAny()

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) |

virtual inherited

Deprecated:
  use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

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

Referenced by Ogre::InstanceBatch::getRenderOperation().

## Member Data Documentation

## m32BitIndices

bool Ogre::ManualObject::ManualObjectSection::m32BitIndices

protected

Definition at line 410 of file OgreManualObject.h.

## mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters

protected inherited

Definition at line 415 of file OgreRenderable.h.

## mGroupName

String Ogre::ManualObject::ManualObjectSection::mGroupName

protected

Definition at line 407 of file OgreManualObject.h.

## mMaterial

MaterialPtr Ogre::ManualObject::ManualObjectSection::mMaterial

mutable protected

Definition at line 408 of file OgreManualObject.h.

## mMaterialName

String Ogre::ManualObject::ManualObjectSection::mMaterialName

protected

Definition at line 406 of file OgreManualObject.h.

## mParent

ManualObject* Ogre::ManualObject::ManualObjectSection::mParent

protected

Definition at line 405 of file OgreManualObject.h.

## mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable

protected inherited

Definition at line 416 of file OgreRenderable.h.

## mRenderOperation

RenderOperation Ogre::ManualObject::ManualObjectSection::mRenderOperation

protected

Definition at line 409 of file OgreManualObject.h.

## mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutable protected inherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

## mUseIdentityProjection

bool Ogre::Renderable::mUseIdentityProjection

protected inherited

Definition at line 417 of file OgreRenderable.h.

## mUseIdentityView

bool Ogre::Renderable::mUseIdentityView

protected inherited

Definition at line 418 of file OgreRenderable.h.

## mUserObjectBindings

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protected inherited

Definition at line 419 of file OgreRenderable.h.

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

- OgreManualObject.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.