#include <CinemaPath.h>

Inheritance diagram for CCinemaPath:

[legend]

Collaboration diagram for CCinemaPath:

[legend]

Public Member Functions
	CCinemaPath ()

	CCinemaPath (const CCinemaData &data, const TNSpline &spline, const TNSpline &targetSpline)

void	MoveToPointAt (float t, float nodet, const CVector3D &startRotation, CCamera *camera) const

float	EaseIn (float t) const

float	EaseOut (float t) const

float	EaseInOut (float t) const

float	EaseOutIn (float t) const

float	EaseDefault (float t) const

float	EaseGrowth (float t) const

float	EaseExpo (float t) const

float	EaseCircle (float t) const

float	EaseSine (float t) const

const CCinemaData *	GetData () const

CVector3D	GetNodePosition (const int index) const

fixed	GetNodeDuration (const int index) const

fixed	GetDuration () const

float	GetNodeFraction () const

float	GetElapsedTime () const

const CStrW &	GetName () const

void	SetTimescale (fixed scale)

bool	Play (const float deltaRealTime, CCamera *camera)
	Returns false if finished. More...

bool	Validate ()
	Validate the path. More...

bool	Empty () const
	Returns true if path doesn't contain nodes. More...

void	Reset ()
	Resets the path state. More...

fixed	GetTimescale () const

const TNSpline &	GetTargetSpline () const

Public Member Functions inherited from TNSpline
virtual	~TNSpline ()

void	AddNode (const CFixedVector3D &pos, const CFixedVector3D &rotation, fixed timePeriod)

void	InsertNode (const int index, const CFixedVector3D &pos, const CFixedVector3D &rotation, fixed timePeriod)

void	RemoveNode (const int index)

void	UpdateNodePos (const int index, const CFixedVector3D &pos)

void	UpdateNodeTime (const int index, fixed time)

void	BuildSpline ()

void	Smooth ()

void	Constrain ()

Public Member Functions inherited from SNSpline
virtual	~SNSpline ()

void	BuildSpline ()

void	Smooth ()

Public Member Functions inherited from RNSpline
	RNSpline ()

virtual	~RNSpline ()

void	AddNode (const CFixedVector3D &pos)

void	BuildSpline ()

CVector3D	GetPosition (float time) const

CVector3D	GetRotation (float time) const

const std::vector< SplineData > &	GetAllNodes () const

Public Attributes
float(CCinemaPath::*	DistStylePtr )(float ratio) const

float(CCinemaPath::*	DistModePtr )(float ratio) const

float	m_TimeElapsed

float	m_PreviousNodeTime

size_t	m_CurrentNode

CVector3D	m_PreviousRotation

Public Attributes inherited from RNSpline
fixed	MaxDistance

int	NodeCount

Private Attributes
TNSpline	m_TargetSpline

Private Attributes inherited from CCinemaData
CStrW	m_Name

CStrW	m_Orientation

CStrW	m_Mode

CStrW	m_Style

bool	m_LookAtTarget

fixed	m_Timescale

float	m_GrowthCount

float	m_Growth

float	m_Switch

Additional Inherited Members
Protected Member Functions inherited from RNSpline
CVector3D	GetStartVelocity (int index)

CVector3D	GetEndVelocity (int index)

Protected Attributes inherited from RNSpline
std::vector< SplineData >	Node

Private Member Functions inherited from CCinemaData
	CCinemaData ()

virtual	~CCinemaData ()

const CCinemaData *	GetData () const

Constructor & Destructor Documentation

◆ CCinemaPath() [1/2]

CCinemaPath::CCinemaPath ( )

inline

◆ CCinemaPath() [2/2]

CCinemaPath::CCinemaPath	(	const CCinemaData &	data,
		const TNSpline &	spline,
		const TNSpline &	targetSpline
	)

Member Function Documentation

◆ EaseCircle()

float CCinemaPath::EaseCircle ( float t ) const

◆ EaseDefault()

float CCinemaPath::EaseDefault ( float t ) const

◆ EaseExpo()

float CCinemaPath::EaseExpo ( float t ) const

◆ EaseGrowth()

float CCinemaPath::EaseGrowth ( float t ) const

◆ EaseIn()

float CCinemaPath::EaseIn ( float t ) const

◆ EaseInOut()

float CCinemaPath::EaseInOut ( float t ) const

◆ EaseOut()

float CCinemaPath::EaseOut ( float t ) const

◆ EaseOutIn()

float CCinemaPath::EaseOutIn ( float t ) const

◆ EaseSine()

float CCinemaPath::EaseSine ( float t ) const

◆ Empty()

bool CCinemaPath::Empty ( ) const

Returns true if path doesn't contain nodes.

◆ GetData()

const CCinemaData * CCinemaPath::GetData ( ) const

◆ GetDuration()

fixed CCinemaPath::GetDuration ( ) const

◆ GetElapsedTime()

float CCinemaPath::GetElapsedTime ( ) const

◆ GetName()

const CStrW & CCinemaPath::GetName ( ) const

◆ GetNodeDuration()

fixed CCinemaPath::GetNodeDuration ( const int index ) const

◆ GetNodeFraction()

float CCinemaPath::GetNodeFraction ( ) const

◆ GetNodePosition()

CVector3D CCinemaPath::GetNodePosition ( const int index ) const

◆ GetTargetSpline()

const TNSpline & CCinemaPath::GetTargetSpline ( ) const

◆ GetTimescale()

fixed CCinemaPath::GetTimescale ( ) const

◆ MoveToPointAt()

void CCinemaPath::MoveToPointAt	(	float	t,
		float	nodet,
		const CVector3D &	startRotation,
		CCamera *	camera
	)		const

◆ Play()

bool CCinemaPath::Play	(	const float	deltaRealTime,
		CCamera *	camera
	)

Returns false if finished.

Parameters

deltaRealTime	Elapsed real time since the last frame.
camera	An affected camera

◆ Reset()

void CCinemaPath::Reset ( )

Resets the path state.

◆ SetTimescale()

void CCinemaPath::SetTimescale ( fixed scale )

◆ Validate()

bool CCinemaPath::Validate ( )

Validate the path.

Returns: true if the path is valid

Member Data Documentation

◆ DistModePtr

float(CCinemaPath::* CCinemaPath::DistModePtr) (float ratio) const

◆ DistStylePtr

float(CCinemaPath::* CCinemaPath::DistStylePtr) (float ratio) const

◆ m_CurrentNode

size_t CCinemaPath::m_CurrentNode

◆ m_PreviousNodeTime

float CCinemaPath::m_PreviousNodeTime

◆ m_PreviousRotation

CVector3D CCinemaPath::m_PreviousRotation

◆ m_TargetSpline

TNSpline CCinemaPath::m_TargetSpline

private

◆ m_TimeElapsed

float CCinemaPath::m_TimeElapsed

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

/home/docker/jenkins/workspace/technical-docs/source/simulation2/helpers/CinemaPath.h
/home/docker/jenkins/workspace/technical-docs/source/simulation2/helpers/CinemaPath.cpp

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members