OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::BillboardSet Class Reference

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:
+ Collaboration diagram for Ogre::BillboardSet:

Classes

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

Public Types

typedef FastArray
< MovableObject * > 
MovableObjectArray
 SceneManager::cullFrustum More...
 

Public Member Functions

 BillboardSet (IdType id, ObjectMemoryManager *objectMemoryManager, unsigned int poolSize=20, bool externalDataSource=false, uint8 renderQueueId=RENDER_QUEUE_MAIN)
 Usual constructor - this is called by the SceneManager. More...
 
virtual ~BillboardSet ()
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns 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)
 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 _notifyCurrentCamera (Camera *cam)
 Overridden from MovableObject. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 Node::_callMemoryChangeListeners More...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
void _setCachedAabbOutOfDate (void)
 
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, Camera *camera, const Camera *lodCamera)
 Overridden from MovableObject. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
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...
 
BillboardcreateBillboard (const Vector3 &position, const ColourValue &colour=ColourValue::White)
 Creates a new billboard and adds it to this set. More...
 
BillboardcreateBillboard (Real x, Real y, Real z, const ColourValue &colour=ColourValue::White)
 Creates a new billboard and adds it to this set. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode if attached. More...
 
void endBillboards (void)
 Finish defining billboards. More...
 
const StringVectorgetAnimableValueNames (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 BillboardgetBillboard (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...
 
bool getBillboardsInWorldSpace ()
 Gets whether billboards are treated as being in world space. More...
 
virtual BillboardType getBillboardType (void) const
 Returns the billboard type in use. 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 Vector3getCommonDirection (void) const
 Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More...
 
virtual const Vector3getCommonUpVector (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 FastArray< unsigned char > & getCurrentMaterialLod (void) const
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. 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...
 
uint32 getHlmsCasterHash (void) const
 
uint32 getHlmsHash (void) const
 
IdType getId () const
 Get the unique id of this object. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
virtual const MaterialPtrgetMaterial (void) const
 Overridden from MovableObject. More...
 
virtual const StringgetMaterialName (void) const
 Sets the name of the material to be used for this billboard set. More...
 
virtual const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
const StringgetName (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...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
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...
 
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...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
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...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Gets RenderSystem private data. 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 TechniquegetTechnique (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...
 
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 AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). 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...
 
void injectBillboard (const Billboard &bb, const Camera *camera)
 Define a billboard. More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isCachedAabbOutOfDate () const
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isPointRenderingEnabled (void) const
 Returns whether point rendering is enabled. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. setStatic. More...
 
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)
 
bool operator() (const IdObject *left, const IdObject *right)
 
bool operator() (const IdObject &left, const IdObject &right)
 
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...
 
const LightListqueryLights (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...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
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 Aabb &aabb, 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...
 
void setHlms (Hlms *hlms, const HlmsParamVec &params)
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box 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...
 
void setName (const String &name)
 Sets a custom name for this node. 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...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
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...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. 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)
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
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 buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 SceneManager::buildLightList More...
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Frustum *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 SceneManager::cullLights & 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...
 
static void updateAllBounds (const size_t numNodes, ObjectData t)
 SceneManager::updateAllBounds More...
 

Public Attributes

const FastArray< Realc_DefaultLodMesh
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). 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

StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
void _setId (IdType newId)
 In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private). More...
 
bool billboardVisible (const 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...
 
void genBillboardAxes (Vector3 *pX, Vector3 *pY, const Billboard *pBill=0)
 Internal method for generating billboard corners. 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 StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. 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...
 
Aabb updateSingleWorldAabb ()
 
float updateSingleWorldRadius ()
 

Protected Attributes

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...
 
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
 
bool mCachedAabbOutOfDate
 
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
 
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...
 
bool mCullIndividual
 Flag indicating whether each billboard should be culled separately (default: false) More...
 
FastArray< unsigned char > mCurrentMaterialLod
 
unsigned char mCurrentMeshLod
 
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...
 
uint32 mHlmsCasterHash
 
uint32 mHlmsHash
 
IndexDatamIndexData
 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...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. More...
 
float * mLockPtr
 Locked pointer to buffer. More...
 
FastArray< FastArray< Real >
const * > 
mLodMaterial
 
FastArray< Real > const * mLodMesh
 
HardwareVertexBufferSharedPtr mMainBuf
 Shortcut to main buffer (positions, colours, texture coords) More...
 
SceneManagermManager
 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
 Minimum pixel size to still render. More...
 
String mName
 Friendly name of this object, can be empty. More...
 
unsigned short mNumVisibleBillboards
 Number of visible billboards (will be == getNumBillboards if mCullIndividual == false) More...
 
ObjectData mObjectData
 All the object data needed in SoA form. More...
 
ObjectMemoryManagermObjectMemoryManager
 The memory manager used to allocate the ObjectData. More...
 
BillboardOrigin mOriginType
 Origin of each billboard. More...
 
NodemParentNode
 Node to which this object is attached. More...
 
bool mPointRendering
 Use point rendering? More...
 
bool mPolygonModeOverrideable
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
RenderSystemDatamRenderSystemData
 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...
 
TextureCoordSets mTextureCoords
 
Real mTopOff
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 
UserObjectBindings mUserObjectBindings
 
VertexDatamVertexData
 The vertex position data for all billboards in this set. 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...
 
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 111 of file OgreBillboardSet.h.

Member Typedef Documentation

Definition at line 144 of file OgreBillboardSet.h.

Definition at line 237 of file OgreAnimable.h.

Definition at line 146 of file OgreBillboardSet.h.

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

Definition at line 422 of file OgreRenderable.h.

Definition at line 145 of file OgreBillboardSet.h.

SceneManager::cullFrustum

Remarks
We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time
Parameters
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Definition at line 244 of file OgreMovableObject.h.

Definition at line 200 of file OgreBillboardSet.h.

Constructor & Destructor Documentation

Ogre::BillboardSet::BillboardSet ( IdType  id,
ObjectMemoryManager objectMemoryManager,
unsigned int  poolSize = 20,
bool  externalDataSource = false,
uint8  renderQueueId = RENDER_QUEUE_MAIN 
)

Usual constructor - this is called by the SceneManager.

Parameters
nameThe name to give the billboard set (must be unique)
poolSizeThe 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.
externalDataSourceIf 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
virtual Ogre::BillboardSet::~BillboardSet ( )
virtual

Member Function Documentation

void Ogre::BillboardSet::_createBuffers ( void  )
private

Internal method creates vertex and index buffers.

void Ogre::BillboardSet::_destroyBuffers ( void  )
private

Internal method destroys vertex and index buffers.

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

Get an updateable reference to animable value list.

Definition at line 263 of file OgreAnimable.h.

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

LightList* Ogre::MovableObject::_getLightList ( )
inlineinherited

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 534 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlineinherited

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

Definition at line 160 of file OgreMovableObject.h.

ObjectData& Ogre::MovableObject::_getObjectData ( )
inlineinherited

Returns a direct access to the ObjectData state.

Definition at line 387 of file OgreMovableObject.h.

const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
inherited

Returns the full transformation of the parent sceneNode or the attachingPoint node.

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

Gets the sort mode of this billboard set.

virtual void Ogre::MovableObject::_notifyAttached ( Node parent)
virtualinherited

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

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

Referenced by Ogre::PortalBase::_notifyAttached().

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

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

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

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

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

Overridden from MovableObject.

See also
MovableObject
void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlineinherited

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

Definition at line 158 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyParentNodeMemoryChanged ( void  )
inlinevirtualinherited

Node::_callMemoryChangeListeners

Reimplemented in Ogre::InstancedEntity.

Definition at line 187 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyStaticDirty ( void  ) const
inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also
SceneManager::notifyStaticDirty

Reimplemented in Ogre::InstancedEntity.

Definition at line 212 of file OgreMovableObject.h.

void Ogre::MovableObject::_setCachedAabbOutOfDate ( void  )
inlineinherited

Definition at line 586 of file OgreMovableObject.h.

void Ogre::IdObject::_setId ( IdType  newId)
inlineprotectedinherited

In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private).

Definition at line 63 of file OgreId.h.

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

Sort the billboard set.

Only called when enabled via setSortingEnabled

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

Update the bounds of the billboardset.

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
inlinevirtualinherited

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
constantEntryThe auto constant entry referring to the parameter being updated
paramsThe parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 308 of file OgreRenderable.h.

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

virtual void Ogre::BillboardSet::_updateRenderQueue ( RenderQueue queue,
Camera camera,
const Camera lodCamera 
)
virtual

Overridden from MovableObject.

See also
MovableObject

Implements Ogre::MovableObject.

void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlineinherited

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

void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlineinherited

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

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

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

Parameters
numBillboardsIf you know the number of billboards you will be issuing, state it here to make the update more efficient.
bool Ogre::BillboardSet::billboardVisible ( const Camera cam,
const Billboard bill 
)
inlineprotected

Internal method for culling individual billboards.

static void Ogre::MovableObject::buildLightList ( const size_t  numNodes,
ObjectData  t,
const LightListInfo globalLightList 
)
staticinherited

SceneManager::buildLightList

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Parameters
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA
static void Ogre::MovableObject::calculateCastersBox ( const size_t  numNodes,
ObjectData  t,
uint32  sceneVisibilityFlags,
AxisAlignedBox outBox 
)
staticinherited
virtual void Ogre::BillboardSet::clear ( )
virtual

Empties this set of all billboards.

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

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

Definition at line 250 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String valueName)
inlinevirtualinherited

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 316 of file OgreAnimable.h.

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

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
positionThe position of the new billboard realtive to the certer of the set
colourOptional 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
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
xThe x position of the new billboard relative to the center of the set
yThe y position of the new billboard relative to the center of the set
zThe z position of the new billboard relative to the center of the set
colourOptional 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
static void Ogre::MovableObject::cullFrustum ( const size_t  numNodes,
ObjectData  t,
const Frustum frustum,
uint32  sceneVisibilityFlags,
MovableObjectArray outCulledObjects,
const Camera lodCamera 
)
staticinherited
static void Ogre::MovableObject::cullLights ( const size_t  numNodes,
ObjectData  t,
LightListInfo outGlobalLightList,
const FrustumVec frustums,
const FrustumVec cubemapFrustums 
)
staticinherited

SceneManager::cullLights &

See also
MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList
Remarks
We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.
Parameters
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn array of all frustums that are used at least once as cubemaps ( SceneManager::createCamera)
void Ogre::MovableObject::detachFromParent ( void  )
inherited

Detaches an object from a parent SceneNode if attached.

void Ogre::BillboardSet::endBillboards ( void  )

Finish defining billboards.

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
void Ogre::BillboardSet::genVertices ( const Vector3 *const  offsets,
const Billboard pBillboard 
)
protected

Internal method for generating vertex data.

Parameters
offsetsArray of 4 Vector3 offsets
pBillboardReference to billboard
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.
virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

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

Definition at line 245 of file OgreAnimable.h.

References Ogre::BLANKSTRING.

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

Gets a list of animable value names for this object.

Definition at line 291 of file OgreAnimable.h.

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

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

Returns true if the billboard pool automatically extends.

See also
BillboardSet::setAutoextend
bool Ogre::BillboardSet::getAutoUpdate ( void  ) const
inline

Return the auto update state of this billboard set.

Definition at line 828 of file OgreBillboardSet.h.

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
indexThe index of the billboard that is requested.
Returns
On success, a valid pointer to the requested billboard is returned.
On failure, NULL is returned.
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.
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.
bool Ogre::BillboardSet::getBillboardsInWorldSpace ( )
inline

Gets whether billboards are treated as being in world space.

Definition at line 728 of file OgreBillboardSet.h.

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

Returns the billboard type in use.

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

Returns whether shadow casting is enabled for this object.

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

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

Definition at line 225 of file OgreRenderable.h.

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

Gets the common direction for all billboards (BBT_ORIENTED_COMMON)

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

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

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

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

const FastArray<unsigned char>& Ogre::MovableObject::getCurrentMaterialLod ( void  ) const
inlineinherited

Definition at line 536 of file OgreMovableObject.h.

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

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

Parameters
indexIndex of the parameter to retrieve.
See also
setCustomParameter for full details.

Definition at line 269 of file OgreRenderable.h.

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

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

See setDefaultDimensions - this gets 1 component individually.

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

Get the default query flags for all future MovableObject instances.

Definition at line 464 of file OgreMovableObject.h.

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

Get the default visibility flags for all future MovableObject instances.

Definition at line 495 of file OgreMovableObject.h.

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

See setDefaultDimensions - this gets 1 component individually.

uint32 Ogre::Renderable::getHlmsCasterHash ( void  ) const
inlineinherited

Definition at line 414 of file OgreRenderable.h.

uint32 Ogre::Renderable::getHlmsHash ( void  ) const
inlineinherited

Definition at line 413 of file OgreRenderable.h.

IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

Definition at line 74 of file OgreId.h.

uint32 Ogre::MovableObject::getLightMask ( ) const
inlineinherited

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

Listener* Ogre::MovableObject::getListener ( void  ) const
inlineinherited

Gets the current listener for this object.

Definition at line 506 of file OgreMovableObject.h.

Aabb Ogre::MovableObject::getLocalAabb ( void  ) const
inherited

Retrieves the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
virtual const MaterialPtr& Ogre::BillboardSet::getMaterial ( void  ) const
virtual

Overridden from MovableObject.

See also
MovableObject

Implements Ogre::Renderable.

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.
virtual const String& Ogre::BillboardSet::getMovableType ( void  ) const
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

const String& Ogre::MovableObject::getName ( void  ) const
inlineinherited

Returns the name of this object.

Definition at line 166 of file OgreMovableObject.h.

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

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

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

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::BaseInstanceBatchVTF, Ogre::InstanceBatchShader, and Ogre::InstanceBatchHW.

Definition at line 154 of file OgreRenderable.h.

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

Internal method, generates parametric offsets based on origin.

Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Definition at line 172 of file OgreMovableObject.h.

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inlineinherited
virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void  ) const
inlinevirtualinherited

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::BorderRenderable.

Definition at line 333 of file OgreRenderable.h.

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
uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlineinherited

Returns the query flags relevant for this object.

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

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

Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlineinherited

Gets the distance at which batches are no longer rendered.

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const
inlineinherited

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

Definition at line 338 of file OgreMovableObject.h.

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

Overridden from MovableObject.

See also
MovableObject

Implements Ogre::Renderable.

uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
inherited

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

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

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 400 of file OgreRenderable.h.

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
Real Ogre::BillboardSet::getSquaredViewDepth ( const Camera cam) const
virtual

Overridden, see Renderable.

Implements Ogre::Renderable.

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

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

Definition at line 95 of file OgreRenderable.h.

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()
virtual bool Ogre::BillboardSet::getUseAccurateFacing ( void  ) const
inlinevirtual

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 696 of file OgreBillboardSet.h.

bool Ogre::Renderable::getUseIdentityProjection ( void  ) const
inlineinherited

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

bool Ogre::Renderable::getUseIdentityView ( void  ) const
inlineinherited

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

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 350 of file OgreRenderable.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )
inlineinherited

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

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const
inlineinherited

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 350 of file OgreMovableObject.h.

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

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

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

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

uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

bool Ogre::MovableObject::getVisible ( void  ) const
inlineinherited

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

Remarks
Returns the value set by MovableObject::setVisible only.
Aabb Ogre::MovableObject::getWorldAabb ( ) const
inherited

Gets the axis aligned box in world space.

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldAabbUpdated if you need the update process to be guaranteed
Aabb Ogre::MovableObject::getWorldAabbUpdated ( )
inherited

Gets the axis aligned box in world space.

Remarks
Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
float Ogre::MovableObject::getWorldRadius ( ) const
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldRadiusUpdated if you need the update process to be guaranteed
float Ogre::MovableObject::getWorldRadiusUpdated ( )
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
virtual void Ogre::BillboardSet::getWorldTransforms ( Matrix4 xform) const
virtual

Overridden from MovableObject.

See also
MovableObject

Implements Ogre::Renderable.

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

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

Parameters
indexIndex of the parameter to check for existence.
See also
setCustomParameter for full details.

Definition at line 260 of file OgreRenderable.h.

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

Internal method for increasing pool size.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

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

Definition at line 283 of file OgreAnimable.h.

void Ogre::BillboardSet::injectBillboard ( const Billboard bb,
const Camera camera 
)

Define a billboard.

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded ( const Frustum frustum,
const Camera lodCamera,
uint32  combinedVisibilityFlags 
)
inlinevirtualinherited

InstancingTheadedCullingMethod,

See also
InstanceBatch::instanceBatchCullFrustumThreaded

Reimplemented in Ogre::InstanceBatchHW_VTF, and Ogre::InstanceBatchHW.

Definition at line 250 of file OgreMovableObject.h.

bool Ogre::MovableObject::isAttached ( void  ) const
inlineinherited

Returns true if this object is attached to a Node.

Definition at line 181 of file OgreMovableObject.h.

bool Ogre::MovableObject::isCachedAabbOutOfDate ( ) const
inlineinherited

Definition at line 587 of file OgreMovableObject.h.

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

Gets whether debug display of this object is enabled.

Definition at line 582 of file OgreMovableObject.h.

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

Returns whether point rendering is enabled.

Definition at line 813 of file OgreBillboardSet.h.

bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. setStatic.

bool Ogre::MovableObject::isVisible ( void  ) const
inherited

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

Remarks
Takes into account visibility flags and the setVisible, but not rendering distance.
void Ogre::BillboardSet::notifyBillboardDataChanged ( void  )
inline

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 834 of file OgreBillboardSet.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 76 of file OgreId.h.

References Ogre::IdObject::mId.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 81 of file OgreId.h.

References Ogre::IdObject::mId.

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

Called immediately after the Renderable has been rendered.

Definition at line 129 of file OgreRenderable.h.

virtual bool Ogre::Renderable::preRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

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

const LightList& Ogre::MovableObject::queryLights ( void  ) const
inlineinherited

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

Remarks
The lights are filled in
See also
buildLightList
Returns
The list of lights use to lighting this object.

Definition at line 513 of file OgreMovableObject.h.

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.
virtual void Ogre::BillboardSet::removeBillboard ( Billboard pBill)
virtual

Removes a billboard from the set.

Note
This version is more efficient than removing by index.
void Ogre::Renderable::removeCustomParameter ( size_t  index)
inlineinherited

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

Parameters
indexIndex of the parameter to remove.
See also
setCustomParameter for full details.

Definition at line 251 of file OgreRenderable.h.

void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlineinherited

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

void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlineinherited

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

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
autoextendtrue to double the pool every time it runs out, false to fail silently.
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.
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
originA member of the BillboardOrigin enum specifying the origin for all the billboards in this set.
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
rotationTypeA member of the BillboardRotationType enum specifying the rotation type for all the billboards in this set.
virtual void Ogre::BillboardSet::setBillboardsInWorldSpace ( bool  ws)
inlinevirtual

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 724 of file OgreBillboardSet.h.

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
bbtThe type of billboard to render
void Ogre::BillboardSet::setBounds ( const Aabb aabb,
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.
void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

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.
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
vecThe direction for all billboards.
Note
The direction are use as is, never normalised in internal, user are supposed to normalise it himself.
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
vecThe up-vector for all billboards.
Note
The up-vector are use as is, never normalised in internal, user are supposed to normalise it himself.
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
cullIndividualIf 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.
void Ogre::Renderable::setCustomParameter ( size_t  index,
const Vector4 value 
)
inlineinherited

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
indexThe 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.
valueThe value to associate.

Definition at line 242 of file OgreRenderable.h.

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

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 580 of file OgreMovableObject.h.

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
widthThe new default width for the billboards in this set.
heightThe new default height for the billboards in this set.
virtual void Ogre::BillboardSet::setDefaultHeight ( Real  height)
virtual

See setDefaultDimensions - this sets 1 component individually.

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

Set the default query flags for all future MovableObject instances.

Definition at line 460 of file OgreMovableObject.h.

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

Set the default visibility flags for all future MovableObject instances.

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

See setDefaultDimensions - this sets 1 component individually.

void Ogre::Renderable::setHlms ( Hlms hlms,
const HlmsParamVec params 
)
inlineinherited

Definition at line 416 of file OgreRenderable.h.

References Ogre::Hlms::calculateHashFor().

void Ogre::MovableObject::setLightMask ( uint32  lightMask)
inlineinherited

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
void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

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

Definition at line 502 of file OgreMovableObject.h.

void Ogre::MovableObject::setLocalAabb ( const Aabb  box)
inherited

Sets the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
virtual void Ogre::BillboardSet::setMaterial ( const MaterialPtr material)
virtual

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

Parameters
materialThe new material to use for this set.
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
nameThe new name of the material to use for this set.
void Ogre::MovableObject::setName ( const String name)
inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

Definition at line 163 of file OgreMovableObject.h.

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
enabledTrue to enable point rendering, false otherwise
virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlinevirtualinherited

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters
overridetrue means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 325 of file OgreRenderable.h.

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
sizeThe new size for the pool.
void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlineinherited

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.
void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlineinherited

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

Parameters
distDistance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.
void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

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
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 331 of file OgreMovableObject.h.

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

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

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

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
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

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

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val) const
inlinevirtualinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 408 of file OgreRenderable.h.

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

Enables sorting for this BillboardSet.

(default: off)

Parameters
sortenabletrue to sort the billboards according to their distance to the camera
bool Ogre::MovableObject::setStatic ( bool  bStatic)
inherited

Turns this Node into static or dynamic.

Remarks
Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times
Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)
Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. Node::setStatic
Returns
True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported
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
coordsis a vector of texture coordinates (in UV space) to choose from for each billboard created in the set.
numCoordsis 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()
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()
virtual void Ogre::BillboardSet::setUseAccurateFacing ( bool  acc)
inlinevirtual

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
accTrue to use the slower but more accurate model. Default is false.

Definition at line 691 of file OgreBillboardSet.h.

void Ogre::Renderable::setUseIdentityProjection ( bool  useIdentityProjection)
inlineinherited

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

void Ogre::Renderable::setUseIdentityView ( bool  useIdentityView)
inlineinherited

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

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtualinherited
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 345 of file OgreRenderable.h.

void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlineinherited

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 that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).
void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

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.
static void Ogre::MovableObject::updateAllBounds ( const size_t  numNodes,
ObjectData  t 
)
staticinherited

SceneManager::updateAllBounds

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Aabb Ogre::MovableObject::updateSingleWorldAabb ( )
protectedinherited
float Ogre::MovableObject::updateSingleWorldRadius ( )
protectedinherited
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
visitorPointer 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.
debugRenderablesIf 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

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh
inherited

Definition at line 65 of file OgreMovableObject.h.

bool Ogre::BillboardSet::mAccurateFacing
protected

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

Definition at line 139 of file OgreBillboardSet.h.

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 156 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mAllDefaultRotation
protected

Definition at line 141 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mAllDefaultSize
protected

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

Definition at line 130 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mAutoExtendPool
protected

Flag indicating whether to autoextend pool.

Definition at line 133 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mAutoUpdate
private

Tell if vertex buffer should be update automatically.

Definition at line 290 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mBillboardDataChanged
private

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

Definition at line 292 of file OgreBillboardSet.h.

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 171 of file OgreBillboardSet.h.

BillboardType Ogre::BillboardSet::mBillboardType
protected

The type of billboard to render.

Definition at line 204 of file OgreBillboardSet.h.

Real Ogre::BillboardSet::mBottomOff
protected

Definition at line 184 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mBuffersCreated
private

Flag indicating whether the HW buffers have been created.

Definition at line 284 of file OgreBillboardSet.h.

bool Ogre::MovableObject::mCachedAabbOutOfDate
mutableprotectedinherited

Definition at line 117 of file OgreMovableObject.h.

Vector3 Ogre::BillboardSet::mCamDir
protected

Camera direction in billboard space.

Definition at line 188 of file OgreBillboardSet.h.

Vector3 Ogre::BillboardSet::mCamPos
protected

Camera position in billboard space.

Definition at line 192 of file OgreBillboardSet.h.

Quaternion Ogre::BillboardSet::mCamQ
protected

Camera orientation in billboard space.

Definition at line 190 of file OgreBillboardSet.h.

Vector3 Ogre::BillboardSet::mCamX
protected

Camera axes in billboard space.

Definition at line 186 of file OgreBillboardSet.h.

Vector3 Ogre::BillboardSet::mCamY
protected

Definition at line 186 of file OgreBillboardSet.h.

Vector3 Ogre::BillboardSet::mCommonDirection
protected

Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON.

Definition at line 207 of file OgreBillboardSet.h.

Vector3 Ogre::BillboardSet::mCommonUpVector
protected

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

Definition at line 209 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mCullIndividual
protected

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

Definition at line 198 of file OgreBillboardSet.h.

FastArray<unsigned char> Ogre::MovableObject::mCurrentMaterialLod
protectedinherited

Definition at line 97 of file OgreMovableObject.h.

unsigned char Ogre::MovableObject::mCurrentMeshLod
protectedinherited

Definition at line 96 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

Definition at line 423 of file OgreRenderable.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 111 of file OgreMovableObject.h.

Real Ogre::BillboardSet::mDefaultHeight
protected

Default height of each billboard.

Definition at line 122 of file OgreBillboardSet.h.

Real Ogre::BillboardSet::mDefaultWidth
protected

Default width of each billboard.

Definition at line 120 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mExternalData
private

Is external billboard data in use?

Definition at line 288 of file OgreBillboardSet.h.

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 165 of file OgreBillboardSet.h.

size_t Ogre::MovableObject::mGlobalIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 140 of file OgreMovableObject.h.

uint32 Ogre::Renderable::mHlmsCasterHash
protectedinherited

Definition at line 425 of file OgreRenderable.h.

uint32 Ogre::Renderable::mHlmsHash
protectedinherited

Definition at line 424 of file OgreRenderable.h.

IndexData* Ogre::BillboardSet::mIndexData
protected

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

Definition at line 195 of file OgreBillboardSet.h.

Real Ogre::BillboardSet::mLeftOff
protected

Parametric offsets of origin.

Definition at line 184 of file OgreBillboardSet.h.

LightList Ogre::MovableObject::mLightList
protectedinherited

List of lights for this object.

Definition at line 108 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

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

Definition at line 105 of file OgreMovableObject.h.

float* Ogre::BillboardSet::mLockPtr
protected

Locked pointer to buffer.

Definition at line 178 of file OgreBillboardSet.h.

FastArray< FastArray<Real> const * > Ogre::MovableObject::mLodMaterial
protectedinherited

Definition at line 95 of file OgreMovableObject.h.

FastArray<Real> const* Ogre::MovableObject::mLodMesh
protectedinherited

Definition at line 94 of file OgreMovableObject.h.

HardwareVertexBufferSharedPtr Ogre::BillboardSet::mMainBuf
protected

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

Definition at line 176 of file OgreBillboardSet.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 91 of file OgreMovableObject.h.

MaterialPtr Ogre::BillboardSet::mMaterial
protected

Pointer to the material to use.

Definition at line 127 of file OgreBillboardSet.h.

String Ogre::BillboardSet::mMaterialName
protected

Name of the material to use.

Definition at line 125 of file OgreBillboardSet.h.

Real Ogre::MovableObject::mMinPixelSize
protectedinherited

Minimum pixel size to still render.

Definition at line 100 of file OgreMovableObject.h.

String Ogre::MovableObject::mName
protectedinherited

Friendly name of this object, can be empty.

Definition at line 121 of file OgreMovableObject.h.

unsigned short Ogre::BillboardSet::mNumVisibleBillboards
protected

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

Definition at line 215 of file OgreBillboardSet.h.

ObjectData Ogre::MovableObject::mObjectData
protectedinherited

All the object data needed in SoA form.

Definition at line 89 of file OgreMovableObject.h.

ObjectMemoryManager* Ogre::MovableObject::mObjectMemoryManager
protectedinherited

The memory manager used to allocate the ObjectData.

Definition at line 114 of file OgreMovableObject.h.

BillboardOrigin Ogre::BillboardSet::mOriginType
protected

Origin of each billboard.

Definition at line 115 of file OgreBillboardSet.h.

size_t Ogre::MovableObject::mParentIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 142 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

Node to which this object is attached.

Definition at line 83 of file OgreMovableObject.h.

bool Ogre::BillboardSet::mPointRendering
protected

Use point rendering?

Definition at line 278 of file OgreBillboardSet.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

Definition at line 426 of file OgreRenderable.h.

size_t Ogre::BillboardSet::mPoolSize
private

The number of billboard in the pool.

Definition at line 286 of file OgreBillboardSet.h.

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

Definition at line 275 of file OgreBillboardSet.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 85 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 87 of file OgreMovableObject.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

User objects binding.

Definition at line 430 of file OgreRenderable.h.

Real Ogre::BillboardSet::mRightOff
protected

Definition at line 184 of file OgreBillboardSet.h.

BillboardRotationType Ogre::BillboardSet::mRotationType
protected

Rotation type of each billboard.

Definition at line 117 of file OgreBillboardSet.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

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

Definition at line 239 of file OgreAnimable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 125 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 127 of file OgreMovableObject.h.

bool Ogre::BillboardSet::mSortingEnabled
protected

Flag indicating whether the billboards has to be sorted.

Definition at line 136 of file OgreBillboardSet.h.

TextureCoordSets Ogre::BillboardSet::mTextureCoords
protected

Definition at line 201 of file OgreBillboardSet.h.

Real Ogre::BillboardSet::mTopOff
protected

Definition at line 184 of file OgreBillboardSet.h.

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

Definition at line 427 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protectedinherited

Definition at line 428 of file OgreRenderable.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 102 of file OgreMovableObject.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 429 of file OgreRenderable.h.

VertexData* Ogre::BillboardSet::mVertexData
protected

The vertex position data for all billboards in this set.

Definition at line 174 of file OgreBillboardSet.h.

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 182 of file OgreBillboardSet.h.

bool Ogre::BillboardSet::mWorldSpace
protected

Definition at line 142 of file OgreBillboardSet.h.


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