Castor3D  ..
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Castor3D::BonedVertex Class Reference

Vertex with bones infos representation. More...

Public Member Functions

C3D_API BonedVertex (BufferElementGroup &p_group)
 Constructor. More...
 
C3D_API BonedVertex (BonedVertex const &p_source)
 Copy constructor. More...
 
C3D_API BonedVertexoperator= (BonedVertex const &p_source)
 Copy assignment operator. More...
 
virtual C3D_API ~BonedVertex ()
 Destructor. More...
 
C3D_API stVERTEX_BONE_DATA GetBones () const
 Retrieves the group bones data. More...
 
C3D_API void SetBones (stVERTEX_BONE_DATA *p_data)
 Sets the group bones datas. More...
 
C3D_API void SetBones (stVERTEX_BONE_DATA const &p_data)
 Sets the group bones datas. More...
 

Static Public Member Functions

static C3D_API stVERTEX_BONE_DATA GetBones (BufferElementGroupSPtr p_group)
 Retrieves the group bones data. More...
 
static C3D_API stVERTEX_BONE_DATA GetBones (BufferElementGroup const &p_group)
 Retrieves the group bones data. More...
 
static C3D_API void SetBones (BufferElementGroupSPtr p_group, stVERTEX_BONE_DATA *p_pData)
 Sets the group bones datas. More...
 
static C3D_API void SetBones (BufferElementGroupSPtr p_group, stVERTEX_BONE_DATA const &p_data)
 Sets the group bones datas. More...
 
static C3D_API void SetBones (BufferElementGroup &p_group, stVERTEX_BONE_DATA *p_data)
 Sets the group bones datas. More...
 
static C3D_API void SetBones (BufferElementGroup &p_group, stVERTEX_BONE_DATA const &p_data)
 Sets the group bones datas. More...
 
static const uint32_t GetOffsetIds ()
 Retrieves bones informations' buffer offset. More...
 
static const uint32_t GetSizeIds ()
 Retrieves bones informations binary size. More...
 
static const uint32_t GetOffsetWeights ()
 Retrieves bones informations' buffer offset. More...
 
static const uint32_t GetSizeWeights ()
 Retrieves bones informations binary size. More...
 

Static Public Attributes

static const uint32_t Stride = sm_uiOffsetWeights + sm_uiSizeWeights
 The vertex bones data size. More...
 

Detailed Description

Vertex with bones infos representation.

Author
Sylvain DOREMUS
Version
0.7.0
Date
27/06/2013
Remarks
Vertex Specialisation adding bone infos retrieval.

Constructor & Destructor Documentation

◆ BonedVertex() [1/2]

C3D_API Castor3D::BonedVertex::BonedVertex ( BufferElementGroup p_group)

Constructor.

Parameters
[in]p_groupThe wrapped group

◆ BonedVertex() [2/2]

C3D_API Castor3D::BonedVertex::BonedVertex ( BonedVertex const &  p_source)

Copy constructor.

Parameters
[in]p_sourceThe source object

◆ ~BonedVertex()

virtual C3D_API Castor3D::BonedVertex::~BonedVertex ( )
virtual

Destructor.

Member Function Documentation

◆ GetBones() [1/3]

C3D_API stVERTEX_BONE_DATA Castor3D::BonedVertex::GetBones ( ) const

Retrieves the group bones data.

Returns
The value

◆ GetBones() [2/3]

static C3D_API stVERTEX_BONE_DATA Castor3D::BonedVertex::GetBones ( BufferElementGroupSPtr  p_group)
static

Retrieves the group bones data.

Parameters
[in]p_groupThe group
Returns
The value

◆ GetBones() [3/3]

static C3D_API stVERTEX_BONE_DATA Castor3D::BonedVertex::GetBones ( BufferElementGroup const &  p_group)
static

Retrieves the group bones data.

Parameters
[in]p_groupThe group
Returns
The value

◆ GetOffsetIds()

static const uint32_t Castor3D::BonedVertex::GetOffsetIds ( )
inlinestatic

Retrieves bones informations' buffer offset.

Returns
The value

◆ GetOffsetWeights()

static const uint32_t Castor3D::BonedVertex::GetOffsetWeights ( )
inlinestatic

Retrieves bones informations' buffer offset.

Returns
The value

◆ GetSizeIds()

static const uint32_t Castor3D::BonedVertex::GetSizeIds ( )
inlinestatic

Retrieves bones informations binary size.

Returns
The value

◆ GetSizeWeights()

static const uint32_t Castor3D::BonedVertex::GetSizeWeights ( )
inlinestatic

Retrieves bones informations binary size.

Returns
The value

◆ operator=()

C3D_API BonedVertex& Castor3D::BonedVertex::operator= ( BonedVertex const &  p_source)

Copy assignment operator.

Parameters
[in]p_sourceThe source object
Returns
A reference to this object

◆ SetBones() [1/6]

C3D_API void Castor3D::BonedVertex::SetBones ( stVERTEX_BONE_DATA p_data)

Sets the group bones datas.

Parameters
[in]p_dataThe new value

◆ SetBones() [2/6]

C3D_API void Castor3D::BonedVertex::SetBones ( stVERTEX_BONE_DATA const &  p_data)

Sets the group bones datas.

Parameters
[in]p_dataThe new value

◆ SetBones() [3/6]

static C3D_API void Castor3D::BonedVertex::SetBones ( BufferElementGroupSPtr  p_group,
stVERTEX_BONE_DATA p_pData 
)
static

Sets the group bones datas.

Parameters
[out]p_groupThe group
[in]p_pDataThe new value

◆ SetBones() [4/6]

static C3D_API void Castor3D::BonedVertex::SetBones ( BufferElementGroupSPtr  p_group,
stVERTEX_BONE_DATA const &  p_data 
)
static

Sets the group bones datas.

Parameters
[out]p_groupThe group
[in]p_dataThe new value

◆ SetBones() [5/6]

static C3D_API void Castor3D::BonedVertex::SetBones ( BufferElementGroup p_group,
stVERTEX_BONE_DATA p_data 
)
static

Sets the group bones datas.

Parameters
[out]p_groupThe group
[in]p_dataThe new value

◆ SetBones() [6/6]

static C3D_API void Castor3D::BonedVertex::SetBones ( BufferElementGroup p_group,
stVERTEX_BONE_DATA const &  p_data 
)
static

Sets the group bones datas.

Parameters
[out]p_groupThe group
[in]p_dataThe new value

Member Data Documentation

◆ Stride

const uint32_t Castor3D::BonedVertex::Stride = sm_uiOffsetWeights + sm_uiSizeWeights
static

The vertex bones data size.


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