OGRE-Next
2.3
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 map< size_t, Vector4 >::type | CustomParameterMap |
typedef vector< Element >::type | ElementList |
typedef FastArray< MovableObject * > | MovableObjectArray |
@See SceneManager::cullFrustum More... | |
enum | TexCoordDirection { TCD_U , TCD_V } |
The direction in which texture coordinates from elements of the chain are used. More... | |
Public Member Functions | |
BillboardChain (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, 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... | |
LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. More... | |
SceneManager * | _getManager () const |
Get the manager of this object, if any (internal use only) More... | |
ObjectData & | _getObjectData () |
Returns a direct access to the ObjectData state. More... | |
const Matrix4 & | _getParentNodeFullTransform () const |
Returns the full transformation of the parent sceneNode or the attachingPoint node. More... | |
virtual void | _notifyAttached (Node *parent) |
Internal method called to notify the object that it has been attached to a node. More... | |
void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) More... | |
virtual void | _notifyParentNodeMemoryChanged () |
@See Node::_callMemoryChangeListeners More... | |
virtual void | _notifyStaticDirty () const |
Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More... | |
virtual void | _releaseManualHardwareResources () |
Notifies the movable object that hardware resources were lost. More... | |
virtual void | _restoreManualHardwareResources () |
Notifies the movable object that hardware resources should be restored. More... | |
virtual void | _setHlmsHashes (uint32 hash, uint32 casterHash) |
Manually sets the hlms hashes. Don't call this directly. More... | |
virtual void | _setNullDatablock () |
Sets the datablock to a null pointer. 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 *, Camera *camera, const Camera *lodCamera) override |
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... | |
void | addPoseWeight (size_t index, float w) |
void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
virtual void | clearAllChains () |
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... | |
void | detachFromParent () |
Detaches an object from a parent SceneNode if attached. More... | |
const StringVector & | getAnimableValueNames () const |
Gets a list of animable value names for this object. More... | |
const AxisAlignedBox & | getBoundingBox () const |
RealAsUint | getCachedDistanceToCamera () const |
Returns the distance to camera as calculated in @cullFrustum. More... | |
Real | getCachedDistanceToCameraAsReal () const |
Returns the distance to camera as calculated in @cullFrustum. More... | |
bool | getCastShadows () const |
Returns whether shadow casting is enabled for this object. More... | |
virtual bool | getCastsShadows () 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... | |
uint8 | getCurrentMaterialLod () const |
unsigned char | getCurrentMeshLod () const |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const CustomParameterMap & | getCustomParameters () const |
HlmsDatablock * | getDatablock () const |
const String & | getDatablockOrMaterialName () const |
virtual bool | getDynamic () const |
Gets whether or not the buffers created for this object are suitable for dynamic alteration. More... | |
uint32 | getHlmsCasterHash () const |
uint32 | getHlmsHash () const |
IdType | getId () const |
Get the unique id of this object. More... | |
uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
const LightList & | getLights () const override |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
Listener * | getListener () const |
Gets the current listener for this object. More... | |
Aabb | getLocalAabb () const |
Retrieves the local axis-aligned bounding box for this object. More... | |
float | getLocalRadius () const |
See getLocalAabb and getWorldRadius. More... | |
MaterialPtr | getMaterial () const |
Retrieves the material this renderable object uses. More... | |
virtual size_t | getMaxChainElements () const |
Get the maximum number of chain elements per chain. More... | |
const String & | getMovableType () const override |
Returns the type name of this object. More... | |
const String & | getName () const |
Returns the name of this object. More... | |
virtual size_t | getNumberOfChains () 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... | |
unsigned short | getNumPoses () const |
virtual unsigned short | getNumWorldTransforms () const |
Returns the number of world transform matrices this renderable requires. More... | |
virtual const Real * | getOtherTextureCoordRange () const |
Get the range of the texture coordinates generated across the width of the chain elements. More... | |
Node * | getParentNode () const |
Returns the node to which this object is attached. More... | |
SceneNode * | getParentSceneNode () const |
virtual bool | getPolygonModeOverrideable () const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
bool | getPoseHalfPrecision () const |
bool | getPoseNormals () const |
TexBufferPacked * | getPoseTexBuffer () const |
float | getPoseWeight (size_t index) const |
float * | getPoseWeights () const |
uint32 | getQueryFlags () const |
Returns the query flags relevant for this object. More... | |
Real | getRenderingDistance () const |
Gets the distance at which batches are no longer rendered. More... | |
Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
void | getRenderOperation (RenderOperation &, bool casterPass) override |
Gets the render operation required to send this object to the frame buffer. More... | |
uint8 | getRenderQueueGroup () const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
uint8 | getRenderQueueSubGroup () const |
Real | getShadowRenderingDistance () const |
Gets the distance at which batches are no longer casting shadows. More... | |
SkeletonInstance * | getSkeletonInstance () const |
Real | getSquaredViewDepth (const Camera *cam) const |
virtual TexCoordDirection | getTextureCoordDirection () |
Gets the direction in which texture coords specified on each element are deemed to run. More... | |
bool | getUseIdentityProjection () const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView () const |
Returns whether or not to use an 'identity' view. More... | |
virtual bool | getUseIdentityViewProjMatrixIsDynamic () const |
Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More... | |
virtual bool | getUseIdentityWorldMatrix () const |
Returns whether the world matrix is an identity matrix. More... | |
virtual OGRE_DEPRECATED const Any & | getUserAny () const |
UserObjectBindings & | getUserObjectBindings () |
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... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual bool | getUseTextureCoords () const |
Gets whether texture coordinate information should be included in the final buffers generated. More... | |
virtual bool | getUseVertexColours () const |
Gets whether vertex colour information should be included in the final buffers generated. More... | |
const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
uint32 | getVisibilityFlags () const |
Returns the visibility flags relevant for this object. More... | |
bool | getVisible () const |
Gets this object whether to be visible or not, if it has a renderable component. More... | |
Aabb | getWorldAabb () const |
Gets the axis aligned box in world space. More... | |
Aabb | getWorldAabbUpdated () |
Gets the axis aligned box in world space. More... | |
float | getWorldRadius () const |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More... | |
float | getWorldRadiusUpdated () |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More... | |
void | getWorldTransforms (Matrix4 *) const override |
Gets the world transform matrix / matrices for this renderable object. More... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. More... | |
bool | hasSkeletonAnimation () const |
virtual void | instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags) |
@See InstancingTheadedCullingMethod, More... | |
bool | isAttached () const |
Returns true if this object is attached to a Node. More... | |
bool | isStatic () const |
Checks whether this MovableObject is static. @See setStatic. More... | |
bool | isVisible () 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, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
bool | operator() (const IdObject &left, const IdObject &right) |
bool | operator() (const IdObject *left, const IdObject *right) |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. More... | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) override |
Called just prior to the Renderable being rendered. More... | |
const LightList & | queryLights () 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... | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. More... | |
void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
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 | setDatablock (HlmsDatablock *datablock) |
Assigns a datablock (i.e. HLMS Material) to this renderable. More... | |
void | setDatablock (IdString datablockName) |
Assigns a datablock (i.e. More... | |
void | setDatablockOrMaterialName (String materialName, String groupName) |
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. More... | |
virtual void | setDynamic (bool dyn) |
Sets whether or not the buffers created for this object are suitable for dynamic alteration. More... | |
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. More... | |
void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. More... | |
void | setListener (Listener *listener) |
Sets a listener for this object. More... | |
void | setLocalAabb (const Aabb box) |
Sets the local axis-aligned bounding box for this object. More... | |
virtual void | setMaterial (const MaterialPtr &material) |
Sets the given material. Overrides HLMS materials. More... | |
void | setMaterialName (const String &name, const String &groupName) |
Sets the name of the Material to be used. Prefer using HLMS @See setHlms. More... | |
virtual void | setMaxChainElements (size_t maxElements) |
Set the maximum number of chain elements per chain. More... | |
void | setName (const String &name) |
Sets a custom name for this node. 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... | |
void | setPoseWeight (size_t index, float w) |
void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. More... | |
void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. More... | |
void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this entity will be rendered through. More... | |
void | setRenderQueueSubGroup (uint8 subGroup) |
Sets the render queue sub group. More... | |
void | setShadowRenderingDistance (Real dist) |
Sets the distance at which the object is no longer casting shadows. More... | |
bool | setStatic (bool bStatic) |
Turns this Node into static or dynamic. 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 OGRE_DEPRECATED 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... | |
void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. More... | |
void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. More... | |
virtual void | updateChainElement (size_t chainIndex, size_t elementIndex, const Element &billboardChainElement) |
Update the details of an existing chain element. More... | |
Static Public Member Functions | |
static void | buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList) |
@See SceneManager::buildLightList More... | |
static ArrayReal | calculateCameraDistance (uint32 _cameraSortMode, const ArrayVector3 &cameraPos, const ArrayVector3 &cameraDir, ArrayAabb *RESTRICT_ALIAS worldAabb, ArrayReal *RESTRICT_ALIAS worldRadius) |
static void | calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox) |
static void | cullFrustum (const size_t numNodes, ObjectData t, const Camera *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera) |
static void | cullLights (const size_t numNodes, ObjectData t, uint32 sceneLightMask, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums) |
@See SceneManager::cullLights & More... | |
static uint32 | getDefaultLightMask () |
Get the default light mask for all future MovableObject instances. More... | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. More... | |
static uint8 | getDefaultRenderQueueSubGroup () |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. More... | |
static void | setDefaultLightMask (uint32 mask) |
Set the default light mask for all future MovableObject instances. More... | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. More... | |
static void | setDefaultRenderQueueSubGroup (uint8 subGroup) |
Sets the default render queue sub group for all future Renderable instances. More... | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. More... | |
static void | updateAllBounds (const size_t numNodes, ObjectData t) |
@See SceneManager::updateAllBounds More... | |
Public Attributes | |
uint8 | mCustomParameter |
Only valid when using low level materials. More... | |
size_t | mGlobalIndex |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More... | |
uint32 | mHlmsGlobalIndex |
Index in the vector holding this Rendrable reference in the HLMS datablock. More... | |
size_t | mParentIndex |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More... | |
RenderableArray | mRenderables |
bool | mRenderableVisible |
Control visibility at Renderable (e.g. More... | |
Static Public Attributes | |
static const FastArray< Real > | c_DefaultLodMesh |
Allows the rendering of a chain of connected billboards.
|
inherited |
typedef vector<Element>::type Ogre::v1::BillboardChain::ElementList |
|
inherited |
@See SceneManager::cullFrustum
frustum | Frustum to clip against |
sceneVisibilityFlags | Combined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters. |
outCulledObjects | Out. List of objects that are (fully or partially) inside the frustum and should be rendered |
lodCamera | Camera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance |
Ogre::v1::BillboardChain::BillboardChain | ( | IdType | id, |
ObjectMemoryManager * | objectMemoryManager, | ||
SceneManager * | manager, | ||
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 |
|
virtual |
Destructor.
|
inlineinherited |
Returns a pointer to the current list of lights for this object.
|
inlineinherited |
Get the manager of this object, if any (internal use only)
|
inlineinherited |
Returns a direct access to the ObjectData state.
|
inherited |
Returns 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::ParticleSystem, and Ogre::v1::Entity.
|
inlineinherited |
Notify the object of it's manager (internal use only)
|
inlinevirtualinherited |
@See Node::_callMemoryChangeListeners
Reimplemented in Ogre::Item.
|
inlinevirtualinherited |
Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.
|
inlinevirtualinherited |
Notifies the movable object that hardware resources were lost.
Reimplemented in Ogre::v1::Rectangle2D, Ogre::ManualObject, Ogre::v1::ManualObject, and Ogre::v1::BillboardSet.
|
inlinevirtualinherited |
Notifies the movable object that hardware resources should be restored.
Reimplemented in Ogre::v1::Rectangle2D.
Manually sets the hlms hashes. Don't call this directly.
Reimplemented in Ogre::SubItem.
|
virtualinherited |
Sets the datablock to a null pointer.
Use case: If you will be destroying an HlmsDatablock and all Renderables associated by it; it makes no sense to change the Renderable's datablock to a default one, only to be destroyed immediately after (you pay an unnecessary performance price).
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BillboardSet.
|
virtualinherited |
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::v1::SubEntity.
|
overridevirtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Reimplemented from Ogre::MovableObject.
|
virtual |
Add an element to the 'head' of a chain.
chainIndex | The index of the chain |
billboardChainElement | The details to add |
|
inherited |
|
inlineinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
|
inlineinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
|
staticinherited |
@See SceneManager::buildLightList
globalLightList | List of lights already culled against all possible frustums and reorganized contiguously for SoA |
|
inlinestaticinherited |
|
staticinherited |
|
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::v1::RibbonTrail.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
staticinherited |
|
staticinherited |
@See SceneManager::cullLights &
outGlobalLightList | Output, a list of lights, contiguously placed |
frustums | An array of all frustums we need to check against |
cubemapFrustums | An array of all frustums that are used at least once as cubemaps (@See SceneManager::createCamera) |
|
inherited |
Detaches an object from a parent SceneNode if attached.
|
inlineinherited |
Gets a list of animable value names for this object.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
const AxisAlignedBox& Ogre::v1::BillboardChain::getBoundingBox | ( | ) | const |
|
inlineinherited |
Returns the distance to camera as calculated in @cullFrustum.
|
inlineinherited |
Returns the distance to camera as calculated in @cullFrustum.
|
inlineinherited |
Returns whether shadow casting is enabled for this object.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::WireAabb, Ogre::SubItem, Ogre::v1::SubEntity, Ogre::Rectangle2D, Ogre::ManualObject::ManualObjectSection, Ogre::VoxelVisualizer, and Ogre::IfdProbeVisualizer.
|
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 |
|
inlineinherited |
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inlinestaticinherited |
Get the default light mask for all future MovableObject instances.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
|
inlinestaticinherited |
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
|
inlinevirtual |
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Get the unique id of this object.
|
inlineinherited |
Get a bitwise mask which will filter the lights affecting this object.
|
overridevirtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
inlineinherited |
Gets the current listener for this object.
|
inherited |
Retrieves the local axis-aligned bounding box for this object.
|
inherited |
See getLocalAabb and getWorldRadius.
|
inherited |
Retrieves the material this renderable object uses.
It may be null if it's using the HLMS. @See getDatablock
|
inlinevirtual |
Get the maximum number of chain elements per chain.
|
overridevirtual |
Returns the type name of this object.
Implements Ogre::MovableObject.
Reimplemented in Ogre::v1::RibbonTrail.
|
inlineinherited |
Returns the name of this object.
|
inlinevirtual |
Get the number of chain segments (this class can render multiple chains at once using the same material).
|
virtual |
Returns the number of chain elements.
|
inherited |
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BorderRenderable.
|
inlinevirtual |
Get the range of the texture coordinates generated across the width of the chain elements.
|
inlineinherited |
Returns the node to which this object is attached.
|
inlineinherited |
|
inlinevirtualinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::v1::BorderRenderable.
Referenced by Ogre::v1::BorderRenderable::getPolygonModeOverrideable().
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inlineinherited |
Returns the query flags relevant for this object.
|
inlineinherited |
Gets the distance at which batches are no longer rendered.
|
inlineinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
|
overridevirtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
|
inlineinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlineinherited |
|
inlineinherited |
Gets the distance at which batches are no longer casting shadows.
|
inlineinherited |
|
inlinevirtual |
Gets the direction in which texture coords specified on each element are deemed to run.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization)
|
inlinevirtualinherited |
Returns whether the world matrix is an identity matrix.
Reimplemented in Ogre::v1::BillboardSet.
|
inlinevirtualinherited |
Retrieves the custom user value associated with this object.
|
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.
|
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.
|
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.
|
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.
|
inlinevirtual |
Gets whether texture coordinate information should be included in the final buffers generated.
|
inlinevirtual |
Gets whether vertex colour information should be included in the final buffers generated.
|
inlineinherited |
|
inlineinherited |
Returns the visibility flags relevant for this object.
Reserved visibility flags are not returned.
|
inlineinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
inherited |
Gets the axis aligned box in world space.
|
inherited |
Gets the axis aligned box in world space.
|
inherited |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
|
inherited |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
|
overridevirtual |
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
|
inlineinherited |
|
inlinevirtualinherited |
@See InstancingTheadedCullingMethod,
|
inlineinherited |
Returns true if this object is attached to a Node.
|
inherited |
Checks whether this MovableObject is static. @See setStatic.
|
inherited |
Returns whether or not this object is supposed to be visible or not.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
|
overridevirtual |
Called just prior to the Renderable being rendered.
Reimplemented from Ogre::Renderable.
|
inlineinherited |
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 |
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
|
inlineinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
|
inlineinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
|
inlineinherited |
Sets whether or not this object will cast shadows.
|
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. |
|
virtualinherited |
Assigns a datablock (i.e. HLMS Material) to this renderable.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BillboardSet.
|
inherited |
Assigns a datablock (i.e.
HLMS material) based on its unique name.
|
inherited |
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.
|
inlinestaticinherited |
Set the default light mask for all future MovableObject instances.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
|
inlinestaticinherited |
Sets the default render queue sub group for all future Renderable instances.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
|
virtual |
Sets whether or not the buffers created for this object are suitable for dynamic alteration.
void Ogre::v1::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. |
|
inlineinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlineinherited |
Sets a listener for this object.
|
inherited |
Sets the local axis-aligned bounding box for this object.
|
virtualinherited |
Sets the given material. Overrides HLMS materials.
Reimplemented in Ogre::v1::SubEntity, Ogre::v1::BillboardSet, and Ogre::v1::SimpleRenderable.
Sets the name of the Material to be used. Prefer using HLMS @See setHlms.
|
virtual |
Set the maximum number of chain elements per chain.
Reimplemented in Ogre::v1::RibbonTrail.
|
inlineinherited |
Sets a custom name for this node.
Doesn't have to be unique
|
virtual |
Set the number of chain segments (this class can render multiple chains at once using the same material).
Reimplemented in Ogre::v1::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. |
|
inherited |
|
inlineinherited |
Sets the query flags for this object.
|
inlineinherited |
Sets the distance at which the object is no longer rendered.
dist | Distance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode. |
|
inlineinherited |
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). |
|
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, Ogre::Light, Ogre::InternalCubemapProbe, Ogre::v1::Entity, and Ogre::Decal.
|
inlineinherited |
Sets the render queue sub group.
subGroup | The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) @See RenderQueue |
|
inlineinherited |
Sets the distance at which the object is no longer casting shadows.
dist | Distance beyond which the object will not cast shadows (the default is FLT_MAX, which means objects are always casting shadows). Values equal or below zero will be ignored, and cause an assertion in debug mode. |
|
inherited |
Turns this Node into static or dynamic.
|
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. |
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
|
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.
|
inlineinherited |
Sets the visibility flags for this object.
|
inlineinherited |
Tells this object whether to be visible or not, if it has a renderable component.
|
staticinherited |
@See SceneManager::updateAllBounds
|
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 |
|
inherited |
Only valid when using low level materials.
|
inherited |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
Used for O(1) removals.
|
inherited |
Index in the vector holding this Rendrable reference in the HLMS datablock.
Used for O(1) removals.
|
inherited |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
Used for O(1) removals.
|
inherited |
|
inherited |
Control visibility at Renderable (e.g.
SubMesh) level
Note that if our MovableObject owner called MovableObject::setVisible( false ) we won't get rendered. Both must be true in order to render.