Developer Documentation
BaseSkin Class Referenceabstract

Abstract base class for the skin template, wrapping all template versions of the skin. More...

#include <Type-Skeleton/ObjectTypes/Skeleton/BaseSkin.hh>

Inheritance diagram for BaseSkin:
PerObjectData SkinT< MeshT >

Classes

struct  DefaultPose
 Holds the skins default pose. More...
 

Public Member Functions

Skinning

These methods are related to using a mesh as skin with this skeleton.

virtual void attachSkin ()=0
 
virtual void deformSkin ()=0
 
virtual void deformSkin (const AnimationHandle &_hAni, Blending::Method _method=Blending::M_LBS)=0
 
virtual void releaseSkin ()=0
 
- Public Member Functions inherited from PerObjectData
 PerObjectData ()
 You have to provide your own constructor for your object. More...
 
virtual PerObjectDatacopyPerObjectData ()
 Copy Function. More...
 

Properties

These structures store mesh properties used to make the mesh a skin.

typedef std::map< unsigned int, double > SkinWeights
 Stores the joint weights per vertex. More...
 
 BaseSkin (int _skeletonId)
 Stores the joint weights per vertex. More...
 
 ~BaseSkin ()
 Stores the joint weights per vertex. More...
 

Information about the attached skeleton

int skeleton_
 Holds the associated skeleton. More...
 
int skeletonId ()
 Holds the associated skeleton. More...
 

Detailed Description

Abstract base class for the skin template, wrapping all template versions of the skin.

Definition at line 62 of file BaseSkin.hh.

Member Typedef Documentation

◆ SkinWeights

typedef std::map<unsigned int, double> BaseSkin::SkinWeights

Stores the joint weights per vertex.

In general every joint can influence every vertex. In practice only a small number of joints manipulate a vertex. Therefore they are stored in a map using the joint identifier as key. The weights for one vertex are supposed to sum to one.

Definition at line 94 of file BaseSkin.hh.

Constructor & Destructor Documentation

◆ BaseSkin()

BaseSkin::BaseSkin ( int  _skeletonId)
inline

Stores the joint weights per vertex.

In general every joint can influence every vertex. In practice only a small number of joints manipulate a vertex. Therefore they are stored in a map using the joint identifier as key. The weights for one vertex are supposed to sum to one.

Definition at line 100 of file BaseSkin.hh.

◆ ~BaseSkin()

BaseSkin::~BaseSkin ( )
inline

Stores the joint weights per vertex.

In general every joint can influence every vertex. In practice only a small number of joints manipulate a vertex. Therefore they are stored in a map using the joint identifier as key. The weights for one vertex are supposed to sum to one.

Definition at line 104 of file BaseSkin.hh.

Member Function Documentation

◆ attachSkin()

virtual void BaseSkin::attachSkin ( )
pure virtual

Implemented in SkinT< MeshT >.

◆ deformSkin() [1/2]

virtual void BaseSkin::deformSkin ( )
pure virtual

Implemented in SkinT< MeshT >.

◆ deformSkin() [2/2]

virtual void BaseSkin::deformSkin ( const AnimationHandle _hAni,
Blending::Method  _method = Blending::M_LBS 
)
pure virtual

Implemented in SkinT< MeshT >.

◆ releaseSkin()

virtual void BaseSkin::releaseSkin ( )
pure virtual

Implemented in SkinT< MeshT >.

◆ skeletonId()

int BaseSkin::skeletonId ( )
inline

Holds the associated skeleton.

Definition at line 122 of file BaseSkin.hh.

Member Data Documentation

◆ skeleton_

int BaseSkin::skeleton_
private

Holds the associated skeleton.

Definition at line 128 of file BaseSkin.hh.


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