OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::SubItem Class Reference

Utility class which defines the sub-parts of an Item. More...

#include <OgreSubItem.h>

+ Inheritance diagram for Ogre::SubItem:

Public Member Functions

 ~SubItem () override
 Destructor. More...
 
void _setHlmsHashes (uint32 hash, uint32 casterHash) override
 Manually sets the hlms hashes. Don't call this directly. More...
 
void addPoseWeight (const Ogre::String &poseName, float w)
 
void addPoseWeight (size_t index, float w)
 
bool getCastsShadows () const override
 Method which reports whether this renderable would normally cast a shadow. More...
 
const LightListgetLights () const override
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
ItemgetParent () const
 Accessor to get parent Item. More...
 
float getPoseWeight (const Ogre::String &poseName) const
 
float getPoseWeight (size_t index) const
 
void getRenderOperation (v1::RenderOperation &op, bool casterPass) override
 Gets the render operation required to send this object to the frame buffer. More...
 
SubMeshgetSubMesh () const
 Accessor method to read mesh data. More...
 
void getWorldTransforms (Matrix4 *xform) const override
 Gets the world transform matrix / matrices for this renderable object. More...
 
void setPoseWeight (const Ogre::String &poseName, float w)
 
void setPoseWeight (size_t index, float w)
 
- Public Member Functions inherited from Ogre::RenderableAnimated
 RenderableAnimated ()
 
const IndexMapgetBlendIndexToBoneIndexMap () const
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. 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)
 
uint8 getCurrentMaterialLod () const
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const CustomParameterMapgetCustomParameters () const
 
HlmsDatablockgetDatablock () const
 
const StringgetDatablockOrMaterialName () 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 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
 
TexBufferPackedgetPoseTexBuffer () 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 bool getUseIdentityWorldMatrix () const
 Returns whether the world matrix is an identity matrix. More...
 
virtual OGRE_DEPRECATED const AnygetUserAny () const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
const VertexArrayObjectArraygetVaos (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 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)
 

Additional Inherited Members

- Public Types inherited from Ogre::RenderableAnimated
typedef FastArray< unsigned short > IndexMap
 
- Public Types inherited from Ogre::Renderable
typedef map< size_t, Vector4 >::type CustomParameterMap
 
- Static Public Member Functions inherited from Ogre::Renderable
static uint8 getDefaultRenderQueueSubGroup ()
 
static void setDefaultRenderQueueSubGroup (uint8 subGroup)
 Sets the default render queue sub group for all future Renderable instances. More...
 
- Public Attributes inherited from Ogre::Renderable
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...
 

Detailed Description

Utility class which defines the sub-parts of an Item.

Remarks
Just as meshes are split into submeshes, an Item is made up of potentially multiple SubMeshes. These are mainly here to provide the link between the Material which the SubItem uses (which may be the default Material for the SubMesh or may have been changed for this object) and the SubMesh data.
The SubItem also allows the application some flexibility in the material properties for this section of a particular instance of this Mesh, e.g. tinting the windows on a car model.
SubItem instances are never created manually. They are created at the same time as their parent Item by the SceneManager method createItem.

Constructor & Destructor Documentation

◆ ~SubItem()

Ogre::SubItem::~SubItem ( )
override

Destructor.

Member Function Documentation

◆ _setHlmsHashes()

void Ogre::SubItem::_setHlmsHashes ( uint32  hash,
uint32  casterHash 
)
overridevirtual

Manually sets the hlms hashes. Don't call this directly.

Reimplemented from Ogre::Renderable.

◆ addPoseWeight() [1/2]

void Ogre::SubItem::addPoseWeight ( const Ogre::String poseName,
float  w 
)

◆ addPoseWeight() [2/2]

void Ogre::Renderable::addPoseWeight

◆ getCastsShadows()

bool Ogre::SubItem::getCastsShadows ( ) const
overridevirtual

Method which reports whether this renderable would normally cast a shadow.

Remarks
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented from Ogre::Renderable.

◆ getLights()

const LightList& Ogre::SubItem::getLights ( ) const
overridevirtual

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

◆ getParent()

Item* Ogre::SubItem::getParent ( ) const
inline

Accessor to get parent Item.

◆ getPoseWeight() [1/2]

float Ogre::SubItem::getPoseWeight ( const Ogre::String poseName) const

◆ getPoseWeight() [2/2]

float Ogre::Renderable::getPoseWeight

◆ getRenderOperation()

void Ogre::SubItem::getRenderOperation ( v1::RenderOperation op,
bool  casterPass 
)
overridevirtual

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

◆ getSubMesh()

SubMesh* Ogre::SubItem::getSubMesh ( ) const

Accessor method to read mesh data.

◆ getWorldTransforms()

void Ogre::SubItem::getWorldTransforms ( Matrix4 xform) const
overridevirtual

Gets the world transform matrix / matrices for this renderable object.

Remarks
If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.
This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.
Note
Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.
See also
Matrix4::isAffine.

Implements Ogre::Renderable.

◆ setPoseWeight() [1/2]

void Ogre::SubItem::setPoseWeight ( const Ogre::String poseName,
float  w 
)

◆ setPoseWeight() [2/2]

void Ogre::Renderable::setPoseWeight

The documentation for this class was generated from the following file: