OGRE-Next
3.0.0
Object-Oriented Graphics Rendering Engine
|
Abstract class defining the interface all renderable objects must implement. More...
#include <OgreRenderable.h>
Public Types | |
typedef map< size_t, Vector4 >::type | CustomParameterMap |
Public Member Functions | |
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 | _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 | 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 |
virtual const LightList & | getLights () const =0 |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
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 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 |
virtual void | getRenderOperation (v1::RenderOperation &op, bool casterPass)=0 |
Gets the render operation required to send this object to the frame buffer. More... | |
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 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... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
virtual void | getWorldTransforms (Matrix4 *xform) const =0 |
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 | 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 | 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 | 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. 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) |
Static Public Member Functions | |
static uint8 | getDefaultRenderQueueSubGroup () |
static void | setDefaultRenderQueueSubGroup (uint8 subGroup) |
Sets the default render queue sub group for all future Renderable instances. More... | |
Public Attributes | |
uint8 | mCustomParameter |
uint32 | mHlmsGlobalIndex |
Index in the vector holding this Rendrable reference in the HLMS datablock. More... | |
bool | mRenderableVisible |
Control visibility at Renderable (e.g. More... | |
Abstract class defining the interface all renderable objects must implement.
typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap |
Ogre::Renderable::Renderable | ( | ) |
|
virtual |
Virtual destructor needed as class has virtual methods.
Manually sets the hlms hashes. Don't call this directly.
Reimplemented in Ogre::SubItem.
|
virtual |
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.
|
virtual |
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.
void Ogre::Renderable::addPoseWeight | ( | size_t | index, |
float | w | ||
) |
|
inlinevirtual |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::WireAabb, Ogre::SubItem, Ogre::v1::SubEntity, Ogre::Rectangle2D, and Ogre::ManualObject::ManualObjectSection.
|
inline |
|
inline |
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.
|
inline |
|
inline |
const String& Ogre::Renderable::getDatablockOrMaterialName | ( | ) | const |
|
inlinestatic |
|
inline |
|
inline |
|
pure virtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implemented in Ogre::WireAabb, Ogre::SubItem, Ogre::v1::SubEntity, Ogre::v1::SimpleRenderable, Ogre::Rectangle2D, Ogre::v1::Rectangle2D, Ogre::ManualObject::ManualObjectSection, Ogre::v1::ManualObject::ManualObjectSection, Ogre::Frustum, Ogre::v1::BillboardSet, Ogre::v1::BillboardChain, Ogre::v1::OverlayElement, and Ogre::v1::BorderRenderable.
MaterialPtr Ogre::Renderable::getMaterial | ( | ) | const |
Retrieves the material this renderable object uses.
It may be null if it's using the HLMS.
unsigned short Ogre::Renderable::getNumPoses | ( | ) | const |
|
inlinevirtual |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BorderRenderable.
|
inlinevirtual |
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().
bool Ogre::Renderable::getPoseHalfPrecision | ( | ) | const |
bool Ogre::Renderable::getPoseNormals | ( | ) | const |
TexBufferPacked* Ogre::Renderable::getPoseTexBuffer | ( | ) | const |
float Ogre::Renderable::getPoseWeight | ( | size_t | index | ) | const |
float* Ogre::Renderable::getPoseWeights | ( | ) | const |
|
pure virtual |
Gets the render operation required to send this object to the frame buffer.
Implemented in Ogre::WireAabb, Ogre::SubItem, Ogre::Rectangle2D, Ogre::ManualObject::ManualObjectSection, Ogre::Frustum, Ogre::v1::TextAreaOverlayElement, Ogre::v1::PanelOverlayElement, Ogre::v1::BorderRenderable, Ogre::v1::SubEntity, Ogre::v1::SimpleRenderable, Ogre::v1::Rectangle2D, Ogre::v1::ManualObject::ManualObjectSection, Ogre::v1::BillboardSet, and Ogre::v1::BillboardChain.
|
inline |
|
inline |
Returns whether or not to use an 'identity' projection.
|
inline |
Returns whether or not to use an 'identity' view.
|
inlinevirtual |
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)
|
inlinevirtual |
Returns whether the world matrix is an identity matrix.
Reimplemented in Ogre::v1::BillboardSet.
|
inlinevirtual |
Retrieves the custom user value associated with this object.
|
inline |
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.
|
inline |
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.
|
inline |
|
pure virtual |
Gets the world transform matrix / matrices for this renderable object.
Implemented in Ogre::WireAabb, Ogre::SubItem, Ogre::v1::SubEntity, Ogre::v1::SimpleRenderable, Ogre::Rectangle2D, Ogre::v1::Rectangle2D, Ogre::ManualObject::ManualObjectSection, Ogre::v1::ManualObject::ManualObjectSection, Ogre::Frustum, Ogre::v1::BillboardSet, Ogre::v1::OverlayElement, Ogre::v1::BorderRenderable, Ogre::Camera, and Ogre::v1::BillboardChain.
|
inline |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
|
inline |
|
inlinevirtual |
Called immediately after the Renderable has been rendered.
|
inlinevirtual |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::v1::BillboardChain.
|
inline |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
|
inline |
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. |
|
virtual |
Assigns a datablock (i.e. HLMS Material) to this renderable.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BillboardSet.
void Ogre::Renderable::setDatablock | ( | IdString | datablockName | ) |
Assigns a datablock (i.e.
HLMS material) based on its unique name.
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.
|
inlinestatic |
Sets the default render queue sub group for all future Renderable instances.
|
virtual |
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.
|
inlinevirtual |
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. |
void Ogre::Renderable::setPoseWeight | ( | size_t | index, |
float | w | ||
) |
|
inline |
Sets the render queue sub group.
subGroup | The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) |
|
inline |
Sets whether or not to use an 'identity' projection.
|
inline |
Sets whether or not to use an 'identity' view.
|
inlinevirtual |
Sets any kind of user value on this object.
uint8 Ogre::Renderable::mCustomParameter |
uint32 Ogre::Renderable::mHlmsGlobalIndex |
Index in the vector holding this Rendrable reference in the HLMS datablock.
Used for O(1) removals.
bool Ogre::Renderable::mRenderableVisible |
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.