![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
Allows the rendering of a chain of connected billboards. More...
#include <OgreBillboardChain.h>
Classes | |
class | Element |
Contains the data of an element of the BillboardChain. More... | |
Public Types | |
typedef std::vector< Element > | ElementList |
enum | TexCoordDirection { TCD_U , TCD_V } |
The direction in which texture coordinates from elements of the chain are used. More... | |
![]() | |
typedef std::vector< ShadowRenderable * > | ShadowRenderableList |
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator |
![]() | |
enum | { DEFAULT_PRIORITY = 100 } |
typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr |
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) | |
~BillboardChain () | |
void | _updateRenderQueue (RenderQueue *) |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue. | |
virtual void | addChainElement (size_t chainIndex, const Element &billboardChainElement) |
Add an element to the 'head' of a chain. | |
virtual void | clearAllChains (void) |
Remove all elements from all chains (but leave the chains themselves intact). | |
virtual void | clearChain (size_t chainIndex) |
Remove all elements of a given chain (but leave the chain intact). | |
const AxisAlignedBox & | getBoundingBox (void) const |
Retrieves the local axis-aligned bounding box for this object. | |
Real | getBoundingRadius (void) const |
Retrieves the radius of the origin-centered bounding sphere for this object. | |
virtual const Element & | getChainElement (size_t chainIndex, size_t elementIndex) const |
Get the detail of a chain element. | |
virtual bool | getDynamic (void) const |
Gets whether or not the buffers created for this object are suitable for dynamic alteration. | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. | |
const MaterialPtr & | getMaterial (void) const |
Retrieves a weak reference to the material this renderable object uses. | |
virtual const String & | getMaterialName (void) const |
Get the material name in use. | |
virtual size_t | getMaxChainElements (void) const |
Get the maximum number of chain elements per chain. | |
const String & | getMovableType (void) const |
Returns the type name of this object. | |
virtual size_t | getNumberOfChains (void) const |
Get the number of chain segments (this class can render multiple chains at once using the same material). | |
virtual size_t | getNumChainElements (size_t chainIndex) const |
Returns the number of chain elements. | |
virtual const Real * | getOtherTextureCoordRange (void) const |
Get the range of the texture coordinates generated across the width of the chain elements. | |
void | getRenderOperation (RenderOperation &) |
Gets the render operation required to send this object to the frame buffer. | |
Real | getSquaredViewDepth (const Camera *cam) const |
Returns the camera-relative squared depth of this renderable. | |
virtual TexCoordDirection | getTextureCoordDirection (void) |
Gets the direction in which texture coords specified on each element are deemed to run. | |
virtual bool | getUseTextureCoords (void) const |
Gets whether texture coordinate information should be included in the final buffers generated. | |
virtual bool | getUseVertexColours (void) const |
Gets whether vertex colour information should be included in the final buffers generated. | |
void | getWorldTransforms (Matrix4 *) const |
Gets the world transform matrix / matrices for this renderable object. | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
virtual void | removeChainElement (size_t chainIndex) |
Remove an element from the 'tail' of a chain. | |
virtual void | setDynamic (bool dyn) |
Sets whether or not the buffers created for this object are suitable for dynamic alteration. | |
void | setFaceCamera (bool faceCamera, const Vector3 &normalVector=Vector3::UNIT_X) |
Sets whether the billboard should always be facing the camera or a custom direction set by each point element. | |
virtual void | setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Set the material name to use for rendering. | |
virtual void | setMaxChainElements (size_t maxElements) |
Set the maximum number of chain elements per chain. | |
virtual void | setNumberOfChains (size_t numChains) |
Set the number of chain segments (this class can render multiple chains at once using the same material). | |
virtual void | setOtherTextureCoordRange (Real start, Real end) |
Set the range of the texture coordinates generated across the width of the chain elements. | |
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. | |
virtual void | setUseTextureCoords (bool use) |
Sets whether texture coordinate information should be included in the final buffers generated. | |
virtual void | setUseVertexColours (bool use) |
Sets whether vertex colour information should be included in the final buffers generated. | |
virtual void | updateChainElement (size_t chainIndex, size_t elementIndex, const Element &billboardChainElement) |
Update the details of an existing chain element. | |
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. | |
![]() | |
MovableObject () | |
Constructor. | |
MovableObject (const String &name) | |
Named constructor. | |
virtual | ~MovableObject () |
Virtual destructor - read Scott Meyers if you don't know why this is needed. | |
MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) | |
LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. | |
SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) | |
virtual const Affine3 & | _getParentNodeFullTransform (void) const |
Return the full transformation of the parent sceneNode or the attachingPoint node. | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) | |
virtual void | _notifyCurrentCamera (Camera *cam) |
Internal method to notify the object of the camera to be used for the next rendering operation. | |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. | |
virtual void | _releaseManualHardwareResources () |
Notifies the movable object that hardware resources were lost. | |
virtual void | _restoreManualHardwareResources () |
Notifies the movable object that hardware resources should be restored. | |
void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. | |
Real | getBoundingRadiusScaled () const |
as getBoundingRadius, but with scaling applied | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override |
Gets the world space bounding box of the dark cap, as extruded using the light provided. | |
EdgeData * | getEdgeList (void) |
Returns details of the edges which might be used to determine a silhouette. | |
const AxisAlignedBox & | getLightCapBounds (void) const override |
Gets the world space bounding box of the light cap. | |
uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. | |
Listener * | getListener (void) const |
Gets the current listener for this object. | |
const String & | getName (void) const |
Returns the name of this object. | |
Node * | getParentNode (void) const |
Returns the node to which this object is attached. | |
SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant for this object. | |
bool | getReceivesShadows () |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. | |
Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. | |
Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity. | |
const ShadowRenderableList & | getShadowVolumeRenderableList (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. | |
virtual uint32 | getTypeFlags (void) const |
Get the 'type flags' for this MovableObject. | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. | |
bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. | |
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. | |
bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. | |
bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. | |
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. | |
bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. | |
const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. | |
void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. | |
void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. | |
void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. | |
void | setListener (Listener *listener) |
Sets a listener for this object. | |
void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. | |
void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. | |
void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
virtual void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this entity will be rendered through. | |
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this entity will be rendered through. | |
void | setUserAny (const Any &anything) |
void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. | |
void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. | |
![]() | |
virtual | ~ShadowCaster () |
virtual ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0) |
bool | hasEdgeList () |
Returns whether the object has a valid edge list. | |
![]() | |
AnimableObject () | |
virtual | ~AnimableObject () |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. | |
![]() | |
Renderable () | |
virtual | ~Renderable () |
Virtual destructor needed as class has virtual methods. | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | |
virtual bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. | |
bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
const RenderSystemDataPtr & | getRenderSystemData () const |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. | |
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. | |
void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
void | setRenderSystemData (RenderSystemDataPtr val) const |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
void | setUserAny (const Any &anything) |
Additional Inherited Members | |
![]() | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. | |
![]() | |
static void | clearShadowRenderableList (ShadowRenderableList &shadowRenderables) |
Common implementation of releasing shadow renderables. | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. | |
Allows the rendering of a chain of connected billboards.
typedef std::vector<Element> Ogre::BillboardChain::ElementList |
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 |
useColours | If true, use vertex colours from the chain elements |
dynamic | If true, buffers are created with the intention of being updated |
Ogre::BillboardChain::~BillboardChain | ( | ) |
Set the maximum number of chain elements per chain.
Reimplemented in Ogre::RibbonTrail.
Get the maximum number of chain elements per chain.
Set the number of chain segments (this class can render multiple chains at once using the same material).
Reimplemented in Ogre::RibbonTrail.
Get the number of chain segments (this class can render multiple chains at once using the same material).
Sets whether texture coordinate information should be included in the final buffers generated.
Gets whether texture coordinate information should be included in the final buffers generated.
|
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. |
|
inlinevirtual |
Gets the direction in which texture coords specified on each element are deemed to run.
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 |
Get the range of the texture coordinates generated across the width of the chain elements.
Sets whether vertex colour information should be included in the final buffers generated.
Gets whether vertex colour information should be included in the final buffers generated.
Sets whether or not the buffers created for this object are suitable for dynamic alteration.
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
|
virtual |
Add an element to the 'head' of a chain.
chainIndex | The index of the chain |
billboardChainElement | The details to add |
Remove an element from the 'tail' of a chain.
chainIndex | The index of the chain |
|
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 |
|
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 |
Returns the number of chain elements.
Remove all elements of a given chain (but leave the chain intact).
Reimplemented in Ogre::RibbonTrail.
Remove all elements from all chains (but leave the chains themselves intact).
void Ogre::BillboardChain::setFaceCamera | ( | bool | faceCamera, |
const Vector3 & | normalVector = Vector3::UNIT_X |
||
) |
Sets whether the billboard should always be facing the camera or a custom direction set by each point element.
faceCamera | True to be always facing the camera (Default value: True) |
normalVector | Only used when faceCamera == false. Must be a non-zero vector. This vector is the "point of reference" for each point orientation. For example, if normalVector is Vector3::UNIT_Z, and the point's orientation is an identity matrix, the segment corresponding to that point will be facing towards UNIT_Z This vector is internally normalized. |
Get the material name in use.
|
virtual |
Set the material name to use for rendering.
Returns the camera-relative squared depth of this renderable.
Implements Ogre::Renderable.
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
|
virtual |
Retrieves the local axis-aligned bounding box for this object.
Implements Ogre::MovableObject.
|
virtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
Returns the type name of this object.
Implements Ogre::MovableObject.
Reimplemented in Ogre::RibbonTrail.
|
virtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
|
virtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
|
virtual |
Called just prior to the Renderable being rendered.
Reimplemented from Ogre::Renderable.
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
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.