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>
Classes | |
struct | SortByDirectionFunctor |
Sort by direction functor. More... | |
struct | SortByDistanceFunctor |
Sort by distance functor. More... | |
Public Types | |
typedef vector < ShadowRenderable * >::type | ShadowRenderableList |
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
Public Member Functions | |
BillboardSet (const String &name, unsigned int poolSize=20, bool externalDataSource=false) | |
Usual constructor - this is called by the SceneManager. More... | |
virtual | ~BillboardSet () |
virtual MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) More... | |
virtual LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. More... | |
virtual SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) More... | |
virtual const Matrix4 & | _getParentNodeFullTransform (void) const |
return the full transformation of the parent sceneNode or the attachingPoint node More... | |
virtual SortMode | _getSortMode (void) const |
Gets the sort mode of this billboard set. More... | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. More... | |
virtual void | _notifyBillboardResized (void) |
Internal callback used by Billboards to notify their parent that they have been resized. More... | |
virtual void | _notifyBillboardRotated (void) |
Internal callback used by Billboards to notify their parent that they have been rotated. More... | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) More... | |
virtual void | _notifyCurrentCamera (Camera *cam) |
Overridden from MovableObject. More... | |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) More... | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. More... | |
virtual void | _sortBillboards (Camera *cam) |
Sort the billboard set. More... | |
virtual void | _updateBounds (void) |
Update the bounds of the billboardset. More... | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More... | |
virtual void | _updateRenderQueue (RenderQueue *queue) |
Overridden from MovableObject. More... | |
virtual void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
virtual void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
void | beginBillboards (size_t numBillboards=0) |
Begin injection of billboard data; applicable when constructing the BillboardSet for external data use. More... | |
virtual void | clear () |
Empties this set of all billboards. More... | |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. More... | |
Billboard * | createBillboard (const Vector3 &position, const ColourValue &colour=ColourValue::White) |
Creates a new billboard and adds it to this set. More... | |
Billboard * | createBillboard (Real x, Real y, Real z, const ColourValue &colour=ColourValue::White) |
Creates a new billboard and adds it to this set. More... | |
virtual void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. More... | |
void | endBillboards (void) |
Finish defining billboards. More... | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
virtual bool | getAutoextend (void) const |
Returns true if the billboard pool automatically extends. More... | |
bool | getAutoUpdate (void) const |
Return the auto update state of this billboard set. More... | |
virtual Billboard * | getBillboard (unsigned int index) const |
Returns a pointer to the billboard at the supplied index. More... | |
virtual BillboardOrigin | getBillboardOrigin (void) const |
Gets the point which acts as the origin point for all billboards in this set. More... | |
virtual BillboardRotationType | getBillboardRotationType (void) const |
Sets billboard rotation type. More... | |
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... | |
virtual const AxisAlignedBox & | getBoundingBox (void) const |
Overridden from MovableObject. More... | |
virtual Real | getBoundingRadius (void) const |
Overridden from MovableObject. More... | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. More... | |
virtual bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. More... | |
virtual const Vector3 & | getCommonDirection (void) const |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More... | |
virtual const Vector3 & | getCommonUpVector (void) const |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON) More... | |
virtual bool | getCullIndividually (void) const |
Returns whether or not billboards in this are tested individually for culling. More... | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
virtual Real | getDefaultHeight (void) const |
See setDefaultDimensions - this gets 1 component individually. More... | |
virtual Real | getDefaultWidth (void) const |
See setDefaultDimensions - this gets 1 component individually. More... | |
EdgeData * | getEdgeList (void) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
const AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. More... | |
virtual uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
virtual const MaterialPtr & | getMaterial (void) const |
Overridden from MovableObject. More... | |
virtual const String & | getMaterialName (void) const |
Sets the name of the material to be used for this billboard set. More... | |
virtual const String & | getMovableType (void) const |
Overridden from MovableObject. More... | |
virtual const String & | getName (void) const |
Returns the name of this object. More... | |
virtual int | getNumBillboards (void) const |
Returns the number of active billboards which currently make up this set. More... | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. More... | |
virtual Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. More... | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. More... | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
virtual unsigned int | getPoolSize (void) const |
Returns the current size of the billboard pool. More... | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant for this object. More... | |
bool | getReceivesShadows () |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More... | |
virtual Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. More... | |
virtual Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual void | getRenderOperation (RenderOperation &op) |
Overridden from MovableObject. More... | |
virtual uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
virtual RenderSystemData * | getRenderSystemData () const |
Gets RenderSystem private data. More... | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
virtual bool | getSortingEnabled (void) const |
Returns true if sorting of billboards is enabled based on their distance from the camera. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden, see Renderable. More... | |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. More... | |
virtual Ogre::FloatRect const * | getTextureCoords (uint16 *oNumCoords) |
getTextureCoords() returns the current texture coordinate rects in effect. More... | |
uint32 | getTypeFlags (void) const |
Override to return specific type flag. More... | |
virtual bool | getUseAccurateFacing (void) const |
Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More... | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. More... | |
virtual bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. More... | |
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
virtual void | getWorldTransforms (Matrix4 *xform) const |
Overridden from MovableObject. More... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. More... | |
bool | hasEdgeList (void) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
void | injectBillboard (const Billboard &bb) |
Define a billboard. More... | |
virtual bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. More... | |
virtual bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. More... | |
virtual bool | isInScene (void) const |
Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More... | |
virtual bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) More... | |
virtual bool | isPointRenderingEnabled (void) const |
Returns whether point rendering is enabled. More... | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. More... | |
void | notifyBillboardDataChanged (void) |
When billboard set is not auto updating its GPU buffer, the user is responsible to inform it about any billboard changes in order to reflect them at the rendering stage. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. More... | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. More... | |
virtual const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. More... | |
virtual void | removeBillboard (unsigned int index) |
Removes the billboard at the supplied index. More... | |
virtual void | removeBillboard (Billboard *pBill) |
Removes a billboard from the set. More... | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. More... | |
virtual void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
virtual void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
virtual void | setAutoextend (bool autoextend) |
Tells the set whether to allow automatic extension of the pool of billboards. More... | |
void | setAutoUpdate (bool autoUpdate) |
Set the auto update state of this billboard set. More... | |
virtual void | setBillboardOrigin (BillboardOrigin origin) |
Sets the point which acts as the origin point for all billboards in this set. More... | |
virtual void | setBillboardRotationType (BillboardRotationType rotationType) |
Sets billboard rotation type. More... | |
virtual void | setBillboardsInWorldSpace (bool ws) |
Sets whether billboards should be treated as being in world space. More... | |
virtual void | setBillboardType (BillboardType bbt) |
Sets the type of billboard to render. More... | |
void | setBounds (const AxisAlignedBox &box, Real radius) |
Set the bounds of the BillboardSet. More... | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. More... | |
virtual void | setCommonDirection (const Vector3 &vec) |
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPENDICULAR_COMMON. More... | |
virtual void | setCommonUpVector (const Vector3 &vec) |
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON. More... | |
virtual void | setCullIndividually (bool cullIndividual) |
Sets whether culling tests billboards in this individually as well as in a group. More... | |
void | setCustomParameter (size_t index, const Vector4 &value) |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More... | |
virtual void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. More... | |
virtual void | setDefaultDimensions (Real width, Real height) |
Sets the default dimensions of the billboards in this set. More... | |
virtual void | setDefaultHeight (Real height) |
See setDefaultDimensions - this sets 1 component individually. More... | |
virtual void | setDefaultWidth (Real width) |
See setDefaultDimensions - this sets 1 component individually. More... | |
virtual void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. More... | |
virtual void | setListener (Listener *listener) |
Sets a listener for this object. More... | |
virtual void | setMaterial (const MaterialPtr &material) |
Sets the name of the material to be used for this billboard set. More... | |
virtual void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Sets the name of the material to be used for this billboard set. More... | |
virtual void | setPointRenderingEnabled (bool enabled) |
Set whether or not the BillboardSet will use point rendering rather than manually generated quads. More... | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
virtual void | setPoolSize (size_t size) |
Adjusts the size of the pool of billboards available in this set. More... | |
virtual void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. More... | |
virtual void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. More... | |
virtual void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this entity will be rendered through. More... | |
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this entity will be rendered through. More... | |
virtual void | setRenderSystemData (RenderSystemData *val) const |
Sets RenderSystem private data. More... | |
virtual void | setSortingEnabled (bool sortenable) |
Enables sorting for this BillboardSet. More... | |
virtual void | setTextureCoords (Ogre::FloatRect const *coords, uint16 numCoords) |
BillboardSet can use custom texture coordinates for various billboards. More... | |
virtual void | setTextureStacksAndSlices (uchar stacks, uchar slices) |
setTextureStacksAndSlices() will generate texture coordinate rects as if the texture for the billboard set contained 'stacks' rows of 'slices' images each, all equal size. More... | |
virtual void | setUseAccurateFacing (bool acc) |
Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More... | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. More... | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. More... | |
virtual void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. More... | |
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) |
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More... | |
Static Public Member Functions | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. More... | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. More... | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. More... | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. More... | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. More... | |
Protected Types | |
typedef list< Billboard * >::type | ActiveBillboardList |
typedef map< String, StringVector >::type | AnimableDictionaryMap |
typedef vector< Billboard * >::type | BillboardPool |
typedef map< size_t, Vector4 > ::type | CustomParameterMap |
typedef list< Billboard * >::type | FreeBillboardList |
typedef vector < Ogre::FloatRect >::type | TextureCoordSets |
Protected Member Functions | |
BillboardSet () | |
Private constructor (instances cannot be created directly). More... | |
StringVector & | _getAnimableValueNames (void) |
Get an updateable reference to animable value list. More... | |
bool | billboardVisible (Camera *cam, const Billboard &bill) |
Internal method for culling individual billboards. More... | |
void | createAnimableDictionary (void) const |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More... | |
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const |
Utility method for extruding a bounding box. More... | |
void | genBillboardAxes (Vector3 *pX, Vector3 *pY, const Billboard *pBill=0) |
Internal method for generating billboard corners. More... | |
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags) |
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More... | |
void | genVertices (const Vector3 *const offsets, const Billboard &pBillboard) |
Internal method for generating vertex data. More... | |
void | genVertOffsets (Real inleft, Real inright, Real intop, Real inbottom, Real width, Real height, const Vector3 &x, const Vector3 &y, Vector3 *pDestVec) |
Internal method generates vertex offsets. More... | |
virtual const String & | getAnimableDictionaryName (void) const |
Get the name of the animable dictionary for this class. More... | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper method for calculating extrusion distance. More... | |
void | getParametricOffsets (Real &left, Real &right, Real &top, Real &bottom) |
Internal method, generates parametric offsets based on origin. More... | |
virtual void | increasePool (size_t size) |
Internal method for increasing pool size. More... | |
virtual void | initialiseAnimableDictionary (StringVector &) const |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More... | |
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos) |
Tells the caster to perform the tasks necessary to update the edge data's light listing. More... | |
Protected Attributes | |
AxisAlignedBox | mAABB |
Bounds of all billboards in this set. More... | |
bool | mAccurateFacing |
Use 'true' billboard to cam position facing, rather than camera direcion. More... | |
ActiveBillboardList | mActiveBillboards |
Active billboard list. More... | |
bool | mAllDefaultRotation |
bool | mAllDefaultSize |
True if no billboards in this set have been resized - greater efficiency. More... | |
bool | mAutoExtendPool |
Flag indicating whether to autoextend pool. More... | |
bool | mBeyondFarDistance |
Hidden because of distance? More... | |
BillboardPool | mBillboardPool |
Pool of billboard instances for use and reuse in the active billboard list. More... | |
BillboardType | mBillboardType |
The type of billboard to render. More... | |
Real | mBottomOff |
Real | mBoundingRadius |
Bounding radius. More... | |
Vector3 | mCamDir |
Camera direction in billboard space. More... | |
Vector3 | mCamPos |
Camera position in billboard space. More... | |
Quaternion | mCamQ |
Camera orientation in billboard space. More... | |
Vector3 | mCamX |
Camera axes in billboard space. More... | |
Vector3 | mCamY |
bool | mCastShadows |
Does this object cast shadows? More... | |
Vector3 | mCommonDirection |
Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON. More... | |
Vector3 | mCommonUpVector |
Common up-vector for billboards of type BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON. More... | |
MovableObjectFactory * | mCreator |
Creator of this object (if created by a factory) More... | |
bool | mCullIndividual |
Flag indicating whether each billboard should be culled separately (default: false) More... | |
Camera * | mCurrentCamera |
Current camera. More... | |
CustomParameterMap | mCustomParameters |
bool | mDebugDisplay |
Is debug display enabled? More... | |
Real | mDefaultHeight |
Default height of each billboard. More... | |
Real | mDefaultWidth |
Default width of each billboard. More... | |
FreeBillboardList | mFreeBillboards |
Free billboard queue. More... | |
IndexData * | mIndexData |
The vertex index data for all billboards in this set (1 set only) More... | |
Real | mLeftOff |
Parametric offsets of origin. More... | |
LightList | mLightList |
List of lights for this object. More... | |
ulong | mLightListUpdated |
The last frame that this light list was updated in. More... | |
uint32 | mLightMask |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More... | |
Listener * | mListener |
MovableObject listener - only one allowed (no list) for size & performance reasons. */. More... | |
float * | mLockPtr |
Locked pointer to buffer. More... | |
HardwareVertexBufferSharedPtr | mMainBuf |
Shortcut to main buffer (positions, colours, texture coords) More... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
MaterialPtr | mMaterial |
Pointer to the material to use. More... | |
String | mMaterialName |
Name of the material to use. More... | |
Real | mMinPixelSize |
String | mName |
Name of this object. More... | |
unsigned short | mNumVisibleBillboards |
Number of visible billboards (will be == getNumBillboards if mCullIndividual == false) More... | |
BillboardOrigin | mOriginType |
Origin of each billboard. More... | |
bool | mParentIsTagPoint |
Node * | mParentNode |
node to which this object is attached More... | |
bool | mPointRendering |
Use point rendering? More... | |
bool | mPolygonModeOverrideable |
uint32 | mQueryFlags |
Flags determining whether this object is included / excluded from scene queries. More... | |
bool | mRenderingDisabled |
Does rendering this object disabled by listener? More... | |
uint8 | mRenderQueueID |
The render queue to use when rendering this object. More... | |
bool | mRenderQueueIDSet |
Flags whether the RenderQueue's default should be used. More... | |
ushort | mRenderQueuePriority |
The render queue group to use when rendering this object. More... | |
bool | mRenderQueuePrioritySet |
Flags whether the RenderQueue's default should be used. More... | |
RenderSystemData * | mRenderSystemData |
User objects binding. More... | |
Real | mRightOff |
BillboardRotationType | mRotationType |
Rotation type of each billboard. More... | |
bool | mSortingEnabled |
Flag indicating whether the billboards has to be sorted. More... | |
Real | mSquaredUpperDistance |
TextureCoordSets | mTextureCoords |
Real | mTopOff |
Real | mUpperDistance |
Upper distance to still render. More... | |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
User objects binding. More... | |
UserObjectBindings | mUserObjectBindings |
VertexData * | mVertexData |
The vertex position data for all billboards in this set. More... | |
uint32 | mVisibilityFlags |
Flags determining whether this object is visible (compared to SceneManager mask) More... | |
bool | mVisible |
Is this object visible? More... | |
Vector3 | mVOffset [4] |
Boundary offsets based on origin and camera orientation Vector3 vLeftOff, vRightOff, vTopOff, vBottomOff; Final vertex offsets, used where sizes all default to save calcs. More... | |
AxisAlignedBox | mWorldAABB |
Cached world AABB of this object. More... | |
Sphere | mWorldBoundingSphere |
AxisAlignedBox | mWorldDarkCapBounds |
World space AABB of this object's dark cap. More... | |
bool | mWorldSpace |
Static Protected Attributes | |
static RadixSort < ActiveBillboardList, Billboard *, float > | mRadixSorter |
static AnimableDictionaryMap | msAnimableDictionary |
Static map of class name to list of animable value names. More... | |
static uint32 | msDefaultQueryFlags |
Default query flags. More... | |
static uint32 | msDefaultVisibilityFlags |
Default visibility flags. More... | |
Private Member Functions | |
void | _createBuffers (void) |
Internal method creates vertex and index buffers. More... | |
void | _destroyBuffers (void) |
Internal method destroys vertex and index buffers. More... | |
Private Attributes | |
bool | mAutoUpdate |
Tell if vertex buffer should be update automatically. More... | |
bool | mBillboardDataChanged |
True if the billboard data changed. Will cause vertex buffer update. More... | |
bool | mBuffersCreated |
Flag indicating whether the HW buffers have been created. More... | |
bool | mExternalData |
Is external billboard data in use? More... | |
size_t | mPoolSize |
The number of billboard in the pool. More... | |
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.
Definition at line 110 of file OgreBillboardSet.h.
|
protected |
Definition at line 152 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 241 of file OgreAnimable.h.
|
protected |
Definition at line 154 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 414 of file OgreRenderable.h.
|
protected |
Definition at line 153 of file OgreBillboardSet.h.
|
inherited |
Definition at line 136 of file OgreShadowCaster.h.
|
inherited |
Definition at line 137 of file OgreShadowCaster.h.
|
protected |
Definition at line 210 of file OgreBillboardSet.h.
|
protected |
Private constructor (instances cannot be created directly).
Ogre::BillboardSet::BillboardSet | ( | const String & | name, |
unsigned int | poolSize = 20 , |
||
bool | externalDataSource = false |
||
) |
Usual constructor - this is called by the SceneManager.
name | The name to give the billboard set (must be unique) |
poolSize | The initial size of the billboard pool. Estimate of the number of billboards which will be required, and pass it using this parameter. The set will preallocate this number to avoid memory fragmentation. The default behaviour once this pool has run out is to double it. |
externalDataSource | If true , the source of data for drawing the billboards will not be the internal billboard list, but external data. When driving the billboard from external data, you must call _notifyCurrentCamera to reorient the billboards, setPoolSize to set the maximum billboards you want to use, beginBillboards to start the update, and injectBillboard per billboard, followed by endBillboards. |
|
virtual |
|
private |
Internal method creates vertex and index buffers.
|
private |
Internal method destroys vertex and index buffers.
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlinevirtualinherited |
Get the creator of this object, if any (internal use only)
Definition at line 186 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 491 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 190 of file OgreMovableObject.h.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
Reimplemented in Ogre::InstancedEntity.
|
virtual |
Gets the sort mode of this billboard set.
|
virtualinherited |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, Ogre::PortalBase, and Ogre::InstancedEntity.
Referenced by Ogre::PortalBase::_notifyAttached().
|
virtual |
Internal callback used by Billboards to notify their parent that they have been resized.
|
virtual |
Internal callback used by Billboards to notify their parent that they have been rotated.
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 184 of file OgreMovableObject.h.
|
virtual |
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 188 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, Ogre::InstancedEntity, and Ogre::PCZLight.
|
virtual |
Sort the billboard set.
Only called when enabled via setSortingEnabled
|
virtual |
Update the bounds of the billboardset.
|
inlinevirtualinherited |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
constantEntry | The auto constant entry referring to the parameter being updated |
params | The parameters object which this method should call to set the updated parameters. |
Reimplemented in Ogre::SubEntity.
Definition at line 307 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
virtual |
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 396 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 424 of file OgreMovableObject.h.
void Ogre::BillboardSet::beginBillboards | ( | size_t | numBillboards = 0 | ) |
Begin injection of billboard data; applicable when constructing the BillboardSet for external data use.
numBillboards | If you know the number of billboards you will be issuing, state it here to make the update more efficient. |
Internal method for culling individual billboards.
|
virtual |
Empties this set of all billboards.
|
inlineprotectedinherited |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 254 of file OgreAnimable.h.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 320 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.
position | The position of the new billboard realtive to the certer of the set |
colour | Optional base colour of the billboard. |
NULL
is returned. 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.
x | The x position of the new billboard relative to the center of the set |
y | The y position of the new billboard relative to the center of the set |
z | The z position of the new billboard relative to the center of the set |
colour | Optional base colour of the billboard. |
NULL
is returned.
|
virtualinherited |
void Ogre::BillboardSet::endBillboards | ( | void | ) |
Finish defining billboards.
|
protectedvirtualinherited |
Utility method for extruding a bounding box.
box | Original bounding box, will be updated in-place. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light. |
extrudeDist | The distance to extrude. |
|
staticinherited |
Utility method for extruding vertices based on a light.
vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long. |
originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light. |
extrudeDist | The distance to extrude. |
|
protected |
Internal method for generating billboard corners.
|
protectedvirtualinherited |
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
edgeData | The edge information to use. |
indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable. |
indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset. |
light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing |
shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used. |
flags | Additional controller flags, see ShadowRenderableFlags. |
|
protected |
Internal method for generating vertex data.
offsets | Array of 4 Vector3 offsets |
pBillboard | Reference to billboard |
|
protected |
Internal method generates vertex offsets.
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 249 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
inlineinherited |
Gets a list of animable value names for this object.
Definition at line 295 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtual |
Returns true if the billboard pool automatically extends.
|
inline |
Return the auto update state of this billboard set.
Definition at line 852 of file OgreBillboardSet.h.
|
virtual |
Returns a pointer to the billboard at the supplied index.
index | The index of the billboard that is requested. |
NULL
is returned.
|
virtual |
Gets the point which acts as the origin point for all billboards in this set.
|
virtual |
Sets billboard rotation type.
|
inline |
Gets whether billboards are treated as being in world space.
Definition at line 749 of file OgreBillboardSet.h.
|
virtual |
Returns the billboard type in use.
|
virtual |
|
virtual |
|
inlinevirtualinherited |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 521 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.
Definition at line 224 of file OgreRenderable.h.
|
virtual |
Gets the common direction for all billboards (BBT_ORIENTED_COMMON)
|
virtual |
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON)
|
virtual |
Returns whether or not billboards in this are tested individually for culling.
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
Definition at line 268 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
virtual |
See setDefaultDimensions - this gets 1 component individually.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 411 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 439 of file OgreMovableObject.h.
|
virtual |
See setDefaultDimensions - this gets 1 component individually.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 494 of file OgreMovableObject.h.
|
protectedinherited |
Helper method for calculating extrusion distance.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 476 of file OgreMovableObject.h.
|
virtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Gets the current listener for this object.
Definition at line 450 of file OgreMovableObject.h.
|
virtual |
|
virtual |
Sets the name of the material to be used for this billboard set.
|
virtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 193 of file OgreMovableObject.h.
|
virtual |
Returns the number of active billboards which currently make up this set.
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.
Definition at line 153 of file OgreRenderable.h.
|
protected |
Internal method, generates parametric offsets based on origin.
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 332 of file OgreRenderable.h.
|
virtual |
Returns the current size of the billboard pool.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 403 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 305 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
Definition at line 318 of file OgreMovableObject.h.
|
virtual |
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlinevirtualinherited |
Gets RenderSystem private data.
Definition at line 399 of file OgreRenderable.h.
|
virtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
|
virtual |
Returns true if sorting of billboards is enabled based on their distance from the camera.
Overridden, see Renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 94 of file OgreRenderable.h.
|
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.
|
virtual |
Override to return specific type flag.
Reimplemented from Ogre::MovableObject.
|
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 717 of file OgreBillboardSet.h.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 178 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 203 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 334 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Definition at line 349 of file OgreRenderable.h.
|
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.
Definition at line 340 of file OgreMovableObject.h.
|
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.
Definition at line 346 of file OgreMovableObject.h.
|
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.
Definition at line 355 of file OgreRenderable.h.
|
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.
Definition at line 361 of file OgreRenderable.h.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 431 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtualinherited |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtualinherited |
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtual |
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
Definition at line 259 of file OgreRenderable.h.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 496 of file OgreMovableObject.h.
|
protectedvirtual |
Internal method for increasing pool size.
|
inlineprotectedvirtualinherited |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light.
Definition at line 287 of file OgreAnimable.h.
void Ogre::BillboardSet::injectBillboard | ( | const Billboard & | bb | ) |
Define a billboard.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 565 of file OgreMovableObject.h.
|
virtualinherited |
Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.
Reimplemented in Ogre::InstancedEntity.
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 216 of file OgreMovableObject.h.
|
inlinevirtual |
Returns whether point rendering is enabled.
Definition at line 834 of file OgreBillboardSet.h.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
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 858 of file OgreBillboardSet.h.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 128 of file OgreRenderable.h.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
Definition at line 123 of file OgreRenderable.h.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
virtual |
Removes the billboard at the supplied index.
|
virtual |
Removes a billboard from the set.
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
Definition at line 250 of file OgreRenderable.h.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 400 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 428 of file OgreMovableObject.h.
|
virtual |
Tells the set whether to allow automatic extension of the pool of billboards.
autoextend | true 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.
|
virtual |
Sets the point which acts as the origin point for all billboards in this set.
origin | A member of the BillboardOrigin enum specifying the origin for all the billboards in this set. |
|
virtual |
Sets billboard rotation type.
rotationType | A member of the BillboardRotationType enum specifying the rotation type for all the billboards in this set. |
|
inlinevirtual |
Sets whether billboards should be treated as being in world space.
Definition at line 745 of file OgreBillboardSet.h.
|
virtual |
Sets the type of billboard to render.
bbt | The type of billboard to render |
void Ogre::BillboardSet::setBounds | ( | const AxisAlignedBox & | box, |
Real | radius | ||
) |
Set the bounds of the BillboardSet.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 519 of file OgreMovableObject.h.
|
virtual |
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPENDICULAR_COMMON.
vec | The direction for all billboards. |
|
virtual |
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON.
vec | The up-vector for all billboards. |
|
virtual |
Sets whether culling tests billboards in this individually as well as in a group.
cullIndividual | If true, each billboard is tested before being sent to the pipeline as well as the whole set having to pass the coarse group bounding test. |
|
inlineinherited |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. |
value | The value to associate. |
Definition at line 241 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 563 of file OgreMovableObject.h.
Sets the default dimensions of the billboards in this set.
width | The new default width for the billboards in this set. |
height | The new default height for the billboards in this set. |
|
virtual |
See setDefaultDimensions - this sets 1 component individually.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 407 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 435 of file OgreMovableObject.h.
|
virtual |
See setDefaultDimensions - this sets 1 component individually.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 446 of file OgreMovableObject.h.
|
virtual |
Sets the name of the material to be used for this billboard set.
material | The new material to use for this set. |
|
virtual |
Sets the name of the material to be used for this billboard set.
name | The new name of the material to use for this set. |
|
virtual |
Set whether or not the BillboardSet will use point rendering rather than manually generated quads.
enabled | True to enable point rendering, false otherwise |
|
inlinevirtualinherited |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
Definition at line 324 of file OgreRenderable.h.
|
virtual |
Adjusts the size of the pool of billboards available in this set.
size | The new size for the pool. |
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 392 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the distance at which the object is no longer rendered.
dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered). |
Definition at line 299 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered). |
Definition at line 312 of file OgreMovableObject.h.
|
virtualinherited |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
virtualinherited |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
inlinevirtualinherited |
Sets RenderSystem private data.
Definition at line 407 of file OgreRenderable.h.
|
virtual |
Enables sorting for this BillboardSet.
(default: off)
sortenable | true to sort the billboards according to their distance to the camera |
|
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.
coords | is a vector of texture coordinates (in UV space) to choose from for each billboard created in the set. |
numCoords | is how many such coordinate rectangles there are to choose from. |
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.
|
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.
acc | True to use the slower but more accurate model. Default is false. |
Definition at line 712 of file OgreBillboardSet.h.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 164 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 189 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 329 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 344 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets the visibility flags for this object.
Definition at line 420 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
|
protectedvirtualinherited |
Tells the caster to perform the tasks necessary to update the edge data's light listing.
Can be overridden if the subclass needs to do additional things.
edgeData | The edge information to update. |
lightPos | 4D vector representing the light, a directional light has w=0.0. |
|
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.
visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this. |
debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. |
Implements Ogre::MovableObject.
|
protected |
Bounds of all billboards in this set.
Definition at line 118 of file OgreBillboardSet.h.
|
protected |
Use 'true' billboard to cam position facing, rather than camera direcion.
Definition at line 147 of file OgreBillboardSet.h.
|
protected |
Active billboard list.
Definition at line 164 of file OgreBillboardSet.h.
|
protected |
Definition at line 149 of file OgreBillboardSet.h.
|
protected |
True if no billboards in this set have been resized - greater efficiency.
Definition at line 138 of file OgreBillboardSet.h.
|
protected |
Flag indicating whether to autoextend pool.
Definition at line 141 of file OgreBillboardSet.h.
|
private |
Tell if vertex buffer should be update automatically.
Definition at line 300 of file OgreBillboardSet.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 128 of file OgreMovableObject.h.
|
private |
True if the billboard data changed. Will cause vertex buffer update.
Definition at line 302 of file OgreBillboardSet.h.
|
protected |
Pool of billboard instances for use and reuse in the active billboard list.
Definition at line 179 of file OgreBillboardSet.h.
|
protected |
The type of billboard to render.
Definition at line 214 of file OgreBillboardSet.h.
|
protected |
Definition at line 194 of file OgreBillboardSet.h.
|
protected |
Bounding radius.
Definition at line 120 of file OgreBillboardSet.h.
|
private |
Flag indicating whether the HW buffers have been created.
Definition at line 294 of file OgreBillboardSet.h.
|
protected |
Camera direction in billboard space.
Definition at line 198 of file OgreBillboardSet.h.
|
protected |
Camera position in billboard space.
Definition at line 202 of file OgreBillboardSet.h.
|
protected |
Camera orientation in billboard space.
Definition at line 200 of file OgreBillboardSet.h.
|
protected |
Camera axes in billboard space.
Definition at line 196 of file OgreBillboardSet.h.
|
protected |
Definition at line 196 of file OgreBillboardSet.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 150 of file OgreMovableObject.h.
|
protected |
Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON.
Definition at line 217 of file OgreBillboardSet.h.
|
protected |
Common up-vector for billboards of type BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON.
Definition at line 219 of file OgreBillboardSet.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 112 of file OgreMovableObject.h.
|
protected |
Flag indicating whether each billboard should be culled separately (default: false)
Definition at line 208 of file OgreBillboardSet.h.
|
protected |
Current camera.
Definition at line 192 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 415 of file OgreRenderable.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 121 of file OgreMovableObject.h.
|
protected |
Default height of each billboard.
Definition at line 130 of file OgreBillboardSet.h.
|
protected |
Default width of each billboard.
Definition at line 128 of file OgreBillboardSet.h.
|
private |
Is external billboard data in use?
Definition at line 298 of file OgreBillboardSet.h.
|
protected |
Free billboard queue.
Definition at line 173 of file OgreBillboardSet.h.
|
protected |
The vertex index data for all billboards in this set (1 set only)
Definition at line 205 of file OgreBillboardSet.h.
|
protected |
Parametric offsets of origin.
Definition at line 194 of file OgreBillboardSet.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 158 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 160 of file OgreMovableObject.h.
|
protectedinherited |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Definition at line 163 of file OgreMovableObject.h.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 155 of file OgreMovableObject.h.
|
protected |
Locked pointer to buffer.
Definition at line 186 of file OgreBillboardSet.h.
|
protected |
Shortcut to main buffer (positions, colours, texture coords)
Definition at line 184 of file OgreBillboardSet.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 114 of file OgreMovableObject.h.
|
protected |
Pointer to the material to use.
Definition at line 135 of file OgreBillboardSet.h.
|
protected |
Name of the material to use.
Definition at line 133 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 126 of file OgreMovableObject.h.
|
protectedinherited |
Name of this object.
Definition at line 110 of file OgreMovableObject.h.
|
protected |
Number of visible billboards (will be == getNumBillboards if mCullIndividual == false)
Definition at line 225 of file OgreBillboardSet.h.
|
protected |
Origin of each billboard.
Definition at line 123 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 117 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 116 of file OgreMovableObject.h.
|
protected |
Use point rendering?
Definition at line 288 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 416 of file OgreRenderable.h.
|
private |
The number of billboard in the pool.
Definition at line 296 of file OgreBillboardSet.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 140 of file OgreMovableObject.h.
|
staticprotected |
Definition at line 285 of file OgreBillboardSet.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 153 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 132 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 134 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 136 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 138 of file OgreMovableObject.h.
|
mutableprotectedinherited |
User objects binding.
Definition at line 420 of file OgreRenderable.h.
|
protected |
Definition at line 194 of file OgreBillboardSet.h.
|
protected |
Rotation type of each billboard.
Definition at line 125 of file OgreBillboardSet.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 167 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 169 of file OgreMovableObject.h.
|
protected |
Flag indicating whether the billboards has to be sorted.
Definition at line 144 of file OgreBillboardSet.h.
|
protectedinherited |
Definition at line 124 of file OgreMovableObject.h.
|
protected |
Definition at line 211 of file OgreBillboardSet.h.
|
protected |
Definition at line 194 of file OgreBillboardSet.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 123 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 417 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 418 of file OgreRenderable.h.
|
protectedinherited |
User objects binding.
Definition at line 130 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 419 of file OgreRenderable.h.
|
protected |
The vertex position data for all billboards in this set.
Definition at line 182 of file OgreBillboardSet.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 142 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 119 of file OgreMovableObject.h.
|
protected |
Boundary offsets based on origin and camera orientation Vector3 vLeftOff, vRightOff, vTopOff, vBottomOff; Final vertex offsets, used where sizes all default to save calcs.
Definition at line 190 of file OgreBillboardSet.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 144 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 146 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 148 of file OgreMovableObject.h.
|
protected |
Definition at line 150 of file OgreBillboardSet.h.