OGRE: Ogre::InstancedGeometry::InstancedObject Class Reference - OGRE Documentation

# Ogre::InstancedGeometry::InstancedObject Class Reference

`#include <OgreInstancedGeometry.h>`

Inheritance diagram for Ogre::InstancedGeometry::InstancedObject:

[legend]

List of all members.

## Public Types
enum | TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
typedef std::vector < GeometryBucket * > | GeometryBucketList
| list of Geometry Buckets that contains the instanced object
## Public Member Functions
| InstancedObject (int index)
| InstancedObject (int index, SkeletonInstance *skeleton, AnimationStateSet *animations)
| ~InstancedObject ()
void | setPosition (Vector3 position)
Vector3 & | getPosition (void)
void | yaw (const Radian &angle)
void | pitch (const Radian &angle)
void | roll (const Radian &angle)
void | rotate (const Quaternion &q)
void | setScale (const Vector3 &scale)
void | setOrientation (const Quaternion &q)
void | setPositionAndOrientation (Vector3 p, const Quaternion &q)
Quaternion & | getOrientation (void)
void | addBucketToList (GeometryBucket *bucket)
void | needUpdate ()
GeometryBucketList & | getGeometryBucketList (void)
void | translate (const Matrix3 &axes, const Vector3 &move)
void | translate (const Vector3 &d)
Matrix3 | getLocalAxes (void) const
void | updateAnimation (void)
AnimationState * | getAnimationState (const String &name) const
SkeletonInstance * | getSkeletonInstance (void)
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 Attributes
GeometryBucketList | mGeometryBucketList
unsigned short | mIndex
Matrix4 | mTransformation
Quaternion | mOrientation
Vector3 | mScale
Vector3 | mPosition
SkeletonInstance * | mSkeletonInstance
Matrix4 * | mBoneWorldMatrices
| Cached bone matrices, including any world transform.
Matrix4 * | mBoneMatrices
| Cached bone matrices in skeleton local space.
AnimationStateSet * | mAnimationState
| State of animation for animable meshes.
unsigned short | mNumBoneMatrices
unsigned long | mFrameAnimationLastUpdated
| Records the last frame in which animation was updated.
## Friends
class | GeometryBucket

## Detailed Description

Definition at line 247 of file OgreInstancedGeometry.h.

## Member Typedef Documentation

typedef std::vector<GeometryBucket*> Ogre::InstancedGeometry::InstancedObject::GeometryBucketList

list of Geometry Buckets that contains the instanced object

Definition at line 261 of file OgreInstancedGeometry.h.

## Member Enumeration Documentation

enum Ogre::InstancedGeometry::InstancedObject::TransformSpace

Enumerator:

  TS_LOCAL | Transform is relative to the local space.
  TS_PARENT | Transform is relative to the space of the parent node.
  TS_WORLD | Transform is relative to world space.

Definition at line 251 of file OgreInstancedGeometry.h.

## Constructor & Destructor Documentation

Ogre::InstancedGeometry::InstancedObject::InstancedObject | ( | int | index | ) |

Ogre::InstancedGeometry::InstancedObject::InstancedObject | ( | int | index,
|  | SkeletonInstance * | skeleton,
|  | AnimationStateSet * | animations |
| ) |  |  |

Ogre::InstancedGeometry::InstancedObject::~InstancedObject | ( |  | ) |

## Member Function Documentation

void Ogre::InstancedGeometry::InstancedObject::setPosition | ( | Vector3 | position | ) |

Vector3& Ogre::InstancedGeometry::InstancedObject::getPosition | ( | void |  | ) |

void Ogre::InstancedGeometry::InstancedObject::yaw | ( | const Radian & | angle | ) |

void Ogre::InstancedGeometry::InstancedObject::pitch | ( | const Radian & | angle | ) |

void Ogre::InstancedGeometry::InstancedObject::roll | ( | const Radian & | angle | ) |

void Ogre::InstancedGeometry::InstancedObject::rotate | ( | const Quaternion & | q | ) |

void Ogre::InstancedGeometry::InstancedObject::setScale | ( | const Vector3 & | scale | ) |

void Ogre::InstancedGeometry::InstancedObject::setOrientation | ( | const Quaternion & | q | ) |

void Ogre::InstancedGeometry::InstancedObject::setPositionAndOrientation | ( | Vector3 | p,
|  | const Quaternion & | q |
| ) |  |  |

Quaternion& Ogre::InstancedGeometry::InstancedObject::getOrientation | ( | void |  | ) |

void Ogre::InstancedGeometry::InstancedObject::addBucketToList | ( | GeometryBucket * | bucket | ) |

void Ogre::InstancedGeometry::InstancedObject::needUpdate | ( |  | ) |

GeometryBucketList& Ogre::InstancedGeometry::InstancedObject::getGeometryBucketList | ( | void |  | ) |

Definition at line 295 of file OgreInstancedGeometry.h.

void Ogre::InstancedGeometry::InstancedObject::translate | ( | const Matrix3 & | axes,
|  | const Vector3 & | move |
| ) |  |  |

void Ogre::InstancedGeometry::InstancedObject::translate | ( | const Vector3 & | d | ) |

Matrix3 Ogre::InstancedGeometry::InstancedObject::getLocalAxes | ( | void |  | ) | const

void Ogre::InstancedGeometry::InstancedObject::updateAnimation | ( | void |  | ) |

AnimationState* Ogre::InstancedGeometry::InstancedObject::getAnimationState | ( | const String & | name | ) | const

SkeletonInstance* Ogre::InstancedGeometry::InstancedObject::getSkeletonInstance | ( | void |  | ) |

Definition at line 301 of file OgreInstancedGeometry.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 GeometryBucket`[friend]`

Definition at line 249 of file OgreInstancedGeometry.h.

## Member Data Documentation

GeometryBucketList Ogre::InstancedGeometry::InstancedObject::mGeometryBucketList`[protected]`

Definition at line 263 of file OgreInstancedGeometry.h.

unsigned short Ogre::InstancedGeometry::InstancedObject::mIndex`[protected]`

Definition at line 264 of file OgreInstancedGeometry.h.

Matrix4 Ogre::InstancedGeometry::InstancedObject::mTransformation`[protected]`

Definition at line 265 of file OgreInstancedGeometry.h.

Quaternion Ogre::InstancedGeometry::InstancedObject::mOrientation`[protected]`

Definition at line 266 of file OgreInstancedGeometry.h.

Vector3 Ogre::InstancedGeometry::InstancedObject::mScale`[protected]`

Definition at line 267 of file OgreInstancedGeometry.h.

Vector3 Ogre::InstancedGeometry::InstancedObject::mPosition`[protected]`

Definition at line 268 of file OgreInstancedGeometry.h.

SkeletonInstance* Ogre::InstancedGeometry::InstancedObject::mSkeletonInstance`[protected]`

Definition at line 269 of file OgreInstancedGeometry.h.

Matrix4* Ogre::InstancedGeometry::InstancedObject::mBoneWorldMatrices`[protected]`

Cached bone matrices, including any world transform.

Definition at line 271 of file OgreInstancedGeometry.h.

Matrix4* Ogre::InstancedGeometry::InstancedObject::mBoneMatrices`[protected]`

Cached bone matrices in skeleton local space.

Definition at line 273 of file OgreInstancedGeometry.h.

AnimationStateSet* Ogre::InstancedGeometry::InstancedObject::mAnimationState`[protected]`

State of animation for animable meshes.

Definition at line 275 of file OgreInstancedGeometry.h.

unsigned short Ogre::InstancedGeometry::InstancedObject::mNumBoneMatrices`[protected]`

Definition at line 276 of file OgreInstancedGeometry.h.

unsigned long Ogre::InstancedGeometry::InstancedObject::mFrameAnimationLastUpdated`[protected]`

Records the last frame in which animation was updated.

Definition at line 278 of file OgreInstancedGeometry.h.

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

- OgreInstancedGeometry.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:33:42 2009