CYISceneNode::PropertyAnimation Class Reference

Detailed Description

Class representing a node property animation.

#include <scenetree/YiSceneNode.h>

Inheritance diagram for CYISceneNode::PropertyAnimation:

Public Member Functions
	PropertyAnimation (CYISceneNode *pNode, YI_NODE_PROPERTY_TYPE ePropType, float fFrom, float fTo, uint32_t nDurMs, CYITimeInterpolator *pTimeInterpolator, bool bDirtyLayout)
virtual	~PropertyAnimation ()
void	Reconfigure (float fFrom, float fTo, uint32_t nDurMs, CYITimeInterpolator *pTimeInterpolator, bool bDirtyLayout)
Public Member Functions inherited from CYIAnimation::Listener
virtual	~Listener ()
virtual void	OnAnimationBegin (CYIAnimation *pAnimation)

Public Attributes
std::shared_ptr< CYISceneNodeProxy >	m_pNodeProxy
YI_NODE_PROPERTY_TYPE	m_eType
CYIAnimation *	m_pAnimation
float	m_fFrom
float	m_fTo
bool	m_bDirtyLayout

Protected Member Functions
virtual void	OnAnimate (CYIAnimation *pAnim, float fDataPosition) override
virtual void	OnAnimationEnd (CYIAnimation *pAnim) override

Constructor & Destructor Documentation

CYISceneNode::PropertyAnimation::PropertyAnimation	(	CYISceneNode *	pNode,
		YI_NODE_PROPERTY_TYPE	ePropType,
		float	fFrom,
		float	fTo,
		uint32_t	nDurMs,
		CYITimeInterpolator *	pTimeInterpolator,
		bool	bDirtyLayout
	)

Constructor that takes the node to animate, the property to animate, the range to animate between, the duration of the animation, a listener, a time interpolator and a flag indicating if the layout should be dirtied as part of the animation.

virtual CYISceneNode::PropertyAnimation::~PropertyAnimation ( )

virtual

Member Function Documentation

virtual void CYISceneNode::PropertyAnimation::OnAnimate ( CYIAnimation *  pAnim, float  fDataPosition  )

overrideprotectedvirtual

Called each step of the animation with the updated data position.

Reimplemented from CYIAnimation::Listener.

virtual void CYISceneNode::PropertyAnimation::OnAnimationEnd ( CYIAnimation *  pAnim )

overrideprotectedvirtual

Called upon completion of the animation.

Reimplemented from CYIAnimation::Listener.

void CYISceneNode::PropertyAnimation::Reconfigure	(	float	fFrom,
		float	fTo,
		uint32_t	nDurMs,
		CYITimeInterpolator *	pTimeInterpolator,
		bool	bDirtyLayout
	)

Reconfigure this property animation with new values. It will be ready to be restarted after this.

Member Data Documentation

bool CYISceneNode::PropertyAnimation::m_bDirtyLayout

If true and the property affects layouts, the layout of the node will be dirtied.

YI_NODE_PROPERTY_TYPE CYISceneNode::PropertyAnimation::m_eType

The property type to be animated

float CYISceneNode::PropertyAnimation::m_fFrom

The initial value

float CYISceneNode::PropertyAnimation::m_fTo

The final value

CYIAnimation* CYISceneNode::PropertyAnimation::m_pAnimation

The animation driver

std::shared_ptr<CYISceneNodeProxy> CYISceneNode::PropertyAnimation::m_pNodeProxy

A proxy to the node whose property will be animated

---

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

• scenetree/YiSceneNode.h