makVrv::DtCameraShake Class Reference

Provides an algorithm for shaking the camera.

Inheritance diagram for makVrv::DtCameraShake:

Public Member Functions
	DtCameraShake (DtDe &de, DtObserver &obs, const std::string &cameraShakeType)
virtual	~DtCameraShake ()
const std::string &	type () const
void	enableCameraShake ()
void	disableCameraShake ()
bool	cameraShakeEnabled () const
void	setCameraShakeEnabled (bool enabled)
void	setCameraShakeIntensity (float intensity)
float	cameraShakeIntensity ()
virtual void	update (DtTime tNow)
virtual bool	needsUpdate (DtTime tNow)
virtual const DtObserver &	observer ()
Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
virtual	~DtTickable ()
virtual void	setTickableEnabled (bool enabled)
virtual void	setIsThreadSafe (bool safe)
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
virtual unsigned int	updatePeriod () const
virtual bool	adaptiveTickLodEnabled () const

Protected Attributes
DtDe &	myDe
DtObserver &	myObs
DtObserverModeManager &	myObserverModeManager
std::string	myType
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
unsigned int	myTickableIndex
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	DtTickable ()=delete
virtual void	slot_managerAboutToBeDeleted ()

Constructor & Destructor Documentation

makVrv::DtCameraShake::DtCameraShake	(	DtDe &	de,
		DtObserver &	obs,
		const std::string &	cameraShakeType
	)

CTOR.

virtual makVrv::DtCameraShake::~DtCameraShake ( )

virtual

DTOR.

Member Function Documentation

const std::string& makVrv::DtCameraShake::type

(

)

const

What type of camera shake is this (ex. "DtContinuousCameraShake")

void makVrv::DtCameraShake::enableCameraShake

(

)

Enable camera shake.

void makVrv::DtCameraShake::disableCameraShake

(

)

Disable camera shake.

bool makVrv::DtCameraShake::cameraShakeEnabled

(

)

const

Is camera shake enabled?

void makVrv::DtCameraShake::setCameraShakeEnabled

(

bool

enabled

)

Enable or disable the camera shake.

void makVrv::DtCameraShake::setCameraShakeIntensity

(

float

intensity

)

Set the camera shake intensity.

float makVrv::DtCameraShake::cameraShakeIntensity

(

)

Get the camera shake intensity.

virtual void makVrv::DtCameraShake::update ( DtTime  tNow )

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Implements makVrv::DtTickable.

Reimplemented in makVrv::DtContinuousCameraShake.

virtual bool makVrv::DtCameraShake::needsUpdate ( DtTime  tNow )

virtual

Determine if we need to call update this tick.

Reimplemented from makVrv::DtTickable.

virtual const DtObserver& makVrv::DtCameraShake::observer ( )

virtual

Retrieve the observer using this shake effect.

Member Data Documentation

DtDe& makVrv::DtCameraShake::myDe

protected

DtObserver& makVrv::DtCameraShake::myObs

protected

DtObserverModeManager& makVrv::DtCameraShake::myObserverModeManager

protected

std::string makVrv::DtCameraShake::myType

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtCameraShake.h