Allows the rendering of a chain of connected billboards. More...
#include <OgreBillboardChain.h>
Classes | |
struct | ChainSegment |
Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will be mMaxElementsPerChain * mChainCount long), by it's chain index, and a head and tail value which describe the current chain. More... | |
class | Element |
Contains the data of an element of the BillboardChain. More... | |
Public Types | |
typedef vector< Element >::type | ElementList |
typedef vector < ShadowRenderable * >::type | ShadowRenderableList |
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
enum | TexCoordDirection { TCD_U, TCD_V } |
The direction in which texture coordinates from elements of the chain are used. More... | |
Public Member Functions | |
BillboardChain (const String &name, size_t maxElements=20, size_t numberOfChains=1, bool useTextureCoords=true, bool useColours=true, bool dynamic=true) | |
Constructor (don't use directly, use factory) More... | |
virtual | ~BillboardChain () |
destructor More... | |
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 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 | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) More... | |
void | _notifyCurrentCamera (Camera *cam) |
Internal method to notify the object of the camera to be used for the next rendering operation. 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 | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More... | |
void | _updateRenderQueue (RenderQueue *) |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More... | |
virtual void | addChainElement (size_t chainIndex, const Element &billboardChainElement) |
Add an element to the 'head' of a chain. 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... | |
virtual void | clearAllChains (void) |
Remove all elements from all chains (but leave the chains themselves intact). More... | |
virtual void | clearChain (size_t chainIndex) |
Remove all elements of a given chain (but leave the chain intact). More... | |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. More... | |
virtual void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. More... | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
const AxisAlignedBox & | getBoundingBox (void) const |
Retrieves the local axis-aligned bounding box for this object. More... | |
Real | getBoundingRadius (void) const |
Retrieves the radius of the origin-centered bounding sphere for this object. 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 Element & | getChainElement (size_t chainIndex, size_t elementIndex) const |
Get the detail of a chain element. 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 bool | getDynamic (void) const |
Gets whether or not the buffers created for this object are suitable for dynamic alteration. 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... | |
const MaterialPtr & | getMaterial (void) const |
Retrieves a weak reference to the material this renderable object uses. More... | |
virtual const String & | getMaterialName (void) const |
Get the material name in use. More... | |
virtual size_t | getMaxChainElements (void) const |
Get the maximum number of chain elements per chain. More... | |
const String & | getMovableType (void) const |
Returns the type name of this object. More... | |
virtual const String & | getName (void) const |
Returns the name of this object. More... | |
virtual size_t | getNumberOfChains (void) const |
Get the number of chain segments (this class can render multiple chains at once using the same material). More... | |
virtual size_t | getNumChainElements (size_t chainIndex) const |
Returns the number of chain elements. More... | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. More... | |
virtual const Real * | getOtherTextureCoordRange (void) const |
Get the range of the texture coordinates generated across the width of the chain elements. 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 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... | |
void | getRenderOperation (RenderOperation &) |
Gets the render operation required to send this object to the frame buffer. More... | |
virtual uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
virtual RenderSystemData * | getRenderSystemData () const |
Sets render system private data. More... | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Returns the camera-relative squared depth of this renderable. More... | |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. More... | |
virtual TexCoordDirection | getTextureCoordDirection (void) |
Gets the direction in which texture coords specified on each element are deemed to run. More... | |
virtual uint32 | getTypeFlags (void) const |
Get the 'type flags' for this MovableObject. 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 const Any & | getUserAny (void) const |
virtual 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 bool | getUseTextureCoords (void) const |
Gets whether texture coordinate information should be included in the final buffers generated. More... | |
virtual bool | getUseVertexColours (void) const |
Gets whether vertex colour information should be included in the final buffers generated. 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... | |
void | getWorldTransforms (Matrix4 *) const |
Gets the world transform matrix / matrices for this renderable object. More... | |
bool | hasEdgeList (void) |
Define a default implementation of method from ShadowCaster which implements no shadows. 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 | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. 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 | removeChainElement (size_t chainIndex) |
Remove an element from the 'tail' of a chain. 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... | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. 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 | setDynamic (bool dyn) |
Sets whether or not the buffers created for this object are suitable for dynamic alteration. 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 | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Set the material name to use for rendering. More... | |
virtual void | setMaxChainElements (size_t maxElements) |
Set the maximum number of chain elements per chain. More... | |
virtual void | setNumberOfChains (size_t numChains) |
Set the number of chain segments (this class can render multiple chains at once using the same material). More... | |
virtual void | setOtherTextureCoordRange (Real start, Real end) |
Set the range of the texture coordinates generated across the width of the chain elements. 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 | 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 | 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 |
gets render system private data More... | |
virtual void | setTextureCoordDirection (TexCoordDirection dir) |
Sets the direction in which texture coords specified on each element are deemed to run along the length of the chain. 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 void | setUserAny (const Any &anything) |
virtual void | setUserAny (const Any &anything) |
virtual void | setUseTextureCoords (bool use) |
Sets whether texture coordinate information should be included in the final buffers generated. More... | |
virtual void | setUseVertexColours (bool use) |
Sets whether vertex colour information should be included in the final buffers generated. More... | |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visiblity 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... | |
virtual void | updateChainElement (size_t chainIndex, size_t elementIndex, const Element &billboardChainElement) |
Update the details of an existing chain element. 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 map< String, StringVector >::type | AnimableDictionaryMap |
typedef vector< ChainSegment > ::type | ChainSegmentList |
typedef map< size_t, Vector4 > ::type | CustomParameterMap |
Protected Member Functions | |
StringVector & | _getAnimableValueNames (void) |
Get an updateable reference to animable value list. 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... | |
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, 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... | |
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... | |
virtual void | initialiseAnimableDictionary (StringVector &) const |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More... | |
virtual void | setupBuffers (void) |
virtual void | setupChainContainers (void) |
Setup the STL collections. More... | |
virtual void | setupVertexDeclaration (void) |
Setup vertex declaration. More... | |
virtual void | updateBoundingBox (void) const |
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... | |
virtual void | updateIndexBuffer (void) |
Update the contents of the index buffer. More... | |
virtual void | updateVertexBuffer (Camera *cam) |
Update the contents of the vertex buffer. More... | |
Protected Attributes | |
AxisAlignedBox | mAABB |
AABB. More... | |
bool | mBeyondFarDistance |
Hidden because of distance? More... | |
bool | mBoundsDirty |
Do the bounds need redefining? More... | |
bool | mBuffersNeedRecreating |
Do the buffers need recreating? More... | |
bool | mCastShadows |
Does this object cast shadows? More... | |
size_t | mChainCount |
Number of chains. More... | |
ElementList | mChainElementList |
The list holding the chain elements. More... | |
ChainSegmentList | mChainSegmentList |
MovableObjectFactory * | mCreator |
Creator of this object (if created by a factory) More... | |
CustomParameterMap | mCustomParameters |
bool | mDebugDisplay |
Is debug display enabled? More... | |
bool | mDynamic |
Dynamic use? More... | |
bool | mIndexContentDirty |
Is the index buffer dirty? More... | |
IndexData * | mIndexData |
Index data (to allow multiple unconnected chains) 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... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
MaterialPtr | mMaterial |
String | mMaterialName |
Material. More... | |
size_t | mMaxElementsPerChain |
Maximum length of each chain. More... | |
String | mName |
Name of this object. More... | |
Real | mOtherTexCoordRange [2] |
Other texture coord range. More... | |
bool | mParentIsTagPoint |
Node * | mParentNode |
node to which this object is attached More... | |
bool | mPolygonModeOverrideable |
uint32 | mQueryFlags |
Flags determining whether this object is included / excluded from scene queries. More... | |
Real | mRadius |
Bounding radius. 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 |
Real | mSquaredUpperDistance |
TexCoordDirection | mTexCoordDir |
Texture coord direction. More... | |
Real | mUpperDistance |
Upper distance to still render. More... | |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
User objects binding. More... | |
UserObjectBindings | mUserObjectBindings |
bool | mUseTexCoords |
Use texture coords? More... | |
bool | mUseVertexColour |
Use vertex colour? More... | |
VertexData * | mVertexData |
Vertex data. More... | |
bool | mVertexDeclDirty |
Is the vertex declaration dirty? More... | |
uint32 | mVisibilityFlags |
Flags determining whether this object is visible (compared to SceneManager mask) More... | |
bool | mVisible |
Is this object visible? More... | |
AxisAlignedBox | mWorldAABB |
Cached world AABB of this object. More... | |
Sphere | mWorldBoundingSphere |
AxisAlignedBox | mWorldDarkCapBounds |
World space AABB of this object's dark cap. More... | |
Static Protected Attributes | |
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... | |
static const size_t | SEGMENT_EMPTY |
Chain segment has no elements. More... | |
Allows the rendering of a chain of connected billboards.
Definition at line 76 of file OgreBillboardChain.h.
|
protectedinherited |
Definition at line 240 of file OgreAnimable.h.
|
protected |
Definition at line 313 of file OgreBillboardChain.h.
|
protectedinherited |
Definition at line 395 of file OgreRenderable.h.
typedef vector<Element>::type Ogre::BillboardChain::ElementList |
Definition at line 102 of file OgreBillboardChain.h.
|
inherited |
Definition at line 128 of file OgreShadowCaster.h.
|
inherited |
Definition at line 129 of file OgreShadowCaster.h.
The direction in which texture coordinates from elements of the chain are used.
Enumerator | |
---|---|
TCD_U |
Tex coord in elements is treated as the 'u' texture coordinate. |
TCD_V |
Tex coord in elements is treated as the 'v' texture coordinate. |
Definition at line 147 of file OgreBillboardChain.h.
Ogre::BillboardChain::BillboardChain | ( | const String & | name, |
size_t | maxElements = 20 , |
||
size_t | numberOfChains = 1 , |
||
bool | useTextureCoords = true , |
||
bool | useColours = true , |
||
bool | dynamic = true |
||
) |
Constructor (don't use directly, use factory)
name | The name to give this object |
maxElements | The maximum number of elements per chain |
numberOfChains | The number of separate chain segments contained in this object |
useTextureCoords | If true, use texture coordinates from the chain elements |
useVertexColours | If true, use vertex colours from the chain elements |
dynamic | If true, buffers are created with the intention of being updated |
|
virtual |
destructor
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 266 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 183 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 472 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 187 of file OgreMovableObject.h.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
|
virtualinherited |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, and Ogre::PortalBase.
Referenced by Ogre::PortalBase::_notifyAttached().
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 181 of file OgreMovableObject.h.
|
virtual |
Internal method to notify the object of the camera to be used for the next rendering operation.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 185 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, and Ogre::PCZLight.
|
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::TerrainRenderable, Ogre::TerrainZoneRenderable, and Ogre::SubEntity.
Definition at line 288 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
virtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
|
virtual |
Add an element to the 'head' of a chain.
chainIndex | The index of the chain |
billboardChainElement | The details to add |
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 377 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 405 of file OgreMovableObject.h.
|
virtual |
Remove all elements from all chains (but leave the chains themselves intact).
|
virtual |
Remove all elements of a given chain (but leave the chain intact).
Reimplemented in Ogre::RibbonTrail.
|
inlineprotectedinherited |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 253 of file OgreAnimable.h.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 319 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
|
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 |
|
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. |
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 |
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 248 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
inlineinherited |
Gets a list of animable value names for this object.
Definition at line 294 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtual |
Retrieves the local axis-aligned bounding box for this object.
Implements Ogre::MovableObject.
|
virtual |
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 502 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 223 of file OgreRenderable.h.
|
virtual |
Get the detail of a chain element.
chainIndex | The index of the chain |
elementIndex | The element index within the chain, measured from the 'head' of the chain |
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
see setCustomParameter for full details. |
Definition at line 249 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 392 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 420 of file OgreMovableObject.h.
|
inlinevirtual |
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
Definition at line 195 of file OgreBillboardChain.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 475 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 457 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 431 of file OgreMovableObject.h.
|
virtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
|
inlinevirtual |
Get the material name in use.
Definition at line 235 of file OgreBillboardChain.h.
|
inlinevirtual |
Get the maximum number of chain elements per chain.
Definition at line 122 of file OgreBillboardChain.h.
|
virtual |
Returns the type name of this object.
Implements Ogre::MovableObject.
Reimplemented in Ogre::RibbonTrail.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 190 of file OgreMovableObject.h.
|
inlinevirtual |
Get the number of chain segments (this class can render multiple chains at once using the same material).
Definition at line 130 of file OgreBillboardChain.h.
|
virtual |
Returns the number of chain elements.
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 152 of file OgreRenderable.h.
|
inlinevirtual |
Get the range of the texture coordinates generated across the width of the chain elements.
Definition at line 173 of file OgreBillboardChain.h.
|
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 313 of file OgreRenderable.h.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 384 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 301 of file OgreMovableObject.h.
|
virtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlinevirtualinherited |
Sets render system private data.
Definition at line 380 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.
Returns the camera-relative squared depth of this renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 93 of file OgreRenderable.h.
|
inlinevirtual |
Gets the direction in which texture coords specified on each element are deemed to run.
Definition at line 162 of file OgreBillboardChain.h.
|
virtualinherited |
Get the 'type flags' for this MovableObject.
Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::ParticleSystem, Ogre::Frustum, Ogre::StaticGeometry::Region, Ogre::Light, Ogre::TerrainRenderable, and Ogre::TerrainZoneRenderable.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 177 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 202 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 315 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Definition at line 330 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 321 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 327 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 336 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 342 of file OgreRenderable.h.
|
inlinevirtual |
Gets whether texture coordinate information should be included in the final buffers generated.
Definition at line 142 of file OgreBillboardChain.h.
|
inlinevirtual |
Gets whether vertex colour information should be included in the final buffers generated.
Definition at line 185 of file OgreBillboardChain.h.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 412 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 |
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 477 of file OgreMovableObject.h.
|
inlineprotectedvirtualinherited |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light.
Definition at line 286 of file OgreAnimable.h.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 546 of file OgreMovableObject.h.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 213 of file OgreMovableObject.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.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 127 of file OgreRenderable.h.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Definition at line 122 of file OgreRenderable.h.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
virtual |
Remove an element from the 'tail' of a chain.
chainIndex | The index of the chain |
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 381 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 409 of file OgreMovableObject.h.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 500 of file OgreMovableObject.h.
|
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 240 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 544 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 388 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 416 of file OgreMovableObject.h.
|
virtual |
Sets whether or not the buffers created for this object are suitable for dynamic alteration.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 427 of file OgreMovableObject.h.
|
virtual |
Set the material name to use for rendering.
|
virtual |
Set the maximum number of chain elements per chain.
Reimplemented in Ogre::RibbonTrail.
|
virtual |
Set the number of chain segments (this class can render multiple chains at once using the same material).
Reimplemented in Ogre::RibbonTrail.
Set the range of the texture coordinates generated across the width of the chain elements.
start | Start coordinate, default 0.0 |
end | End coordinate, default 1.0 |
|
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 305 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 373 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 295 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::Entity.
|
inlinevirtualinherited |
gets render system private data
Definition at line 388 of file OgreRenderable.h.
|
virtual |
Sets the direction in which texture coords specified on each element are deemed to run along the length of the chain.
dir | The direction, default is TCD_U. |
|
protectedvirtual |
|
protectedvirtual |
Setup the STL collections.
|
protectedvirtual |
Setup vertex declaration.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 163 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 188 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 310 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 325 of file OgreRenderable.h.
|
virtual |
Sets whether texture coordinate information should be included in the final buffers generated.
|
virtual |
Sets whether vertex colour information should be included in the final buffers generated.
|
inlinevirtualinherited |
Sets the visiblity flags for this object.
Definition at line 401 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
|
protectedvirtual |
|
virtual |
Update the details of an existing chain element.
chainIndex | The index of the chain |
elementIndex | The element index within the chain, measured from the 'head' of the chain |
billboardChainElement | The details to set |
|
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 |
|
protectedvirtual |
Update the contents of the index buffer.
|
protectedvirtual |
Update the contents of the vertex buffer.
|
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.
|
mutableprotected |
AABB.
Definition at line 282 of file OgreBillboardChain.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 125 of file OgreMovableObject.h.
|
mutableprotected |
Do the bounds need redefining?
Definition at line 278 of file OgreBillboardChain.h.
|
protected |
Do the buffers need recreating?
Definition at line 276 of file OgreBillboardChain.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 147 of file OgreMovableObject.h.
|
protected |
Number of chains.
Definition at line 262 of file OgreBillboardChain.h.
|
protected |
The list holding the chain elements.
Definition at line 295 of file OgreBillboardChain.h.
|
protected |
Definition at line 314 of file OgreBillboardChain.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 111 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 396 of file OgreRenderable.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 120 of file OgreMovableObject.h.
|
protected |
Dynamic use?
Definition at line 268 of file OgreBillboardChain.h.
|
protected |
Is the index buffer dirty?
Definition at line 280 of file OgreBillboardChain.h.
|
protected |
Index data (to allow multiple unconnected chains)
Definition at line 272 of file OgreBillboardChain.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 155 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 157 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 160 of file OgreMovableObject.h.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 152 of file OgreMovableObject.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 113 of file OgreMovableObject.h.
|
protected |
Definition at line 287 of file OgreBillboardChain.h.
|
protected |
Definition at line 286 of file OgreBillboardChain.h.
|
protected |
Maximum length of each chain.
Definition at line 260 of file OgreBillboardChain.h.
|
protectedinherited |
Name of this object.
Definition at line 109 of file OgreMovableObject.h.
|
protected |
Other texture coord range.
Definition at line 291 of file OgreBillboardChain.h.
|
protectedinherited |
Definition at line 116 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 115 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 397 of file OgreRenderable.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 137 of file OgreMovableObject.h.
|
mutableprotected |
Bounding radius.
Definition at line 284 of file OgreBillboardChain.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 150 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 129 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 131 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 133 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 135 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 401 of file OgreRenderable.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 242 of file OgreAnimable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 164 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 166 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 123 of file OgreMovableObject.h.
|
protected |
Texture coord direction.
Definition at line 289 of file OgreBillboardChain.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 122 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 398 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 399 of file OgreRenderable.h.
|
protectedinherited |
User objects binding.
Definition at line 127 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 400 of file OgreRenderable.h.
|
protected |
Use texture coords?
Definition at line 264 of file OgreBillboardChain.h.
|
protected |
Use vertex colour?
Definition at line 266 of file OgreBillboardChain.h.
|
protected |
Vertex data.
Definition at line 270 of file OgreBillboardChain.h.
|
protected |
Is the vertex declaration dirty?
Definition at line 274 of file OgreBillboardChain.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 139 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 118 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 141 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 143 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 145 of file OgreMovableObject.h.
|
staticprotected |
Chain segment has no elements.
Definition at line 329 of file OgreBillboardChain.h.