A collection of billboards (faces which are always facing the given direction) with the same (default) dimensions, material and which are fairly close proximity to each other.
More...
|
| BillboardSet (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, unsigned int poolSize=20, bool externalDataSource=false, uint8 renderQueueId=110u) |
| Usual constructor - this is called by the SceneManager. More...
|
|
| ~BillboardSet () override |
|
virtual SortMode | _getSortMode () const |
| Gets the sort mode of this billboard set. More...
|
|
virtual void | _notifyBillboardResized () |
| Internal callback used by Billboards to notify their parent that they have been resized. More...
|
|
virtual void | _notifyBillboardRotated () |
| Internal callback used by Billboards to notify their parent that they have been rotated. More...
|
|
virtual void | _notifyCurrentCamera (const Camera *camera, const Camera *lodCamera) |
| Overridden from MovableObject. More...
|
|
void | _releaseManualHardwareResources () override |
| Notifies the movable object that hardware resources were lost. More...
|
|
void | _setNullDatablock () override |
| Sets the datablock to a null pointer. More...
|
|
virtual void | _sortBillboards () |
| Sort the billboard set. More...
|
|
virtual void | _updateBounds () |
| Update the bounds of the billboardset. More...
|
|
void | _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera) override |
| Overridden from MovableObject. More...
|
|
void | _updateRenderQueueImpl (RenderQueue *queue, Camera *camera, const Camera *lodCamera) |
| Internal version that does not call _notifyCurrentCamera (i.e. you've already done it) More...
|
|
void | beginBillboards (size_t numBillboards=0) |
| Begin injection of billboard data; applicable when constructing the BillboardSet for external data use. More...
|
|
virtual void | clear () |
| Empties this set of all billboards. More...
|
|
Billboard * | createBillboard (const Vector3 &position, const ColourValue &colour=ColourValue::White) |
| Creates a new billboard and adds it to this set. More...
|
|
Billboard * | createBillboard (Real x, Real y, Real z, const ColourValue &colour=ColourValue::White) |
| Creates a new billboard and adds it to this set. More...
|
|
void | endBillboards () |
| Finish defining billboards. More...
|
|
virtual bool | getAutoextend () const |
| Returns true if the billboard pool automatically extends. More...
|
|
bool | getAutoUpdate () const |
| Return the auto update state of this billboard set. More...
|
|
virtual Billboard * | getBillboard (unsigned int index) const |
| Returns a pointer to the billboard at the supplied index. More...
|
|
virtual BillboardOrigin | getBillboardOrigin () const |
| Gets the point which acts as the origin point for all billboards in this set. More...
|
|
virtual BillboardRotationType | getBillboardRotationType () const |
| Sets billboard rotation type. More...
|
|
bool | getBillboardsInWorldSpace () |
| Gets whether billboards are treated as being in world space. More...
|
|
virtual BillboardType | getBillboardType () const |
| Returns the billboard type in use. More...
|
|
virtual const Vector3 & | getCommonDirection () const |
| Gets the common direction for all billboards (BBT_ORIENTED_COMMON) More...
|
|
virtual const Vector3 & | getCommonUpVector () const |
| Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON) More...
|
|
virtual bool | getCullIndividually () const |
| Returns whether or not billboards in this are tested individually for culling. More...
|
|
virtual Real | getDefaultHeight () const |
| See setDefaultDimensions - this gets 1 component individually. More...
|
|
virtual Real | getDefaultWidth () const |
| See setDefaultDimensions - this gets 1 component individually. More...
|
|
const LightList & | getLights () const override |
| Gets a list of lights, ordered relative to how close they are to this renderable. More...
|
|
const String & | getMovableType () const override |
| Overridden from MovableObject. More...
|
|
virtual int | getNumBillboards () const |
| Returns the number of active billboards which currently make up this set. More...
|
|
virtual unsigned int | getPoolSize () const |
| Returns the current size of the billboard pool. More...
|
|
void | getRenderOperation (RenderOperation &op, bool casterPass) override |
| Overridden from MovableObject. More...
|
|
virtual bool | getSortingEnabled () const |
| Returns true if sorting of billboards is enabled based on their distance from the camera. More...
|
|
Real | getSquaredViewDepth (const Camera *cam) const |
| Overridden, see Renderable. More...
|
|
virtual Ogre::FloatRect const * | getTextureCoords (uint16 *oNumCoords) |
| getTextureCoords() returns the current texture coordinate rects in effect. More...
|
|
virtual bool | getUseAccurateFacing () const |
| Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More...
|
|
bool | getUseIdentityWorldMatrix () const override |
| Overriden from Renderable. More...
|
|
void | getWorldTransforms (Matrix4 *xform) const override |
| Overridden from MovableObject. More...
|
|
void | injectBillboard (const Billboard &bb, const Camera *camera) |
| Define a billboard. More...
|
|
virtual bool | isPointRenderingEnabled () const |
| Returns whether point rendering is enabled. More...
|
|
void | notifyBillboardDataChanged () |
| When billboard set is not auto updating its GPU buffer, the user is responsible to inform it about any billboard changes in order to reflect them at the rendering stage. More...
|
|
virtual void | removeBillboard (Billboard *pBill) |
| Removes a billboard from the set. More...
|
|
virtual void | removeBillboard (unsigned int index) |
| Removes the billboard at the supplied index. More...
|
|
virtual void | setAutoextend (bool autoextend) |
| Tells the set whether to allow automatic extension of the pool of billboards. More...
|
|
void | setAutoUpdate (bool autoUpdate) |
| Set the auto update state of this billboard set. More...
|
|
virtual void | setBillboardOrigin (BillboardOrigin origin) |
| Sets the point which acts as the origin point for all billboards in this set. More...
|
|
virtual void | setBillboardRotationType (BillboardRotationType rotationType) |
| Sets billboard rotation type. More...
|
|
virtual void | setBillboardsInWorldSpace (bool ws) |
| Sets whether billboards should be treated as being in world space. More...
|
|
virtual void | setBillboardType (BillboardType bbt) |
| Sets the type of billboard to render. More...
|
|
void | setBounds (const Aabb &aabb, Real radius) |
| Set the bounds of the BillboardSet. More...
|
|
virtual void | setCommonDirection (const Vector3 &vec) |
| Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPENDICULAR_COMMON. More...
|
|
virtual void | setCommonUpVector (const Vector3 &vec) |
| Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PERPENDICULAR_COMMON. More...
|
|
virtual void | setCullIndividually (bool cullIndividual) |
| Sets whether culling tests billboards in this individually as well as in a group. More...
|
|
void | setDatablock (HlmsDatablock *datablock) override |
| Assigns a datablock (i.e. HLMS Material) to this renderable. More...
|
|
virtual void | setDefaultDimensions (Real width, Real height) |
| Sets the default dimensions of the billboards in this set. More...
|
|
virtual void | setDefaultHeight (Real height) |
| See setDefaultDimensions - this sets 1 component individually. More...
|
|
virtual void | setDefaultWidth (Real width) |
| See setDefaultDimensions - this sets 1 component individually. More...
|
|
void | setMaterial (const MaterialPtr &material) override |
| Sets the given material. Overrides HLMS materials. More...
|
|
virtual void | setPointRenderingEnabled (bool enabled) |
| Set whether or not the BillboardSet will use point rendering rather than manually generated quads. More...
|
|
virtual void | setPoolSize (size_t size) |
| Adjusts the size of the pool of billboards available in this set. More...
|
|
virtual void | setSortingEnabled (bool sortenable) |
| Enables sorting for this BillboardSet. More...
|
|
virtual void | setTextureCoords (Ogre::FloatRect const *coords, uint16 numCoords) |
| BillboardSet can use custom texture coordinates for various billboards. More...
|
|
virtual void | setTextureStacksAndSlices (uchar stacks, uchar slices) |
| setTextureStacksAndSlices() will generate texture coordinate rects as if the texture for the billboard set contained 'stacks' rows of 'slices' images each, all equal size. More...
|
|
virtual void | setUseAccurateFacing (bool acc) |
| Sets whether or not billboards should use an 'accurate' facing model based on the vector from each billboard to the camera, rather than an optimised version using just the camera direction. More...
|
|
| MovableObject (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, uint8 renderQueueId) |
| Constructor. More...
|
|
| MovableObject (ObjectData *objectDataPtrs) |
| Don't use this constructor unless you know what you're doing. More...
|
|
virtual | ~MovableObject () |
| Virtual destructor - read Scott Meyers if you don't know why this is needed. 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 () |
|
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 | _restoreManualHardwareResources () |
| Notifies the movable object that hardware resources should be restored. More...
|
|
void | addQueryFlags (uint32 flags) |
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
|
|
void | addVisibilityFlags (uint32 flags) |
| As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
|
|
void | detachFromParent () |
| Detaches an object from a parent SceneNode if attached. More...
|
|
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...
|
|
unsigned char | getCurrentMeshLod () const |
|
uint32 | getLightMask () const |
| Get a bitwise mask which will filter the lights affecting this object. 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...
|
|
const String & | getName () const |
| Returns the name of this object. More...
|
|
Node * | getParentNode () const |
| Returns the node to which this object is attached. More...
|
|
SceneNode * | getParentSceneNode () 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...
|
|
uint8 | getRenderQueueGroup () const |
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
|
|
Real | getShadowRenderingDistance () const |
| Gets the distance at which batches are no longer casting shadows. More...
|
|
SkeletonInstance * | getSkeletonInstance () 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...
|
|
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...
|
|
virtual void | instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags) |
|
bool | isAttached () const |
| Returns true if this object is attached to a Node. More...
|
|
bool | isStatic () const |
| Checks whether this MovableObject is static. More...
|
|
bool | isVisible () const |
| Returns whether or not this object is supposed to be visible or not. More...
|
|
const LightList & | queryLights () const |
| Gets a list of lights, ordered relative to how close they are to this movable object. 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 | resetMeshLod () |
| Sets mCurrentMeshLod to 0. More...
|
|
void | setCastShadows (bool enabled) |
| Sets whether or not this object will cast shadows. 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...
|
|
void | setName (const String &name) |
| Sets a custom name for this node. More...
|
|
void | setQueryFlags (uint32 flags) |
| Sets the query flags for this object. More...
|
|
void | setRenderingDistance (Real dist) |
| Sets the distance at which the object is no longer rendered. More...
|
|
void | setRenderingMinPixelSize (Real pixelSize) |
| Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
|
|
virtual void | setRenderQueueGroup (uint8 queueID) |
| Sets the render queue group this entity will be rendered through. More...
|
|
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...
|
|
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...
|
|
| AnimableObject () |
|
virtual | ~AnimableObject () |
|
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
| Create a reference-counted AnimableValuePtr for the named value. More...
|
|
const StringVector & | getAnimableValueNames () const |
| Gets a list of animable value names for this object. More...
|
|
| IdObject (IdType id) |
| We don't call generateNewId() here, to prevent objects in the stack (i.e. More...
|
|
IdType | getId () const |
| Get the unique id of this object. More...
|
|
bool | operator() (const IdObject &left, const IdObject &right) |
|
bool | operator() (const IdObject *left, const IdObject *right) |
|
| Renderable () |
|
virtual | ~Renderable () |
| Virtual destructor needed as class has virtual methods. More...
|
|
virtual void | _setHlmsHashes (uint32 hash, uint32 casterHash) |
| Manually sets the hlms hashes. Don't call this directly. 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 | addPoseWeight (size_t index, float w) |
|
virtual bool | getCastsShadows () const |
| Method which reports whether this renderable would normally cast a shadow. More...
|
|
uint8 | getCurrentMaterialLod () 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 |
|
uint32 | getHlmsCasterHash () const |
|
uint32 | getHlmsHash () const |
|
MaterialPtr | getMaterial () const |
| Retrieves the material this renderable object uses. More...
|
|
unsigned short | getNumPoses () const |
|
virtual unsigned short | getNumWorldTransforms () const |
| Returns the number of world transform matrices this renderable requires. More...
|
|
virtual ParticleType::ParticleType | getParticleType () const |
| Used by ParticleSystemDef to indicate Hlms they want specific shader code. More...
|
|
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 |
|
uint8 | getRenderQueueSubGroup () const |
|
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 OGRE_DEPRECATED const Any & | getUserAny () 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...
|
|
const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
|
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 | 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...
|
|
void | removeCustomParameter (size_t index) |
| Removes a custom value which is associated with this Renderable at the given index. More...
|
|
void | resetMaterialLod () |
| Sets mCurrentMaterialLod to 0. 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...
|
|
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...
|
|
void | setMaterialName (const String &name, const String &groupName) |
| Sets the name of the Material to be used. Prefer using HLMS. 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 | setRenderQueueSubGroup (uint8 subGroup) |
| Sets the render queue sub group. 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) |
|