OGRE  13.3
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::HardwareSkinning Class Reference

Implement a sub render state which performs hardware skinning. More...

#include <OgreShaderExHardwareSkinning.h>

+ Inheritance diagram for Ogre::RTShader::HardwareSkinning:

Classes

struct  SkinningData
 

Public Member Functions

 HardwareSkinning ()
 Class default constructor. More...
 
void _setCreator (const HardwareSkinningFactory *pCreator)
 Set the factory which created this sub render state. More...
 
virtual void copyFrom (const SubRenderState &rhs)
 
ushort getBoneCount ()
 Returns the number of bones in the model assigned to the material. More...
 
virtual int getExecutionOrder () const
 
SkinningType getSkinningType ()
 Returns the current skinning type in use. More...
 
virtual const StringgetType () const
 
ushort getWeightCount ()
 Returns the number of weights/bones affecting a vertex. More...
 
bool hasCorrectAntipodalityHandling ()
 Only applicable for dual quaternion skinning. More...
 
bool hasScalingShearingSupport ()
 Only applicable for dual quaternion skinning. More...
 
virtual bool preAddToRenderState (const RenderState *renderState, Pass *srcPass, Pass *dstPass)
 
void setHardwareSkinningParam (ushort boneCount, ushort weightCount, SkinningType skinningType=ST_LINEAR, bool correctAntipodalityHandling=false, bool scalingShearingSupport=false)
 Set the hardware skinning parameters. More...
 
- Public Member Functions inherited from Ogre::RTShader::SubRenderState
 SubRenderState ()
 Class default constructor. More...
 
virtual ~SubRenderState ()
 Class destructor. More...
 
virtual bool createCpuSubPrograms (ProgramSet *programSet)
 Create sub programs that represents this sub render state as part of a program set. More...
 
SubRenderStateAccessorPtr getAccessor ()
 Return the accessor object to this sub render state. More...
 
SubRenderStateAccessorPtr getAccessor () const
 Return the accessor object to this sub render state. More...
 
SubRenderStateoperator= (const SubRenderState &rhs)
 Operator = declaration. More...
 
virtual bool setParameter (const String &name, const String &value)
 generic set method for parameters that connot be derived in preAddToRenderState More...
 
virtual void updateGpuProgramsParams (Renderable *rend, const Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
 Update GPU programs parameters before a rendering operation occurs. More...
 

Static Public Attributes

static String Type
 

Detailed Description

Implement a sub render state which performs hardware skinning.

Meaning, this sub render states adds calculations which multiply the points and normals by their assigned bone matricies.

Constructor & Destructor Documentation

◆ HardwareSkinning()

Ogre::RTShader::HardwareSkinning::HardwareSkinning ( )

Class default constructor.

Member Function Documentation

◆ getType()

virtual const String& Ogre::RTShader::HardwareSkinning::getType ( ) const
virtual

◆ getExecutionOrder()

virtual int Ogre::RTShader::HardwareSkinning::getExecutionOrder ( ) const
virtual

◆ copyFrom()

virtual void Ogre::RTShader::HardwareSkinning::copyFrom ( const SubRenderState rhs)
virtual

◆ setHardwareSkinningParam()

void Ogre::RTShader::HardwareSkinning::setHardwareSkinningParam ( ushort  boneCount,
ushort  weightCount,
SkinningType  skinningType = ST_LINEAR,
bool  correctAntipodalityHandling = false,
bool  scalingShearingSupport = false 
)

Set the hardware skinning parameters.

Parameters
boneCountThe maximum number of bones in the model this material is assigned to. Note that this parameter can be higher but not lower than the actual number of bones.
weightCountThe maximum number of weights/bones affecting a vertex.
skinningTypeThe type of skinning desired.
correctAntipodalityHandlingIf correct antipodality handling should be utilized (Only applicable for dual quaternion skinning).
scalingShearingSupportIf scaling and shearing support should be enabled (Only applicable for dual quaternion skinning).

◆ getBoneCount()

ushort Ogre::RTShader::HardwareSkinning::getBoneCount ( )

Returns the number of bones in the model assigned to the material.

See also
setHardwareSkinningParam()

◆ getWeightCount()

ushort Ogre::RTShader::HardwareSkinning::getWeightCount ( )

Returns the number of weights/bones affecting a vertex.

See also
setHardwareSkinningParam()

◆ getSkinningType()

SkinningType Ogre::RTShader::HardwareSkinning::getSkinningType ( )

Returns the current skinning type in use.

See also
setHardwareSkinningParam()

◆ hasCorrectAntipodalityHandling()

bool Ogre::RTShader::HardwareSkinning::hasCorrectAntipodalityHandling ( )

Only applicable for dual quaternion skinning.

See also
setHardwareSkinningParam()

◆ hasScalingShearingSupport()

bool Ogre::RTShader::HardwareSkinning::hasScalingShearingSupport ( )

Only applicable for dual quaternion skinning.

See also
setHardwareSkinningParam()

◆ preAddToRenderState()

virtual bool Ogre::RTShader::HardwareSkinning::preAddToRenderState ( const RenderState renderState,
Pass srcPass,
Pass dstPass 
)
virtual

◆ _setCreator()

void Ogre::RTShader::HardwareSkinning::_setCreator ( const HardwareSkinningFactory pCreator)
inline

Set the factory which created this sub render state.

Member Data Documentation

◆ Type

String Ogre::RTShader::HardwareSkinning::Type
static

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