Ogre::BillboardSet Class Reference
Core » Effects

A collection of billboards (faces which are always facing the given direction) with the same (default) dimensions, material and which are fairly close proximity to each other. More...

`#include <OgreBillboardSet.h>`

Inheritance diagram for Ogre::BillboardSet:
[legend]

## Classes

struct | SortByDirectionFunctor
| Sort by direction functor. More...
struct | SortByDistanceFunctor
| Sort by distance functor. More...

## Public Types

typedef vector< ShadowRenderable * >::type | ShadowRenderableList
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator

## Public Member Functions

| BillboardSet (const String &name, unsigned int poolSize=20, bool externalDataSource=false)
| Usual constructor - this is called by the SceneManager. More...
virtual | ~BillboardSet ()
virtual MovableObjectFactory * | _getCreator (void) const
| Get the creator of this object, if any (internal use only) More...
virtual LightList * | _getLightList ()
| Returns a pointer to the current list of lights for this object. More...
virtual SceneManager * | _getManager (void) const
| Get the manager of this object, if any (internal use only) More...
virtual const Matrix4 & | _getParentNodeFullTransform (void) const
| return the full transformation of the parent sceneNode or the attachingPoint node More...
virtual SortMode | _getSortMode (void) const
| Gets the sort mode of this billboard set. More...
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false)
| Internal method called to notify the object that it has been attached to a node. More...
virtual void | _notifyBillboardResized (void)
| Internal callback used by Billboards to notify their parent that they have been resized. More...
virtual void | _notifyBillboardRotated (void)
| Internal callback used by Billboards to notify their parent that they have been rotated. More...
virtual void | _notifyCreator (MovableObjectFactory *fact)
| Notify the object of it's creator (internal use only) More...
virtual void | _notifyCurrentCamera (Camera *cam)
| Overridden from MovableObject. More...
virtual void | _notifyManager (SceneManager *man)
| Notify the object of it's manager (internal use only) More...
virtual void | _notifyMoved (void)
| Internal method called to notify the object that it has been moved. More...
virtual void | _sortBillboards (Camera *cam)
| Sort the billboard set. More...
virtual void | _updateBounds (void)
| Update the bounds of the billboardset. More...
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...
virtual void | _updateRenderQueue (RenderQueue *queue)
| Overridden from MovableObject. More...
virtual void | addQueryFlags (uint32 flags)
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
virtual void | addVisibilityFlags (uint32 flags)
| As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
void | beginBillboards (size_t numBillboards=0)
| Begin injection of billboard data; applicable when constructing the BillboardSet for external data use. More...
virtual void | clear ()
| Empties this set of all billboards. More...
virtual AnimableValuePtr | createAnimableValue (const String &valueName)
| Create a reference-counted AnimableValuePtr for the named value. More...
Billboard * | createBillboard (const Vector3 &position, const ColourValue &colour=ColourValue::White)
| Creates a new billboard and adds it to this set. More...
Billboard * | createBillboard (Real x, Real y, Real z, const ColourValue &colour=ColourValue::White)
| Creates a new billboard and adds it to this set. More...
virtual void | detachFromParent (void)
| Detaches an object from a parent SceneNode or TagPoint, if attached. More...
void | endBillboards (void)
| Finish defining billboards. More...
const StringVector & | getAnimableValueNames (void) const
| Gets a list of animable value names for this object. More...
virtual bool | getAutoextend (void) const
| Returns true if the billboard pool automatically extends. More...
bool | getAutoUpdate (void) const
| Return the auto update state of this billboard set. More...
virtual Billboard * | getBillboard (unsigned int index) const
| Returns a pointer to the billboard at the supplied index. More...
virtual BillboardOrigin | getBillboardOrigin (void) const
| Gets the point which acts as the origin point for all billboards in this set. More...
virtual BillboardRotationType | getBillboardRotationType (void) const
| Sets billboard rotation type. More...
virtual BillboardType | getBillboardType (void) const
| Returns the billboard type in use. More...
virtual const AxisAlignedBox & | getBoundingBox (void) const
| Overridden from MovableObject. More...
virtual Real | getBoundingRadius (void) const
| Overridden from MovableObject. More...
bool | getCastShadows (void) const
| Returns whether shadow casting is enabled for this object. More...
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow. More...
virtual const Vector3 & | getCommonDirection (void) const
| Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More...
virtual const Vector3 & | getCommonUpVector (void) const
| Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON) More...
virtual bool | getCullIndividually (void) const
| Returns whether or not billboards in this are tested individually for culling. More...
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index. More...
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
| Overridden member from ShadowCaster. More...
virtual Real | getDefaultHeight (void) const
| See setDefaultDimensions - this gets 1 component individually. More...
virtual Real | getDefaultWidth (void) const
| See setDefaultDimensions - this gets 1 component individually. More...
EdgeData * | getEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
const AxisAlignedBox & | getLightCapBounds (void) const
| Overridden member from ShadowCaster. More...
virtual uint32 | getLightMask () const
| Get a bitwise mask which will filter the lights affecting this object. More...
const LightList & | getLights (void) const
| Gets a list of lights, ordered relative to how close they are to this renderable. More...
virtual Listener * | getListener (void) const
| Gets the current listener for this object. More...
virtual const MaterialPtr & | getMaterial (void) const
| Overridden from MovableObject. More...
virtual const String & | getMaterialName (void) const
| Sets the name of the material to be used for this billboard set. More...
virtual const String & | getMovableType (void) const
| Overridden from MovableObject. More...
virtual const String & | getName (void) const
| Returns the name of this object. More...
virtual int | getNumBillboards (void) const
| Returns the number of active billboards which currently make up this set. More...
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires. More...
virtual Node * | getParentNode (void) const
| Returns the node to which this object is attached. More...
virtual SceneNode * | getParentSceneNode (void) const
| Returns the scene node to which this object is attached. More...
Real | getPointExtrusionDistance (const Light *l) const
| Get the distance to extrude for a point/spot light. More...
virtual bool | getPolygonModeOverrideable (void) const
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
virtual unsigned int | getPoolSize (void) const
| Returns the current size of the billboard pool. More...
virtual uint32 | getQueryFlags (void) const
| Returns the query flags relevant for this object. More...
bool | getReceivesShadows ()
| Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
virtual Real | getRenderingDistance (void) const
| Gets the distance at which batches are no longer rendered. More...
virtual Real | getRenderingMinPixelSize () const
| Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void | getRenderOperation (RenderOperation &op)
| Overridden from MovableObject. More...
virtual uint8 | getRenderQueueGroup (void) const
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
virtual RenderSystemData * | getRenderSystemData () const
| Gets RenderSystem private data. More...
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
virtual bool | getSortingEnabled (void) const
| Returns true if sorting of billboards is enabled based on their distance from the camera. More...
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden, see Renderable. More...
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses. More...
virtual Ogre::FloatRect const * | getTextureCoords (uint16 *oNumCoords)
| getTextureCoords() returns the current texture coordinate rects in effect. More...
uint32 | getTypeFlags (void) const
| Override to return specific type flag. More...
virtual bool | getUseAccurateFacing (void) const
| Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. 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
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...
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...
virtual uint32 | getVisibilityFlags (void) const
| Returns the visibility flags relevant for this object. More...
virtual bool | getVisible (void) const
| Gets this object whether to be visible or not, if it has a renderable component. More...
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const
| Retrieves the axis-aligned bounding box for this object in world coordinates. More...
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const
| Retrieves the worldspace bounding sphere for this object. More...
virtual void | getWorldTransforms (Matrix4 *xform) const
| Overridden from MovableObject. More...
bool | hasCustomParameter (size_t index) const
| Checks whether a custom value is associated with this Renderable at the given index. More...
bool | hasEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
void | injectBillboard (const Billboard &bb)
| Define a billboard. More...
virtual bool | isAttached (void) const
| Returns true if this object is attached to a SceneNode or TagPoint. More...
virtual bool | isDebugDisplayEnabled (void) const
| Gets whether debug display of this object is enabled. More...
virtual bool | isInScene (void) const
| Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
virtual bool | isParentTagPoint () const
| Gets whether the parent node is a TagPoint (or a SceneNode) More...
virtual bool | isPointRenderingEnabled (void) const
| Returns whether point rendering is enabled. More...
virtual bool | isVisible (void) const
| Returns whether or not this object is supposed to be visible or not. More...
void | notifyBillboardDataChanged (void)
| When billboard set is not auto updating its GPU buffer, the user is responsible to inform it about any billboard changes in order to reflect them at the rendering stage. 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...
virtual const LightList & | queryLights (void) const
| Gets a list of lights, ordered relative to how close they are to this movable object. More...
virtual void | removeBillboard (unsigned int index)
| Removes the billboard at the supplied index. More...
virtual void | removeBillboard (Billboard *pBill)
| Removes a billboard from the set. More...
void | removeCustomParameter (size_t index)
| Removes a custom value which is associated with this Renderable at the given index. More...
virtual void | removeQueryFlags (uint32 flags)
| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
virtual void | removeVisibilityFlags (uint32 flags)
| As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
virtual void | setAutoextend (bool autoextend)
| Tells the set whether to allow automatic extension of the pool of billboards. More...
void | setAutoUpdate (bool autoUpdate)
| Set the auto update state of this billboard set. More...
virtual void | setBillboardOrigin (BillboardOrigin origin)
| Sets the point which acts as the origin point for all billboards in this set. More...
virtual void | setBillboardRotationType (BillboardRotationType rotationType)
| Sets billboard rotation type. More...
virtual void | setBillboardsInWorldSpace (bool ws)
| Sets whether billboards should be treated as being in world space. More...
virtual void | setBillboardType (BillboardType bbt)
| Sets the type of billboard to render. More...
void | setBounds (const AxisAlignedBox &box, Real radius)
| Set the bounds of the BillboardSet. More...
void | setCastShadows (bool enabled)
| Sets whether or not this object will cast shadows. More...
virtual void | setCommonDirection (const Vector3 &vec)
| Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPENDICULAR_COMMON. More...
virtual void | setCommonUpVector (const Vector3 &vec)
| Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON. More...
virtual void | setCullIndividually (bool cullIndividual)
| Sets whether culling tests billboards in this individually as well as in a group. 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...
virtual void | setDebugDisplayEnabled (bool enabled)
| Sets whether or not the debug display of this object is enabled. More...
virtual void | setDefaultDimensions (Real width, Real height)
| Sets the default dimensions of the billboards in this set. More...
virtual void | setDefaultHeight (Real height)
| See setDefaultDimensions - this sets 1 component individually. More...
virtual void | setDefaultWidth (Real width)
| See setDefaultDimensions - this sets 1 component individually. More...
virtual void | setLightMask (uint32 lightMask)
| Set a bitwise mask which will filter the lights affecting this object. More...
virtual void | setListener (Listener *listener)
| Sets a listener for this object. More...
virtual void | setMaterial (const MaterialPtr &material)
| Sets the name of the material to be used for this billboard set. More...
virtual void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Sets the name of the material to be used for this billboard set. More...
virtual void | setPointRenderingEnabled (bool enabled)
| Set whether or not the BillboardSet will use point rendering rather than manually generated quads. 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 | setPoolSize (size_t size)
| Adjusts the size of the pool of billboards available in this set. More...
virtual void | setQueryFlags (uint32 flags)
| Sets the query flags for this object. More...
virtual void | setRenderingDistance (Real dist)
| Sets the distance at which the object is no longer rendered. More...
virtual void | setRenderingMinPixelSize (Real pixelSize)
| Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void | setRenderQueueGroup (uint8 queueID)
| Sets the render queue group this entity will be rendered through. More...
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
| Sets the render queue group and group priority this entity will be rendered through. More...
virtual void | setRenderSystemData (RenderSystemData *val) const
| Sets RenderSystem private data. More...
virtual void | setSortingEnabled (bool sortenable)
| Enables sorting for this BillboardSet. More...
virtual void | setTextureCoords (Ogre::FloatRect const *coords, uint16 numCoords)
| BillboardSet can use custom texture coordinates for various billboards. More...
virtual void | setTextureStacksAndSlices (uchar stacks, uchar slices)
| setTextureStacksAndSlices() will generate texture coordinate rects as if the texture for the billboard set contained 'stacks' rows of 'slices' images each, all equal size. More...
virtual void | setUseAccurateFacing (bool acc)
| Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. 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)
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything)
virtual void | setVisibilityFlags (uint32 flags)
| Sets the visibility flags for this object. More...
virtual void | setVisible (bool visible)
| Tells this object whether to be visible or not, if it has a renderable component. More...
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
| Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...

## Static Public Member Functions

static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
| Utility method for extruding vertices based on a light. More...
static uint32 | getDefaultQueryFlags ()
| Get the default query flags for all future MovableObject instances. More...
static uint32 | getDefaultVisibilityFlags ()
| Get the default visibility flags for all future MovableObject instances. More...
static void | setDefaultQueryFlags (uint32 flags)
| Set the default query flags for all future MovableObject instances. More...
static void | setDefaultVisibilityFlags (uint32 flags)
| Set the default visibility flags for all future MovableObject instances. More...

## Protected Types

typedef list< Billboard * >::type | ActiveBillboardList
typedef map< String, StringVector >::type | AnimableDictionaryMap
typedef vector< Billboard * >::type | BillboardPool
typedef map< size_t, Vector4 >::type | CustomParameterMap
typedef list< Billboard * >::type | FreeBillboardList
typedef vector< Ogre::FloatRect >::type | TextureCoordSets

## Protected Member Functions

| BillboardSet ()
| Private constructor (instances cannot be created directly). More...
StringVector & | _getAnimableValueNames (void)
| Get an updateable reference to animable value list. More...
bool | billboardVisible (Camera *cam, const Billboard &bill)
| Internal method for culling individual billboards. More...
void | createAnimableDictionary (void) const
| Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
| Utility method for extruding a bounding box. More...
void | genBillboardAxes (Vector3 *pX, Vector3 *pY, const Billboard *pBill=0)
| Internal method for generating billboard corners. More...
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
| Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More...
void | genVertices (const Vector3 *const offsets, const Billboard &pBillboard)
| Internal method for generating vertex data. More...
void | genVertOffsets (Real inleft, Real inright, Real intop, Real inbottom, Real width, Real height, const Vector3 &x, const Vector3 &y, Vector3 *pDestVec)
| Internal method generates vertex offsets. More...
virtual const String & | getAnimableDictionaryName (void) const
| Get the name of the animable dictionary for this class. More...
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
| Helper method for calculating extrusion distance. More...
void | getParametricOffsets (Real &left, Real &right, Real &top, Real &bottom)
| Internal method, generates parametric offsets based on origin. More...
virtual void | increasePool (size_t size)
| Internal method for increasing pool size. More...
virtual void | initialiseAnimableDictionary (StringVector &) const
| Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
| Tells the caster to perform the tasks necessary to update the edge data's light listing. More...

## Protected Attributes

AxisAlignedBox | mAABB
| Bounds of all billboards in this set. More...
bool | mAccurateFacing
| Use 'true' billboard to cam position facing, rather than camera direcion. More...
ActiveBillboardList | mActiveBillboards
| Active billboard list. More...
bool | mAllDefaultRotation
bool | mAllDefaultSize
| True if no billboards in this set have been resized - greater efficiency. More...
bool | mAutoExtendPool
| Flag indicating whether to autoextend pool. More...
bool | mBeyondFarDistance
| Hidden because of distance? More...
BillboardPool | mBillboardPool
| Pool of billboard instances for use and reuse in the active billboard list. More...
BillboardType | mBillboardType
| The type of billboard to render. More...
Real | mBottomOff
Real | mBoundingRadius
| Bounding radius. More...
Vector3 | mCamDir
| Camera direction in billboard space. More...
Vector3 | mCamPos
| Camera position in billboard space. More...
Quaternion | mCamQ
| Camera orientation in billboard space. More...
Vector3 | mCamX
| Camera axes in billboard space. More...
Vector3 | mCamY
bool | mCastShadows
| Does this object cast shadows? More...
Vector3 | mCommonDirection
| Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON. More...
Vector3 | mCommonUpVector
| Common up-vector for billboards of type BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON. More...
MovableObjectFactory * | mCreator
| Creator of this object (if created by a factory) More...
bool | mCullIndividual
| Flag indicating whether each billboard should be culled separately (default: false) More...
Camera * | mCurrentCamera
| Current camera. More...
CustomParameterMap | mCustomParameters
bool | mDebugDisplay
| Is debug display enabled? More...
Real | mDefaultHeight
| Default height of each billboard. More...
Real | mDefaultWidth
| Default width of each billboard. More...
FreeBillboardList | mFreeBillboards
| Free billboard queue. More...
IndexData * | mIndexData
| The vertex index data for all billboards in this set (1 set only) More...
Real | mLeftOff
| Parametric offsets of origin. More...
LightList | mLightList
| List of lights for this object. More...
ulong | mLightListUpdated
| The last frame that this light list was updated in. More...
uint32 | mLightMask
| the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More...
Listener * | mListener
| MovableObject listener - only one allowed (no list) for size & performance reasons. */. More...
float * | mLockPtr
| Locked pointer to buffer. More...
HardwareVertexBufferSharedPtr | mMainBuf
| Shortcut to main buffer (positions, colours, texture coords) More...
SceneManager * | mManager
| SceneManager holding this object (if applicable) More...
MaterialPtr | mMaterial
| Pointer to the material to use. More...
String | mMaterialName
| Name of the material to use. More...
Real | mMinPixelSize
String | mName
| Name of this object. More...
unsigned short | mNumVisibleBillboards
| Number of visible billboards (will be == getNumBillboards if mCullIndividual == false) More...
BillboardOrigin | mOriginType
| Origin of each billboard. More...
bool | mParentIsTagPoint
Node * | mParentNode
| node to which this object is attached More...
bool | mPointRendering
| Use point rendering? More...
bool | mPolygonModeOverrideable
uint32 | mQueryFlags
| Flags determining whether this object is included / excluded from scene queries. More...
bool | mRenderingDisabled
| Does rendering this object disabled by listener? More...
uint8 | mRenderQueueID
| The render queue to use when rendering this object. More...
bool | mRenderQueueIDSet
| Flags whether the RenderQueue's default should be used. More...
ushort | mRenderQueuePriority
| The render queue group to use when rendering this object. More...
bool | mRenderQueuePrioritySet
| Flags whether the RenderQueue's default should be used. More...
RenderSystemData * | mRenderSystemData
| User objects binding. More...
Real | mRightOff
BillboardRotationType | mRotationType
| Rotation type of each billboard. More...
bool | mSortingEnabled
| Flag indicating whether the billboards has to be sorted. More...
Real | mSquaredUpperDistance
TextureCoordSets | mTextureCoords
Real | mTopOff
Real | mUpperDistance
| Upper distance to still render. More...
bool | mUseIdentityProjection
bool | mUseIdentityView
UserObjectBindings | mUserObjectBindings
| User objects binding. More...
UserObjectBindings | mUserObjectBindings
VertexData * | mVertexData
| The vertex position data for all billboards in this set. More...
uint32 | mVisibilityFlags
| Flags determining whether this object is visible (compared to SceneManager mask) More...
bool | mVisible
| Is this object visible? More...
Vector3 | mVOffset [4]
| Boundary offsets based on origin and camera orientation Vector3 vLeftOff, vRightOff, vTopOff, vBottomOff; Final vertex offsets, used where sizes all default to save calcs. More...
AxisAlignedBox | mWorldAABB
| Cached world AABB of this object. More...
Sphere | mWorldBoundingSphere
AxisAlignedBox | mWorldDarkCapBounds
| World space AABB of this object's dark cap. More...
bool | mWorldSpace

## Static Protected Attributes

static RadixSort< ActiveBillboardList, Billboard *, float > | mRadixSorter
static AnimableDictionaryMap | msAnimableDictionary
| Static map of class name to list of animable value names. More...
static uint32 | msDefaultQueryFlags
| Default query flags. More...
static uint32 | msDefaultVisibilityFlags
| Default visibility flags. More...

## Private Member Functions

void | _createBuffers (void)
| Internal method creates vertex and index buffers. More...
void | _destroyBuffers (void)
| Internal method destroys vertex and index buffers. More...

## Private Attributes

bool | mAutoUpdate
| Tell if vertex buffer should be update automatically. More...
bool | mBillboardDataChanged
| True if the billboard data changed. Will cause vertex buffer update. More...
bool | mBuffersCreated
| Flag indicating whether the HW buffers have been created. More...
bool | mExternalData
| Is external billboard data in use? More...
size_t | mPoolSize
| The number of billboard in the pool. More...

## Detailed Description

A collection of billboards (faces which are always facing the given direction) with the same (default) dimensions, material and which are fairly close proximity to each other.

Remarks
  Billboards are rectangles made up of 2 tris which are always facing the given direction. They are typically used for special effects like particles. This class collects together a set of billboards with the same (default) dimensions, material and relative locality in order to process them more efficiently. The entire set of billboards will be culled as a whole (by default, although this can be changed if you want a large set of billboards which are spread out and you want them culled individually), individual Billboards have locations which are relative to the set (which itself derives it's position from the SceneNode it is attached to since it is a MoveableObject), they will be rendered as a single rendering operation, and some calculations will be sped up by the fact that they use the same dimensions so some workings can be reused.

  A BillboardSet can be created using the SceneManager::createBillboardSet method. They can also be used internally by other classes to create effects.

Note
  Billboard bounds are only automatically calculated when you create them. If you modify the position of a billboard you may need to call _updateBounds if the billboard moves outside the original bounds. Similarly, the bounds do no shrink when you remove a billboard, if you want them to call _updateBounds, but note this requires a potentially expensive examination of every billboard in the set.

Definition at line 110 of file OgreBillboardSet.h.

## Member Typedef Documentation

## ActiveBillboardList

typedef list<Billboard*>::type Ogre::BillboardSet::ActiveBillboardList

protected

Definition at line 152 of file OgreBillboardSet.h.

## AnimableDictionaryMap

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap

protected inherited

Definition at line 241 of file OgreAnimable.h.

## BillboardPool

typedef vector<Billboard*>::type Ogre::BillboardSet::BillboardPool

protected

Definition at line 154 of file OgreBillboardSet.h.

## CustomParameterMap

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

protected inherited

Definition at line 414 of file OgreRenderable.h.

## FreeBillboardList

typedef list<Billboard*>::type Ogre::BillboardSet::FreeBillboardList

protected

Definition at line 153 of file OgreBillboardSet.h.

## ShadowRenderableList

typedef vector<ShadowRenderable*>::type Ogre::ShadowCaster::ShadowRenderableList

inherited

Definition at line 136 of file OgreShadowCaster.h.

## ShadowRenderableListIterator

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator

inherited

Definition at line 137 of file OgreShadowCaster.h.

## TextureCoordSets

typedef vector< Ogre::FloatRect >::type Ogre::BillboardSet::TextureCoordSets

protected

Definition at line 210 of file OgreBillboardSet.h.

## Constructor & Destructor Documentation

## BillboardSet() [1/2]

Ogre::BillboardSet::BillboardSet | ( |  | ) |

protected

Private constructor (instances cannot be created directly).

## BillboardSet() [2/2]

Ogre::BillboardSet::BillboardSet | ( | const String & | name,
|  | unsigned int | poolSize = `20`,
|  | bool | externalDataSource = `false`
| ) |  |

Usual constructor - this is called by the SceneManager.

Parameters

  name | The name to give the billboard set (must be unique)
  poolSize | The initial size of the billboard pool. Estimate of the number of billboards which will be required, and pass it using this parameter. The set will preallocate this number to avoid memory fragmentation. The default behaviour once this pool has run out is to double it.

  externalDataSource

  If `true`, the source of data for drawing the billboards will not be the internal billboard list, but external data. When driving the billboard from external data, you must call _notifyCurrentCamera to reorient the billboards, setPoolSize to set the maximum billboards you want to use, beginBillboards to start the update, and injectBillboard per billboard, followed by endBillboards.

See also
  BillboardSet::setAutoextend

## ~BillboardSet()

virtual Ogre::BillboardSet::~BillboardSet | ( |  | ) |

virtual

## Member Function Documentation

## _createBuffers()

void Ogre::BillboardSet::_createBuffers | ( | void |  | ) |

private

Internal method creates vertex and index buffers.

## _destroyBuffers()

void Ogre::BillboardSet::_destroyBuffers | ( | void |  | ) |

private

Internal method destroys vertex and index buffers.

## _getAnimableValueNames()

StringVector& Ogre::AnimableObject::_getAnimableValueNames | ( | void |  | ) |

protected inherited

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

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

## _getCreator()

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator | ( | void |  | ) | const

virtual inherited

Get the creator of this object, if any (internal use only)

Definition at line 186 of file OgreMovableObject.h.

## _getLightList()

virtual LightList* Ogre::MovableObject::_getLightList | ( |  | ) |

virtual inherited

Returns a pointer to the current list of lights for this object.

Remarks
  You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 491 of file OgreMovableObject.h.

## _getManager()

virtual SceneManager* Ogre::MovableObject::_getManager | ( | void |  | ) | const

virtual inherited

Get the manager of this object, if any (internal use only)

Definition at line 190 of file OgreMovableObject.h.

## _getParentNodeFullTransform()

virtual const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform | ( | void |  | ) | const

virtual inherited

return the full transformation of the parent sceneNode or the attachingPoint node

Reimplemented in Ogre::InstancedEntity.

## _getSortMode()

virtual SortMode Ogre::BillboardSet::_getSortMode | ( | void |  | ) | const

virtual

Gets the sort mode of this billboard set.

## _notifyAttached()

virtual void Ogre::MovableObject::_notifyAttached | ( | Node * | parent,
|  | bool | isTagPoint = `false`
| ) |  |

virtual inherited

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, and Ogre::InstancedEntity.

## _notifyBillboardResized()

virtual void Ogre::BillboardSet::_notifyBillboardResized | ( | void |  | ) |

virtual

Internal callback used by Billboards to notify their parent that they have been resized.

## _notifyBillboardRotated()

virtual void Ogre::BillboardSet::_notifyBillboardRotated | ( | void |  | ) |

virtual

Internal callback used by Billboards to notify their parent that they have been rotated.

## _notifyCreator()

virtual void Ogre::MovableObject::_notifyCreator | ( | MovableObjectFactory * | fact | ) |

virtual inherited

Notify the object of it's creator (internal use only)

Definition at line 184 of file OgreMovableObject.h.

## _notifyCurrentCamera()

virtual void Ogre::BillboardSet::_notifyCurrentCamera | ( | Camera * | cam | ) |

virtual

Overridden from MovableObject.

See also
  MovableObject

Reimplemented from Ogre::MovableObject.

## _notifyManager()

virtual void Ogre::MovableObject::_notifyManager | ( | SceneManager * | man | ) |

virtual inherited

Notify the object of it's manager (internal use only)

Definition at line 188 of file OgreMovableObject.h.

## _notifyMoved()

virtual void Ogre::MovableObject::_notifyMoved | ( | void |  | ) |

virtual inherited

Internal method called to notify the object that it has been moved.

Reimplemented in Ogre::Light, and Ogre::InstancedEntity.

## _sortBillboards()

virtual void Ogre::BillboardSet::_sortBillboards | ( | Camera * | cam | ) |

virtual

Sort the billboard set.

Only called when enabled via setSortingEnabled

## _updateBounds()

virtual void Ogre::BillboardSet::_updateBounds | ( | void |  | ) |

virtual

Update the bounds of the billboardset.

## _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.

## _updateRenderQueue()

virtual void Ogre::BillboardSet::_updateRenderQueue | ( | RenderQueue * | queue | ) |

virtual

Overridden from MovableObject.

See also
  MovableObject

Implements Ogre::MovableObject.

## addQueryFlags()

virtual void Ogre::MovableObject::addQueryFlags | ( | uint32 | flags | ) |

virtual inherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 396 of file OgreMovableObject.h.

## addVisibilityFlags()

virtual void Ogre::MovableObject::addVisibilityFlags | ( | uint32 | flags | ) |

virtual inherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 424 of file OgreMovableObject.h.

## beginBillboards()

void Ogre::BillboardSet::beginBillboards | ( | size_t | numBillboards = `0` | ) |

Begin injection of billboard data; applicable when constructing the BillboardSet for external data use.

Parameters

  numBillboards | If you know the number of billboards you will be issuing, state it here to make the update more efficient.

## billboardVisible()

bool Ogre::BillboardSet::billboardVisible | ( | Camera * | cam,
|  | const Billboard & | bill
| ) |  |

protected

Internal method for culling individual billboards.

## clear()

virtual void Ogre::BillboardSet::clear | ( |  | ) |

virtual

Empties this set of all billboards.

## createAnimableDictionary()

void Ogre::AnimableObject::createAnimableDictionary | ( | void |  | ) | const

protected inherited

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 254 of file OgreAnimable.h.

## createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue | ( | const String & | valueName | ) |

virtual inherited

Create a reference-counted AnimableValuePtr for the named value.

Remarks
  You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 320 of file OgreAnimable.h.

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

## createBillboard() [1/2]

Billboard* Ogre::BillboardSet::createBillboard | ( | const Vector3 & | position,
|  | const ColourValue & | colour = `ColourValue::White`
| ) |  |

Creates a new billboard and adds it to this set.

Remarks
  Behaviour once the billboard pool has been exhausted depends on the BillboardSet::setAutoextend option.

Parameters

  position | The position of the new billboard realtive to the certer of the set
  colour | Optional base colour of the billboard.

Returns
  On success, a pointer to a newly created Billboard is returned.

  On failure (i.e. no more space and can't autoextend), `NULL` is returned.

See also
  BillboardSet::setAutoextend

## createBillboard() [2/2]

Billboard* Ogre::BillboardSet::createBillboard | ( | Real | x,
|  | Real | y,
|  | Real | z,
|  | const ColourValue & | colour = `ColourValue::White`
| ) |  |

Creates a new billboard and adds it to this set.

Remarks
  Behaviour once the billboard pool has been exhausted depends on the BillboardSet::setAutoextend option.

Parameters

  x | The `x` position of the new billboard relative to the center of the set
  y | The `y` position of the new billboard relative to the center of the set
  z | The `z` position of the new billboard relative to the center of the set
  colour | Optional base colour of the billboard.

Returns
  On success, a pointer to a newly created Billboard is returned.

  On failure (i.e. no more space and can't autoextend), `NULL` is returned.

See also
  BillboardSet::setAutoextend

## detachFromParent()

virtual void Ogre::MovableObject::detachFromParent | ( | void |  | ) |

virtual inherited

Detaches an object from a parent SceneNode or TagPoint, if attached.

## endBillboards()

void Ogre::BillboardSet::endBillboards | ( | void |  | ) |

Finish defining billboards.

## extrudeBounds()

virtual void Ogre::ShadowCaster::extrudeBounds | ( | AxisAlignedBox & | box,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) |  | const

protected virtual inherited

Utility method for extruding a bounding box.

Parameters

  box | Original bounding box, will be updated in-place.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## extrudeVertices()

static void Ogre::ShadowCaster::extrudeVertices | ( | const HardwareVertexBufferSharedPtr & | vertexBuffer,
|  | size_t | originalVertexCount,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) |  |

static inherited

Utility method for extruding vertices based on a light.

Remarks
  Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters

  vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
  originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## genBillboardAxes()

void Ogre::BillboardSet::genBillboardAxes | ( | Vector3 * | pX,
|  | Vector3 * | pY,
|  | const Billboard * | pBill = `0`
| ) |  |

protected

Internal method for generating billboard corners.

Remarks
  Optional parameter pBill is only present for type BBT_ORIENTED_SELF and BBT_PERPENDICULAR_SELF

## generateShadowVolume()

virtual void Ogre::ShadowCaster::generateShadowVolume | ( | EdgeData * | edgeData,
|  | const HardwareIndexBufferSharedPtr & | indexBuffer,
|  | size_t & | indexBufferUsedSize,
|  | const Light * | light,
|  | ShadowRenderableList & | shadowRenderables,
|  | unsigned long | flags
| ) |  |

protected virtual inherited

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

Parameters

  edgeData | The edge information to use.
  indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable.
  indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset.
  light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
  shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
  flags | Additional controller flags, see ShadowRenderableFlags.

## genVertices()

void Ogre::BillboardSet::genVertices | ( | const Vector3 *const | offsets,
|  | const Billboard & | pBillboard
| ) |  |

protected

Internal method for generating vertex data.

Parameters

  offsets | Array of 4 Vector3 offsets
  pBillboard | Reference to billboard

## genVertOffsets()

void Ogre::BillboardSet::genVertOffsets | ( | Real | inleft,
|  | Real | inright,
|  | Real | intop,
|  | Real | inbottom,
|  | Real | width,
|  | Real | height,
|  | const Vector3 & | x,
|  | const Vector3 & | y,
|  | Vector3 * | pDestVec
| ) |  |

protected

Internal method generates vertex offsets.

Remarks
  Takes in parametric offsets as generated from getParametericOffsets, width and height values and billboard x and y axes as generated from genBillboardAxes. Fills output array of 4 vectors with vector offsets from origin for left-top, right-top, left-bottom, right-bottom corners.

## getAnimableDictionaryName()

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName | ( | void |  | ) | const

protected virtual inherited

Get the name of the animable dictionary for this class.

Remarks
  Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 249 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

## getAnimableValueNames()

const StringVector& Ogre::AnimableObject::getAnimableValueNames | ( | void |  | ) | const

inherited

Gets a list of animable value names for this object.

Definition at line 295 of file OgreAnimable.h.

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

## getAutoextend()

virtual bool Ogre::BillboardSet::getAutoextend | ( | void |  | ) | const

virtual

Returns true if the billboard pool automatically extends.

See also
  BillboardSet::setAutoextend

## getAutoUpdate()

bool Ogre::BillboardSet::getAutoUpdate | ( | void |  | ) | const

Return the auto update state of this billboard set.

Definition at line 848 of file OgreBillboardSet.h.

## getBillboard()

virtual Billboard* Ogre::BillboardSet::getBillboard | ( | unsigned int | index | ) | const

virtual

Returns a pointer to the billboard at the supplied index.

Note
  This method requires linear time since the billboard list is a linked list.

Parameters

  index | The index of the billboard that is requested.

Returns
  On success, a valid pointer to the requested billboard is returned.

  On failure, `NULL` is returned.

## getBillboardOrigin()

virtual BillboardOrigin Ogre::BillboardSet::getBillboardOrigin | ( | void |  | ) | const

virtual

Gets the point which acts as the origin point for all billboards in this set.

Returns
  A member of the BillboardOrigin enum specifying the origin for all the billboards in this set.

Referenced by Ogre::BillboardParticleRenderer::getBillboardOrigin().

## getBillboardRotationType()

virtual BillboardRotationType Ogre::BillboardSet::getBillboardRotationType | ( | void |  | ) | const

virtual

Sets billboard rotation type.

Returns
  A member of the BillboardRotationType enum specifying the rotation type for all the billboards in this set.

## getBillboardType()

virtual BillboardType Ogre::BillboardSet::getBillboardType | ( | void |  | ) | const

virtual

Returns the billboard type in use.

## getBoundingBox()

virtual const AxisAlignedBox& Ogre::BillboardSet::getBoundingBox | ( | void |  | ) | const

virtual

Overridden from MovableObject.

See also
  MovableObject

Implements Ogre::MovableObject.

## getBoundingRadius()

virtual Real Ogre::BillboardSet::getBoundingRadius | ( | void |  | ) | const

virtual

Overridden from MovableObject.

See also
  MovableObject

Implements Ogre::MovableObject.

## getCastShadows()

bool Ogre::MovableObject::getCastShadows | ( | void |  | ) | const

virtual inherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 521 of file OgreMovableObject.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.

## getCommonDirection()

virtual const Vector3& Ogre::BillboardSet::getCommonDirection | ( | void |  | ) | const

virtual

Gets the common direction for all billboards (BBT_ORIENTED_COMMON)

## getCommonUpVector()

virtual const Vector3& Ogre::BillboardSet::getCommonUpVector | ( | void |  | ) | const

virtual

Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON)

## getCullIndividually()

virtual bool Ogre::BillboardSet::getCullIndividually | ( | void |  | ) | const

virtual

Returns whether or not billboards in this are tested individually for culling.

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

## getDarkCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds | ( | const Light & | light,
|  | Real | dirLightExtrusionDist
| ) |  | const

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getDefaultHeight()

virtual Real Ogre::BillboardSet::getDefaultHeight | ( | void |  | ) | const

virtual

See setDefaultDimensions - this gets 1 component individually.

## getDefaultQueryFlags()

static uint32 Ogre::MovableObject::getDefaultQueryFlags | ( |  | ) |

static inherited

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

## getDefaultVisibilityFlags()

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags | ( |  | ) |

static inherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 439 of file OgreMovableObject.h.

## getDefaultWidth()

virtual Real Ogre::BillboardSet::getDefaultWidth | ( | void |  | ) | const

virtual

See setDefaultDimensions - this gets 1 component individually.

## getEdgeList()

EdgeData* Ogre::MovableObject::getEdgeList | ( | void |  | ) |

virtual inherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 494 of file OgreMovableObject.h.

## getExtrusionDistance()

Real Ogre::ShadowCaster::getExtrusionDistance | ( | const Vector3 & | objectPos,
|  | const Light * | light
| ) |  | const

protected inherited

Helper method for calculating extrusion distance.

## getLightCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds | ( | void |  | ) | const

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getLightMask()

virtual uint32 Ogre::MovableObject::getLightMask | ( |  | ) | const

virtual inherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks
  By default, this mask is fully set meaning all lights will affect this object

Definition at line 476 of file OgreMovableObject.h.

## getLights()

const LightList& Ogre::BillboardSet::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.

## getListener()

virtual Listener* Ogre::MovableObject::getListener | ( | void |  | ) | const

virtual inherited

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

## getMaterial()

virtual const MaterialPtr& Ogre::BillboardSet::getMaterial | ( | void |  | ) | const

virtual

Overridden from MovableObject.

See also
  MovableObject

Implements Ogre::Renderable.

## getMaterialName()

virtual const String& Ogre::BillboardSet::getMaterialName | ( | void |  | ) | const

virtual

Sets the name of the material to be used for this billboard set.

Returns
  The name of the material that is used for this set.

## getMovableType()

virtual const String& Ogre::BillboardSet::getMovableType | ( | void |  | ) | const

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

## getName()

virtual const String& Ogre::MovableObject::getName | ( | void |  | ) | const

virtual inherited

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

## getNumBillboards()

virtual int Ogre::BillboardSet::getNumBillboards | ( | void |  | ) | const

virtual

Returns the number of active billboards which currently make up this set.

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

## getParametricOffsets()

void Ogre::BillboardSet::getParametricOffsets | ( | Real & | left,
|  | Real & | right,
|  | Real & | top,
|  | Real & | bottom
| ) |  |

protected

Internal method, generates parametric offsets based on origin.

## getParentNode()

virtual Node* Ogre::MovableObject::getParentNode | ( | void |  | ) | const

virtual inherited

Returns the node to which this object is attached.

Remarks
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

## getParentSceneNode()

virtual SceneNode* Ogre::MovableObject::getParentSceneNode | ( | void |  | ) | const

virtual inherited

Returns the scene node to which this object is attached.

Remarks
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

## getPointExtrusionDistance()

Real Ogre::MovableObject::getPointExtrusionDistance | ( | const Light * | l | ) | const

virtual inherited

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

## 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().

## getPoolSize()

virtual unsigned int Ogre::BillboardSet::getPoolSize | ( | void |  | ) | const

virtual

Returns the current size of the billboard pool.

Returns
  The current size of the billboard pool.

See also
  BillboardSet::setAutoextend

## getQueryFlags()

virtual uint32 Ogre::MovableObject::getQueryFlags | ( | void |  | ) | const

virtual inherited

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 403 of file OgreMovableObject.h.

## getReceivesShadows()

bool Ogre::MovableObject::getReceivesShadows | ( |  | ) |

inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

## getRenderingDistance()

virtual Real Ogre::MovableObject::getRenderingDistance | ( | void |  | ) | const

virtual inherited

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

## getRenderingMinPixelSize()

virtual Real Ogre::MovableObject::getRenderingMinPixelSize | ( |  | ) | const

virtual inherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 318 of file OgreMovableObject.h.

## getRenderOperation()

virtual void Ogre::BillboardSet::getRenderOperation | ( | RenderOperation & | op | ) |

virtual

Overridden from MovableObject.

See also
  MovableObject

Implements Ogre::Renderable.

## getRenderQueueGroup()

virtual uint8 Ogre::MovableObject::getRenderQueueGroup | ( | void |  | ) | const

virtual inherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

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

## getShadowVolumeRenderableIterator()

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator | ( | ShadowTechnique | shadowTechnique,
|  | const Light * | light,
|  | HardwareIndexBufferSharedPtr * | indexBuffer,
|  | size_t * | indexBufferUsedSize,
|  | bool | extrudeVertices,
|  | Real | extrusionDist,
|  | unsigned long | flags = `0`
| ) |  |

virtual inherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

## getSortingEnabled()

virtual bool Ogre::BillboardSet::getSortingEnabled | ( | void |  | ) | const

virtual

Returns true if sorting of billboards is enabled based on their distance from the camera.

See also
  BillboardSet::setSortingEnabled

## getSquaredViewDepth()

Real Ogre::BillboardSet::getSquaredViewDepth | ( | const Camera * | cam | ) | const

virtual

Overridden, see Renderable.

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.

## getTextureCoords()

virtual Ogre::FloatRect const* Ogre::BillboardSet::getTextureCoords | ( | uint16 * | oNumCoords | ) |

virtual

getTextureCoords() returns the current texture coordinate rects in effect.

By default, there is only one texture coordinate rect in the set, spanning the entire texture from 0 through 1 in each direction.

See also
  BillboardSet::setTextureCoords()

## getTypeFlags()

uint32 Ogre::BillboardSet::getTypeFlags | ( | void |  | ) | const

virtual

Override to return specific type flag.

Reimplemented from Ogre::MovableObject.

## getUseAccurateFacing()

virtual bool Ogre::BillboardSet::getUseAccurateFacing | ( | void |  | ) | const

virtual

Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction.

Definition at line 717 of file OgreBillboardSet.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() [1/2]

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

virtual inherited

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

Retrieves the custom user value associated with this object.

Definition at line 334 of file OgreMovableObject.h.

## getUserAny() [2/2]

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/4]

UserObjectBindings& Ogre::MovableObject::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 340 of file OgreMovableObject.h.

## getUserObjectBindings() [2/4]

const UserObjectBindings& Ogre::MovableObject::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 346 of file OgreMovableObject.h.

## getUserObjectBindings() [3/4]

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() [4/4]

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.

## getVisibilityFlags()

virtual uint32 Ogre::MovableObject::getVisibilityFlags | ( | void |  | ) | const

virtual inherited

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 431 of file OgreMovableObject.h.

## getVisible()

virtual bool Ogre::MovableObject::getVisible | ( | void |  | ) | const

virtual inherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks
  Returns the value set by MovableObject::setVisible only.

## getWorldBoundingBox()

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox | ( | bool | derive = `false` | ) | const

virtual inherited

Retrieves the axis-aligned bounding box for this object in world coordinates.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

## getWorldBoundingSphere()

virtual const Sphere& Ogre::MovableObject::getWorldBoundingSphere | ( | bool | derive = `false` | ) | const

virtual inherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

## getWorldTransforms()

virtual void Ogre::BillboardSet::getWorldTransforms | ( | Matrix4 * | xform | ) | const

virtual

Overridden from MovableObject.

See also
  MovableObject

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.

## hasEdgeList()

bool Ogre::MovableObject::hasEdgeList | ( | void |  | ) |

virtual inherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 496 of file OgreMovableObject.h.

## increasePool()

virtual void Ogre::BillboardSet::increasePool | ( | size_t | size | ) |

protected virtual

Internal method for increasing pool size.

## initialiseAnimableDictionary()

virtual void Ogre::AnimableObject::initialiseAnimableDictionary | ( | StringVector & |  | ) | const

protected virtual inherited

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Reimplemented in Ogre::Light.

Definition at line 287 of file OgreAnimable.h.

## injectBillboard()

void Ogre::BillboardSet::injectBillboard | ( | const Billboard & | bb | ) |

Define a billboard.

## isAttached()

virtual bool Ogre::MovableObject::isAttached | ( | void |  | ) | const

virtual inherited

Returns true if this object is attached to a SceneNode or TagPoint.

## isDebugDisplayEnabled()

virtual bool Ogre::MovableObject::isDebugDisplayEnabled | ( | void |  | ) | const

virtual inherited

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

## isInScene()

virtual bool Ogre::MovableObject::isInScene | ( | void |  | ) | const

virtual inherited

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

Reimplemented in Ogre::InstancedEntity.

## isParentTagPoint()

virtual bool Ogre::MovableObject::isParentTagPoint | ( |  | ) | const

virtual inherited

Gets whether the parent node is a TagPoint (or a SceneNode)

Definition at line 216 of file OgreMovableObject.h.

## isPointRenderingEnabled()

virtual bool Ogre::BillboardSet::isPointRenderingEnabled | ( | void |  | ) | const

virtual

Returns whether point rendering is enabled.

Definition at line 830 of file OgreBillboardSet.h.

## isVisible()

virtual bool Ogre::MovableObject::isVisible | ( | void |  | ) | const

virtual inherited

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

Remarks
  Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

## notifyBillboardDataChanged()

void Ogre::BillboardSet::notifyBillboardDataChanged | ( | void |  | ) |

When billboard set is not auto updating its GPU buffer, the user is responsible to inform it about any billboard changes in order to reflect them at the rendering stage.

Calling this method will cause GPU buffers update in the next render queue update.

Definition at line 854 of file OgreBillboardSet.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.

## queryLights()

virtual const LightList& Ogre::MovableObject::queryLights | ( | void |  | ) | const

virtual inherited

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

Remarks
  By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

  The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also
  SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

  This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns
  The list of lights use to lighting this object.

## removeBillboard() [1/2]

virtual void Ogre::BillboardSet::removeBillboard | ( | unsigned int | index | ) |

virtual

Removes the billboard at the supplied index.

Note
  This method requires linear time since the billboard list is a linked list.

## removeBillboard() [2/2]

virtual void Ogre::BillboardSet::removeBillboard | ( | Billboard * | pBill | ) |

virtual

Removes a billboard from the set.

Note
  This version is more efficient than removing by index.

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

## removeQueryFlags()

virtual void Ogre::MovableObject::removeQueryFlags | ( | uint32 | flags | ) |

virtual inherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 400 of file OgreMovableObject.h.

## removeVisibilityFlags()

virtual void Ogre::MovableObject::removeVisibilityFlags | ( | uint32 | flags | ) |

virtual inherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 428 of file OgreMovableObject.h.

## setAutoextend()

virtual void Ogre::BillboardSet::setAutoextend | ( | bool | autoextend | ) |

virtual

Tells the set whether to allow automatic extension of the pool of billboards.

Remarks
  A BillboardSet stores a pool of pre-constructed billboards which are used as needed when a new billboard is requested. This allows applications to create / remove billboards efficiently without incurring construction / destruction costs (a must for sets with lots of billboards like particle effects). This method allows you to configure the behaviour when a new billboard is requested but the billboard pool has been exhausted.

  The default behaviour is to allow the pool to extend (typically this allocates double the current pool of billboards when the pool is expended), equivalent to calling this method with autoExtend = true. If you set the parameter to false however, any attempt to create a new billboard when the pool has expired will simply fail silently, returning a null pointer.

Parameters

  autoextend | `true` to double the pool every time it runs out, `false` to fail silently.

## setAutoUpdate()

void Ogre::BillboardSet::setAutoUpdate | ( | bool | autoUpdate | ) |

Set the auto update state of this billboard set.

Remarks
  This methods controls the updating policy of the vertex buffer. By default auto update is true so the vertex buffer is being update every time this billboard set is about to be rendered. This behavior best fit when the billboards of this set changes frequently. When using static or semi-static billboards, it is recommended to set auto update to false. In that case one should call notifyBillboardDataChanged method to reflect changes made to the billboards data.

## setBillboardOrigin()

virtual void Ogre::BillboardSet::setBillboardOrigin | ( | BillboardOrigin | origin | ) |

virtual

Sets the point which acts as the origin point for all billboards in this set.

Remarks
  This setting controls the fine tuning of where a billboard appears in relation to it's position. It could be that a billboard's position represents it's center (e.g. for fireballs), it could mean the center of the bottom edge (e.g. a tree which is positioned on the ground), the top-left corner (e.g. a cursor).

  The default setting is BBO_CENTER.

Parameters

  origin | A member of the BillboardOrigin enum specifying the origin for all the billboards in this set.

Referenced by Ogre::BillboardParticleRenderer::setBillboardOrigin().

## setBillboardRotationType()

virtual void Ogre::BillboardSet::setBillboardRotationType | ( | BillboardRotationType | rotationType | ) |

virtual

Sets billboard rotation type.

Remarks
  This setting controls the billboard rotation type, you can deciding rotate the billboard's vertices around their facing direction or rotate the billboard's texture coordinates.

  The default settings is BBR_TEXCOORD.

Parameters

  rotationType | A member of the BillboardRotationType enum specifying the rotation type for all the billboards in this set.

## setBillboardsInWorldSpace()

virtual void Ogre::BillboardSet::setBillboardsInWorldSpace | ( | bool | ws | ) |

virtual

Sets whether billboards should be treated as being in world space.

Remarks
  This is most useful when you are driving the billboard set from an external data source.

Definition at line 745 of file OgreBillboardSet.h.

## setBillboardType()

virtual void Ogre::BillboardSet::setBillboardType | ( | BillboardType | bbt | ) |

virtual

Sets the type of billboard to render.

Remarks
  The default sort of billboard (BBT_POINT), always has both x and y axes parallel to the camera's local axes. This is fine for 'point' style billboards (e.g. flares, smoke, anything which is symmetrical about a central point) but does not look good for billboards which have an orientation (e.g. an elongated raindrop). In this case, the oriented billboards are more suitable (BBT_ORIENTED_COMMON or BBT_ORIENTED_SELF) since they retain an independent Y axis and only the X axis is generated, perpendicular to both the local Y and the camera Z.

  In some case you might want the billboard has fixed Z axis and doesn't need to face to camera (e.g. an aureola around the player and parallel to the ground). You can use BBT_PERPENDICULAR_SELF which the billboard plane perpendicular to the billboard own direction. Or BBT_PERPENDICULAR_COMMON which the billboard plane perpendicular to the common direction.

Note
  BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON can't guarantee counterclockwise, you might use double-side material (cull_hardware node) to ensure no billboard are culled.

Parameters

  bbt | The type of billboard to render

## setBounds()

void Ogre::BillboardSet::setBounds | ( | const AxisAlignedBox & | box,
|  | Real | radius
| ) |  |

Set the bounds of the BillboardSet.

Remarks
  You may need to call this if you're injecting billboards manually, and you're relying on the BillboardSet to determine culling.

## setCastShadows()

void Ogre::MovableObject::setCastShadows | ( | bool | enabled | ) |

inherited

Sets whether or not this object will cast shadows.

Remarks
  This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note
  This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 519 of file OgreMovableObject.h.

## setCommonDirection()

virtual void Ogre::BillboardSet::setCommonDirection | ( | const Vector3 & | vec | ) |

virtual

Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPENDICULAR_COMMON.

Remarks
  Use BBT_ORIENTED_COMMON when you want oriented billboards but you know they are always going to be oriented the same way (e.g. rain in calm weather). It is faster for the system to calculate the billboard vertices if they have a common direction.

  The common direction also use in BBT_PERPENDICULAR_COMMON, in this case the common direction treat as Z axis, and an additional common up-vector was use to determine billboard X and Y axis.

See also
  setCommonUpVector

Parameters

  vec | The direction for all billboards.

Note
  The direction are use as is, never normalised in internal, user are supposed to normalise it himself.

## setCommonUpVector()

virtual void Ogre::BillboardSet::setCommonUpVector | ( | const Vector3 & | vec | ) |

virtual

Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON.

Remarks
  Use BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON when you want oriented billboards perpendicular to specify direction vector (or, Z axis), and doesn't face to camera. In this case, we need an additional up-vector to determine the billboard X and Y axis. The generated billboard plane and X-axis guarantee perpendicular to specify direction.

See also
  setCommonDirection

  The specify direction is billboard own direction when billboard type is BBT_PERPENDICULAR_SELF, and it's shared common direction when billboard type is BBT_PERPENDICULAR_COMMON.

Parameters

  vec | The up-vector for all billboards.

Note
  The up-vector are use as is, never normalised in internal, user are supposed to normalise it himself.

## setCullIndividually()

virtual void Ogre::BillboardSet::setCullIndividually | ( | bool | cullIndividual | ) |

virtual

Sets whether culling tests billboards in this individually as well as in a group.

Remarks
  Billboard sets are always culled as a whole group, based on a bounding box which encloses all billboards in the set. For fairly localised sets, this is enough. However, you can optionally tell the set to also cull individual billboards in the set, i.e. to test each individual billboard before rendering. The default is not to do this.

  This is useful when you have a large, fairly distributed set of billboards, like maybe trees on a landscape. You probably still want to group them into more than one set (maybe one set per section of landscape), which will be culled coarsely, but you also want to cull the billboards individually because they are spread out. Whilst you could have lots of single-tree sets which are culled separately, this would be inefficient to render because each tree would be issued as it's own rendering operation.

  By calling this method with a parameter of true, you can have large billboard sets which are spaced out and so get the benefit of batch rendering and coarse culling, but also have fine-grained culling so unnecessary rendering is avoided.

Parameters

  cullIndividual | If true, each billboard is tested before being sent to the pipeline as well as the whole set having to pass the coarse group bounding test.

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

## setDebugDisplayEnabled()

virtual void Ogre::MovableObject::setDebugDisplayEnabled | ( | bool | enabled | ) |

virtual inherited

Sets whether or not the debug display of this object is enabled.

Remarks
  Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 563 of file OgreMovableObject.h.

## setDefaultDimensions()

virtual void Ogre::BillboardSet::setDefaultDimensions | ( | Real | width,
|  | Real | height
| ) |  |

virtual

Sets the default dimensions of the billboards in this set.

Remarks
  All billboards in a set are created with these default dimensions. The set will render most efficiently if all the billboards in the set are the default size. It is possible to alter the size of individual billboards at the expense of extra calculation. See the Billboard class for more info.

Parameters

  width | The new default width for the billboards in this set.
  height | The new default height for the billboards in this set.

## setDefaultHeight()

virtual void Ogre::BillboardSet::setDefaultHeight | ( | Real | height | ) |

virtual

See setDefaultDimensions - this sets 1 component individually.

## setDefaultQueryFlags()

static void Ogre::MovableObject::setDefaultQueryFlags | ( | uint32 | flags | ) |

static inherited

Set the default query flags for all future MovableObject instances.

Definition at line 407 of file OgreMovableObject.h.

## setDefaultVisibilityFlags()

static void Ogre::MovableObject::setDefaultVisibilityFlags | ( | uint32 | flags | ) |

static inherited

Set the default visibility flags for all future MovableObject instances.

Definition at line 435 of file OgreMovableObject.h.

## setDefaultWidth()

virtual void Ogre::BillboardSet::setDefaultWidth | ( | Real | width | ) |

virtual

See setDefaultDimensions - this sets 1 component individually.

## setLightMask()

virtual void Ogre::MovableObject::setLightMask | ( | uint32 | lightMask | ) |

virtual inherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks
  This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

## setListener()

virtual void Ogre::MovableObject::setListener | ( | Listener * | listener | ) |

virtual inherited

Sets a listener for this object.

Remarks
  Note for size and performance reasons only one listener per object is allowed.

Definition at line 446 of file OgreMovableObject.h.

## setMaterial()

virtual void Ogre::BillboardSet::setMaterial | ( | const MaterialPtr & | material | ) |

virtual

Sets the name of the material to be used for this billboard set.

Parameters

  material | The new material to use for this set.

## setMaterialName()

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

virtual

Sets the name of the material to be used for this billboard set.

Parameters

  name | The new name of the material to use for this set.

## setPointRenderingEnabled()

virtual void Ogre::BillboardSet::setPointRenderingEnabled | ( | bool | enabled | ) |

virtual

Set whether or not the BillboardSet will use point rendering rather than manually generated quads.

Remarks
  By default a billboardset is rendered by generating geometry for a textured quad in memory, taking into account the size and orientation settings, and uploading it to the video card. The alternative is to use hardware point rendering, which means that only one position needs to be sent per billboard rather than 4 and the hardware sorts out how this is rendered based on the render state.

  Using point rendering is faster than generating quads manually, but is more restrictive. The following restrictions apply:
  - Only the BBT_POINT type is supported
  - Size and appearance of each billboard is controlled by the material (Pass::setPointSize, Pass::setPointSizeAttenuation, Pass::setPointSpritesEnabled)
  - Per-billboard size is not supported (stems from the above)
  - Per-billboard rotation is not supported, this can only be controlled through texture unit rotation
  - Only BBO_CENTER origin is supported
  - Per-billboard texture coordinates are not supported

  You will almost certainly want to enable in your material pass both point attenuation and point sprites if you use this option.

Parameters

  enabled | True to enable point rendering, false otherwise

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

## setPoolSize()

virtual void Ogre::BillboardSet::setPoolSize | ( | size_t | size | ) |

virtual

Adjusts the size of the pool of billboards available in this set.

Remarks
  See the BillboardSet::setAutoextend method for full details of the billboard pool. This method adjusts the preallocated size of the pool. If you try to reduce the size of the pool, the set has the option of ignoring you if too many billboards are already in use. Bear in mind that calling this method will incur significant construction / destruction calls so should be avoided in time-critical code. The same goes for auto-extension, try to avoid it by estimating the pool size correctly up-front.

Parameters

  size | The new size for the pool.

## setQueryFlags()

virtual void Ogre::MovableObject::setQueryFlags | ( | uint32 | flags | ) |

virtual inherited

Sets the query flags for this object.

Remarks
  When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

Definition at line 392 of file OgreMovableObject.h.

## setRenderingDistance()

virtual void Ogre::MovableObject::setRenderingDistance | ( | Real | dist | ) |

virtual inherited

Sets the distance at which the object is no longer rendered.

Note
  Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters

  dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 299 of file OgreMovableObject.h.

## setRenderingMinPixelSize()

virtual void Ogre::MovableObject::setRenderingMinPixelSize | ( | Real | pixelSize | ) |

virtual inherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note
  Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters

  pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 312 of file OgreMovableObject.h.

## setRenderQueueGroup()

virtual void Ogre::MovableObject::setRenderQueueGroup | ( | uint8 | queueID | ) |

virtual inherited

Sets the render queue group this entity will be rendered through.

Remarks
  Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

  See RenderQueue for more details.

Parameters

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

## setRenderQueueGroupAndPriority()

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority | ( | uint8 | queueID,
|  | ushort | priority
| ) |  |

virtual inherited

Sets the render queue group and group priority this entity will be rendered through.

Remarks
  Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

  See RenderQueue for more details.

Parameters

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
  priority | The priority within a group to use.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

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

## setSortingEnabled()

virtual void Ogre::BillboardSet::setSortingEnabled | ( | bool | sortenable | ) |

virtual

Enables sorting for this BillboardSet.

(default: off)

Parameters

  sortenable | true to sort the billboards according to their distance to the camera

## setTextureCoords()

virtual void Ogre::BillboardSet::setTextureCoords | ( | Ogre::FloatRect const * | coords,
|  | uint16 | numCoords
| ) |  |

virtual

BillboardSet can use custom texture coordinates for various billboards.

This is useful for selecting one of many particle images out of a tiled texture sheet, or doing flipbook animation within a single texture.

  The generic functionality is setTextureCoords(), which will copy the texture coordinate rects you supply into internal storage for the billboard set. If your texture sheet is a square grid, you can also use setTextureStacksAndSlices() for more convenience, which will construct the set of texture coordinates for you.

  When a Billboard is created, it can be assigned a texture coordinate set from within the sets you specify (that set can also be re-specified later). When drawn, the billboard will use those texture coordinates, rather than the full 0-1 range.

Parameters

  coords | is a vector of texture coordinates (in UV space) to choose from for each billboard created in the set.
  numCoords | is how many such coordinate rectangles there are to choose from.

Remarks
  Set 'coords' to 0 and/or 'numCoords' to 0 to reset the texture coord rects to the initial set of a single rectangle spanning 0 through 1 in both U and V (i e, the entire texture).

See also
  BillboardSet::setTextureStacksAndSlices() Billboard::setTexcoordIndex()

## setTextureStacksAndSlices()

virtual void Ogre::BillboardSet::setTextureStacksAndSlices | ( | uchar | stacks,
|  | uchar | slices
| ) |  |

virtual

setTextureStacksAndSlices() will generate texture coordinate rects as if the texture for the billboard set contained 'stacks' rows of 'slices' images each, all equal size.

Thus, if the texture size is 512x512 and 'stacks' is 4 and 'slices' is 8, each sub-rectangle of the texture would be 128 texels tall and 64 texels wide.

Remarks
  This function is short-hand for creating a regular set and calling setTextureCoords() yourself. The numbering used for Billboard::setTexcoordIndex() counts first across, then down, so top-left is 0, the one to the right of that is 1, and the lower-right is stacks*slices-1.

See also
  BillboardSet::setTextureCoords()

## setUseAccurateFacing()

virtual void Ogre::BillboardSet::setUseAccurateFacing | ( | bool | acc | ) |

virtual

Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction.

Remarks
  By default, the axes for all billboards are calculated using the camera's view direction, not the vector from the camera position to the billboard. The former is faster, and most of the time the difference is not noticeable. However for some purposes (e.g. very large, static billboards) the changing billboard orientation when rotating the camera can be off putting, therefore you can enable this option to use a more expensive, but more accurate version.

Parameters

  acc | True to use the slower but more accurate model. Default is false.

Definition at line 712 of file OgreBillboardSet.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() [1/2]

virtual OGRE_DEPRECATED void Ogre::MovableObject::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 MovableObject. This can be a pointer back to one of your own classes for instance.

Definition at line 329 of file OgreMovableObject.h.

## setUserAny() [2/2]

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().

## setVisibilityFlags()

virtual void Ogre::MovableObject::setVisibilityFlags | ( | uint32 | flags | ) |

virtual inherited

Sets the visibility flags for this object.

Remarks
  As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

Definition at line 420 of file OgreMovableObject.h.

## setVisible()

virtual void Ogre::MovableObject::setVisible | ( | bool | visible | ) |

virtual inherited

Tells this object whether to be visible or not, if it has a renderable component.

Note
  An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.

Referenced by Ogre::Volume::Chunk::setChunkVisible().

## updateEdgeListLightFacing()

virtual void Ogre::ShadowCaster::updateEdgeListLightFacing | ( | EdgeData * | edgeData,
|  | const Vector4 & | lightPos
| ) |  |

protected virtual inherited

Tells the caster to perform the tasks necessary to update the edge data's light listing.

Can be overridden if the subclass needs to do additional things.

Parameters

  edgeData | The edge information to update.
  lightPos | 4D vector representing the light, a directional light has w=0.0.

## visitRenderables()

void Ogre::BillboardSet::visitRenderables | ( | Renderable::Visitor * | visitor,
|  | bool | debugRenderables = `false`
| ) |  |

virtual

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters

  visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
  debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

## Member Data Documentation

## mAABB

AxisAlignedBox Ogre::BillboardSet::mAABB

protected

Bounds of all billboards in this set.

Definition at line 118 of file OgreBillboardSet.h.

## mAccurateFacing

bool Ogre::BillboardSet::mAccurateFacing

protected

Use 'true' billboard to cam position facing, rather than camera direcion.

Definition at line 147 of file OgreBillboardSet.h.

## mActiveBillboards

ActiveBillboardList Ogre::BillboardSet::mActiveBillboards

protected

Active billboard list.

Remarks
  This is a linked list of pointers to billboards in the billboard pool.

  This allows very fast insertions and deletions from anywhere in the list to activate / deactivate billboards (required for particle systems etc.) as well as reuse of Billboard instances in the pool without construction & destruction which avoids memory thrashing.

Definition at line 164 of file OgreBillboardSet.h.

## mAllDefaultRotation

bool Ogre::BillboardSet::mAllDefaultRotation

protected

Definition at line 149 of file OgreBillboardSet.h.

## mAllDefaultSize

bool Ogre::BillboardSet::mAllDefaultSize

protected

True if no billboards in this set have been resized - greater efficiency.

Definition at line 138 of file OgreBillboardSet.h.

## mAutoExtendPool

bool Ogre::BillboardSet::mAutoExtendPool

protected

Flag indicating whether to autoextend pool.

Definition at line 141 of file OgreBillboardSet.h.

## mAutoUpdate

bool Ogre::BillboardSet::mAutoUpdate

private

Tell if vertex buffer should be update automatically.

Definition at line 300 of file OgreBillboardSet.h.

## mBeyondFarDistance

bool Ogre::MovableObject::mBeyondFarDistance

protected inherited

Hidden because of distance?

Definition at line 128 of file OgreMovableObject.h.

## mBillboardDataChanged

bool Ogre::BillboardSet::mBillboardDataChanged

private

True if the billboard data changed. Will cause vertex buffer update.

Definition at line 302 of file OgreBillboardSet.h.

## mBillboardPool

BillboardPool Ogre::BillboardSet::mBillboardPool

protected

Pool of billboard instances for use and reuse in the active billboard list.

Remarks
  This vector will be preallocated with the estimated size of the set,and will extend as required.

Definition at line 179 of file OgreBillboardSet.h.

## mBillboardType

BillboardType Ogre::BillboardSet::mBillboardType

protected

The type of billboard to render.

Definition at line 214 of file OgreBillboardSet.h.

## mBottomOff

Real Ogre::BillboardSet::mBottomOff

protected

Definition at line 194 of file OgreBillboardSet.h.

## mBoundingRadius

Real Ogre::BillboardSet::mBoundingRadius

protected

Bounding radius.

Definition at line 120 of file OgreBillboardSet.h.

## mBuffersCreated

bool Ogre::BillboardSet::mBuffersCreated

private

Flag indicating whether the HW buffers have been created.

Definition at line 294 of file OgreBillboardSet.h.

## mCamDir

Vector3 Ogre::BillboardSet::mCamDir

protected

Camera direction in billboard space.

Definition at line 198 of file OgreBillboardSet.h.

## mCamPos

Vector3 Ogre::BillboardSet::mCamPos

protected

Camera position in billboard space.

Definition at line 202 of file OgreBillboardSet.h.

## mCamQ

Quaternion Ogre::BillboardSet::mCamQ

protected

Camera orientation in billboard space.

Definition at line 200 of file OgreBillboardSet.h.

## mCamX

Vector3 Ogre::BillboardSet::mCamX

protected

Camera axes in billboard space.

Definition at line 196 of file OgreBillboardSet.h.

## mCamY

Vector3 Ogre::BillboardSet::mCamY

protected

Definition at line 196 of file OgreBillboardSet.h.

## mCastShadows

bool Ogre::MovableObject::mCastShadows

protected inherited

Does this object cast shadows?

Definition at line 150 of file OgreMovableObject.h.

## mCommonDirection

Vector3 Ogre::BillboardSet::mCommonDirection

protected

Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON.

Definition at line 217 of file OgreBillboardSet.h.

## mCommonUpVector

Vector3 Ogre::BillboardSet::mCommonUpVector

protected

Common up-vector for billboards of type BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON.

Definition at line 219 of file OgreBillboardSet.h.

## mCreator

MovableObjectFactory* Ogre::MovableObject::mCreator

protected inherited

Creator of this object (if created by a factory)

Definition at line 112 of file OgreMovableObject.h.

## mCullIndividual

bool Ogre::BillboardSet::mCullIndividual

protected

Flag indicating whether each billboard should be culled separately (default: false)

Definition at line 208 of file OgreBillboardSet.h.

## mCurrentCamera

Camera* Ogre::BillboardSet::mCurrentCamera

protected

Current camera.

Definition at line 192 of file OgreBillboardSet.h.

## mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters

protected inherited

Definition at line 415 of file OgreRenderable.h.

## mDebugDisplay

bool Ogre::MovableObject::mDebugDisplay

protected inherited

Is debug display enabled?

Definition at line 121 of file OgreMovableObject.h.

## mDefaultHeight

Real Ogre::BillboardSet::mDefaultHeight

protected

Default height of each billboard.

Definition at line 130 of file OgreBillboardSet.h.

## mDefaultWidth

Real Ogre::BillboardSet::mDefaultWidth

protected

Default width of each billboard.

Definition at line 128 of file OgreBillboardSet.h.

## mExternalData

bool Ogre::BillboardSet::mExternalData

private

Is external billboard data in use?

Definition at line 298 of file OgreBillboardSet.h.

## mFreeBillboards

FreeBillboardList Ogre::BillboardSet::mFreeBillboards

protected

Free billboard queue.

Remarks
  This contains a list of the billboards free for use as new instances as required by the set. Billboard instances are preconstructed up to the estimated size in the mBillboardPool vector and are referenced on this deque at startup. As they get used this deque reduces, as they get released back to to the set they get added back to the deque.

Definition at line 173 of file OgreBillboardSet.h.

## mIndexData

IndexData* Ogre::BillboardSet::mIndexData

protected

The vertex index data for all billboards in this set (1 set only)

Definition at line 205 of file OgreBillboardSet.h.

## mLeftOff

Real Ogre::BillboardSet::mLeftOff

protected

Parametric offsets of origin.

Definition at line 194 of file OgreBillboardSet.h.

## mLightList

LightList Ogre::MovableObject::mLightList

mutable protected inherited

List of lights for this object.

Definition at line 158 of file OgreMovableObject.h.

## mLightListUpdated

ulong Ogre::MovableObject::mLightListUpdated

mutable protected inherited

The last frame that this light list was updated in.

Definition at line 160 of file OgreMovableObject.h.

## mLightMask

uint32 Ogre::MovableObject::mLightMask

protected inherited

the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable

Definition at line 163 of file OgreMovableObject.h.

## mListener

Listener* Ogre::MovableObject::mListener

protected inherited

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Definition at line 155 of file OgreMovableObject.h.

## mLockPtr

float* Ogre::BillboardSet::mLockPtr

protected

Locked pointer to buffer.

Definition at line 186 of file OgreBillboardSet.h.

## mMainBuf

HardwareVertexBufferSharedPtr Ogre::BillboardSet::mMainBuf

protected

Shortcut to main buffer (positions, colours, texture coords)

Definition at line 184 of file OgreBillboardSet.h.

## mManager

SceneManager* Ogre::MovableObject::mManager

protected inherited

SceneManager holding this object (if applicable)

Definition at line 114 of file OgreMovableObject.h.

## mMaterial

MaterialPtr Ogre::BillboardSet::mMaterial

protected

Pointer to the material to use.

Definition at line 135 of file OgreBillboardSet.h.

## mMaterialName

String Ogre::BillboardSet::mMaterialName

protected

Name of the material to use.

Definition at line 133 of file OgreBillboardSet.h.

## mMinPixelSize

Real Ogre::MovableObject::mMinPixelSize

protected inherited

Definition at line 126 of file OgreMovableObject.h.

## mName

String Ogre::MovableObject::mName

protected inherited

Name of this object.

Definition at line 110 of file OgreMovableObject.h.

## mNumVisibleBillboards

unsigned short Ogre::BillboardSet::mNumVisibleBillboards

protected

Number of visible billboards (will be == getNumBillboards if mCullIndividual == false)

Definition at line 225 of file OgreBillboardSet.h.

## mOriginType

BillboardOrigin Ogre::BillboardSet::mOriginType

protected

Origin of each billboard.

Definition at line 123 of file OgreBillboardSet.h.

## mParentIsTagPoint

bool Ogre::MovableObject::mParentIsTagPoint

protected inherited

Definition at line 117 of file OgreMovableObject.h.

## mParentNode

Node* Ogre::MovableObject::mParentNode

protected inherited

node to which this object is attached

Definition at line 116 of file OgreMovableObject.h.

## mPointRendering

bool Ogre::BillboardSet::mPointRendering

protected

Use point rendering?

Definition at line 288 of file OgreBillboardSet.h.

## mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable

protected inherited

Definition at line 416 of file OgreRenderable.h.

## mPoolSize

size_t Ogre::BillboardSet::mPoolSize

private

The number of billboard in the pool.

Definition at line 296 of file OgreBillboardSet.h.

## mQueryFlags

uint32 Ogre::MovableObject::mQueryFlags

protected inherited

Flags determining whether this object is included / excluded from scene queries.

Definition at line 140 of file OgreMovableObject.h.

## mRadixSorter

RadixSort<ActiveBillboardList, Billboard*, float> Ogre::BillboardSet::mRadixSorter

static protected

Definition at line 285 of file OgreBillboardSet.h.

## mRenderingDisabled

bool Ogre::MovableObject::mRenderingDisabled

protected inherited

Does rendering this object disabled by listener?

Definition at line 153 of file OgreMovableObject.h.

## mRenderQueueID

uint8 Ogre::MovableObject::mRenderQueueID

protected inherited

The render queue to use when rendering this object.

Definition at line 132 of file OgreMovableObject.h.

## mRenderQueueIDSet

bool Ogre::MovableObject::mRenderQueueIDSet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 134 of file OgreMovableObject.h.

## mRenderQueuePriority

ushort Ogre::MovableObject::mRenderQueuePriority

protected inherited

The render queue group to use when rendering this object.

Definition at line 136 of file OgreMovableObject.h.

## mRenderQueuePrioritySet

bool Ogre::MovableObject::mRenderQueuePrioritySet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 138 of file OgreMovableObject.h.

## mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutable protected inherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

## mRightOff

Real Ogre::BillboardSet::mRightOff

protected

Definition at line 194 of file OgreBillboardSet.h.

## mRotationType

BillboardRotationType Ogre::BillboardSet::mRotationType

protected

Rotation type of each billboard.

Definition at line 125 of file OgreBillboardSet.h.

## msAnimableDictionary

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary

static protected inherited

Static map of class name to list of animable value names.

Definition at line 243 of file OgreAnimable.h.

## msDefaultQueryFlags

uint32 Ogre::MovableObject::msDefaultQueryFlags

static protected inherited

Default query flags.

Definition at line 167 of file OgreMovableObject.h.

## msDefaultVisibilityFlags

uint32 Ogre::MovableObject::msDefaultVisibilityFlags

static protected inherited

Default visibility flags.

Definition at line 169 of file OgreMovableObject.h.

## mSortingEnabled

bool Ogre::BillboardSet::mSortingEnabled

protected

Flag indicating whether the billboards has to be sorted.

Definition at line 144 of file OgreBillboardSet.h.

## mSquaredUpperDistance

Real Ogre::MovableObject::mSquaredUpperDistance

protected inherited

Definition at line 124 of file OgreMovableObject.h.

## mTextureCoords

TextureCoordSets Ogre::BillboardSet::mTextureCoords

protected

Definition at line 211 of file OgreBillboardSet.h.

## mTopOff

Real Ogre::BillboardSet::mTopOff

protected

Definition at line 194 of file OgreBillboardSet.h.

## mUpperDistance

Real Ogre::MovableObject::mUpperDistance

protected inherited

Upper distance to still render.

Definition at line 123 of file OgreMovableObject.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 [1/2]

UserObjectBindings Ogre::MovableObject::mUserObjectBindings

protected inherited

User objects binding.

Definition at line 130 of file OgreMovableObject.h.

## mUserObjectBindings [2/2]

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protected inherited

Definition at line 419 of file OgreRenderable.h.

## mVertexData

VertexData* Ogre::BillboardSet::mVertexData

protected

The vertex position data for all billboards in this set.

Definition at line 182 of file OgreBillboardSet.h.

## mVisibilityFlags

uint32 Ogre::MovableObject::mVisibilityFlags

protected inherited

Flags determining whether this object is visible (compared to SceneManager mask)

Definition at line 142 of file OgreMovableObject.h.

## mVisible

bool Ogre::MovableObject::mVisible

protected inherited

Is this object visible?

Definition at line 119 of file OgreMovableObject.h.

## mVOffset

Vector3 Ogre::BillboardSet::mVOffset[4]

protected

Boundary offsets based on origin and camera orientation Vector3 vLeftOff, vRightOff, vTopOff, vBottomOff; Final vertex offsets, used where sizes all default to save calcs.

Definition at line 190 of file OgreBillboardSet.h.

## mWorldAABB

AxisAlignedBox Ogre::MovableObject::mWorldAABB

mutable protected inherited

Cached world AABB of this object.

Definition at line 144 of file OgreMovableObject.h.

## mWorldBoundingSphere

Sphere Ogre::MovableObject::mWorldBoundingSphere

mutable protected inherited

Definition at line 146 of file OgreMovableObject.h.

## mWorldDarkCapBounds

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds

mutable protected inherited

World space AABB of this object's dark cap.

Definition at line 148 of file OgreMovableObject.h.

## mWorldSpace

bool Ogre::BillboardSet::mWorldSpace

protected

Definition at line 150 of file OgreBillboardSet.h.

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

- OgreBillboardSet.h

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