Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Protected Attributes | List of all members
castor3d::MeshAnimationInstanceSubmesh Class Reference

#include <MeshAnimationInstanceSubmesh.hpp>

Inheritance diagram for castor3d::MeshAnimationInstanceSubmesh:
Inheritance graph
[legend]
Collaboration diagram for castor3d::MeshAnimationInstanceSubmesh:
Collaboration graph
[legend]

Public Member Functions

C3D_API MeshAnimationInstanceSubmesh (MeshAnimationInstance &animationInstance, MeshAnimationSubmesh &animationObject)
 Constructor. More...
 
virtual C3D_API ~MeshAnimationInstanceSubmesh ()=default
 Destructor. More...
 
C3D_API void update (float factor, SubmeshAnimationBuffer const &prv, SubmeshAnimationBuffer const &cur)
 Updates the object, given to animation buffers. More...
 
C3D_API Submesh const & getSubmesh () const
 The submesh. More...
 
float getCurrentFactor () const
 The current factor. More...
 
C3D_API MeshAnimationInstanceSubmesh (MeshAnimationInstanceSubmesh &&rhs)=default
 
C3D_API MeshAnimationInstanceSubmeshoperator= (MeshAnimationInstanceSubmesh &&rhs)=delete
 
C3D_API MeshAnimationInstanceSubmesh (MeshAnimationInstanceSubmesh const &rhs)=delete
 
C3D_API MeshAnimationInstanceSubmeshoperator= (MeshAnimationInstanceSubmesh const &rhs)=delete
 

Protected Attributes

MeshAnimationSubmeshm_animationObject
 
float m_currentFactor { 0.0f }
 
SubmeshAnimationBuffer const * m_cur { nullptr }
 

Constructor & Destructor Documentation

◆ MeshAnimationInstanceSubmesh() [1/3]

C3D_API castor3d::MeshAnimationInstanceSubmesh::MeshAnimationInstanceSubmesh ( MeshAnimationInstanceSubmesh &&  rhs)
default

name Copy / Move.

◆ MeshAnimationInstanceSubmesh() [2/3]

C3D_API castor3d::MeshAnimationInstanceSubmesh::MeshAnimationInstanceSubmesh ( MeshAnimationInstanceSubmesh const &  rhs)
delete

◆ MeshAnimationInstanceSubmesh() [3/3]

C3D_API castor3d::MeshAnimationInstanceSubmesh::MeshAnimationInstanceSubmesh ( MeshAnimationInstance animationInstance,
MeshAnimationSubmesh animationObject 
)

Constructor.

Parameters
[in]animationInstanceThe parent skeleton animation instance.
[in]animationObjectThe animation object.

◆ ~MeshAnimationInstanceSubmesh()

virtual C3D_API castor3d::MeshAnimationInstanceSubmesh::~MeshAnimationInstanceSubmesh ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getCurrentFactor()

float castor3d::MeshAnimationInstanceSubmesh::getCurrentFactor ( ) const
inline

The current factor.

References m_currentFactor.

◆ getSubmesh()

C3D_API Submesh const & castor3d::MeshAnimationInstanceSubmesh::getSubmesh ( ) const

The submesh.

◆ operator=() [1/2]

C3D_API MeshAnimationInstanceSubmesh & castor3d::MeshAnimationInstanceSubmesh::operator= ( MeshAnimationInstanceSubmesh &&  rhs)
delete

◆ operator=() [2/2]

C3D_API MeshAnimationInstanceSubmesh & castor3d::MeshAnimationInstanceSubmesh::operator= ( MeshAnimationInstanceSubmesh const &  rhs)
delete

◆ update()

C3D_API void castor3d::MeshAnimationInstanceSubmesh::update ( float  factor,
SubmeshAnimationBuffer const &  prv,
SubmeshAnimationBuffer const &  cur 
)

Updates the object, given to animation buffers.

Parameters
[in]factorThe percentage between prv and cur.
[in]prvThe previous animation buffer (factor 0).
[in]curThe current animation buffer (factor 1).

Member Data Documentation

◆ m_animationObject

MeshAnimationSubmesh& castor3d::MeshAnimationInstanceSubmesh::m_animationObject
protected

The animation object.

◆ m_cur

SubmeshAnimationBuffer const* castor3d::MeshAnimationInstanceSubmesh::m_cur { nullptr }
protected

The current animation buffer.

◆ m_currentFactor

float castor3d::MeshAnimationInstanceSubmesh::m_currentFactor { 0.0f }
protected

The time elapsed since the last keyframe.

Referenced by getCurrentFactor().


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