makVrv::DtCameraShake Class Reference

Provides an algorithm for shaking the camera. More...

Inheritance diagram for makVrv::DtCameraShake:

Public Member Functions
	DtCameraShake (DtDe &de, DtObserver &obs, const std::string &cameraShakeType)
	CTOR. More...
virtual	~DtCameraShake ()
	DTOR. More...
const std::string &	type () const
	What type of camera shake is this (ex. "DtContinuousCameraShake") More...
void	enableCameraShake ()
	Enable camera shake. More...
void	disableCameraShake ()
	Disable camera shake. More...
bool	cameraShakeEnabled () const
	Is camera shake enabled? More...
void	setCameraShakeEnabled (bool enabled)
	Enable or disable the camera shake. More...
void	setCameraShakeIntensity (float intensity)
	Set the camera shake intensity. More...
float	cameraShakeIntensity ()
	Get the camera shake intensity. More...
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks. More...
virtual bool	needsUpdate (DtTime tNow)
	Determine if we need to call update this tick. More...
virtual const DtObserver &	observer ()
	Retrieve the observer using this shake effect. More...
Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
	Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...
virtual	~DtTickable ()
	Virtual DTOR. More...
virtual void	setIsThreadSafe (bool safe)
	Get/set whether this tickable can be updated in parallel with other tickables. More...
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
	Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update. More...
virtual unsigned int	updatePeriod () const
virtual bool	lodSystemEnabled () const
	is the update LOD system enabled, overridden by subclasses More...

Protected Attributes
DtDe &	myDe
DtObserver &	myObs
DtObserverModeManager &	myObserverModeManager
std::string	myType
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction. More...
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
	Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Provides an algorithm for shaking the camera.

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.vrf4-8-branch/include/vrvCore/DtCameraShake.h