makVrv::DtContinuousCameraShake Class Reference

Shake for a continuous process like a UAV (default on DtObserver) More...

Inheritance diagram for makVrv::DtContinuousCameraShake:

Public Types
enum	CameraAxis { Yaw, Pitch, Roll }
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...

Public Member Functions
	DtContinuousCameraShake (DtDe &de, DtObserver &obs, const std::string &cameraShakeType)
virtual	~DtContinuousCameraShake ()
	DTOR. More...
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks. More...
virtual void	setCameraShakeDeg (CameraAxis axis, double deg)
	Set the camera shake maximum rotation degree components. More...
virtual void	setCameraShakeSpeed (CameraAxis axis, double rate)
	Set the speed of the camera shake. More...
virtual void	setCameraShakePhase (CameraAxis axis, double phase)
	Set the phase offset of the camera shake along the sine wave. More...
virtual void	setCameraShakeNoiseScale (CameraAxis axis, double noise)
	Set the magnitude of noise added into each axis. More...
DtVector &	cameraShakeDeg ()
	Get max degree allowed for camera shake (yaw, pitch, roll) More...
DtVector &	cameraShakeSpeed ()
	Get camera shake speed (yaw, pitch, roll) More...
DtVector &	cameraShakePhase ()
	Get camera shake phase for sine waves (yaw, pitch, roll) More...
DtVector &	cameraShakeNoiseScale ()
	Get camera shake added noise (on yaw, pitch, roll) More...
Public Member Functions inherited from makVrv::DtCameraShake
	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 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
DtVector	myShakeDeg
DtVector	myShakeSpeed
DtVector	myShakePhaseDeg
DtVector	myShakeNoiseScale
DtQuat	myNoRotQuat
Protected Attributes inherited from makVrv::DtCameraShake
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
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Shake for a continuous process like a UAV (default on DtObserver)

Member Enumeration Documentation

enum makVrv::DtContinuousCameraShake::CameraAxis

Enumerator
Yaw
Pitch
Roll

Constructor & Destructor Documentation

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

virtual makVrv::DtContinuousCameraShake::~DtContinuousCameraShake ( )

virtual

DTOR.

Member Function Documentation

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

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Reimplemented from makVrv::DtCameraShake.

virtual void makVrv::DtContinuousCameraShake::setCameraShakeDeg ( CameraAxis  axis, double  deg  )

virtual

Set the camera shake maximum rotation degree components.

virtual void makVrv::DtContinuousCameraShake::setCameraShakeSpeed ( CameraAxis  axis, double  rate  )

virtual

Set the speed of the camera shake.

virtual void makVrv::DtContinuousCameraShake::setCameraShakePhase ( CameraAxis  axis, double  phase  )

virtual

Set the phase offset of the camera shake along the sine wave.

virtual void makVrv::DtContinuousCameraShake::setCameraShakeNoiseScale ( CameraAxis  axis, double  noise  )

virtual

Set the magnitude of noise added into each axis.

DtVector& makVrv::DtContinuousCameraShake::cameraShakeDeg

(

)

Get max degree allowed for camera shake (yaw, pitch, roll)

DtVector& makVrv::DtContinuousCameraShake::cameraShakeSpeed

(

)

Get camera shake speed (yaw, pitch, roll)

DtVector& makVrv::DtContinuousCameraShake::cameraShakePhase

(

)

Get camera shake phase for sine waves (yaw, pitch, roll)

DtVector& makVrv::DtContinuousCameraShake::cameraShakeNoiseScale

(

)

Get camera shake added noise (on yaw, pitch, roll)

Member Data Documentation

DtVector makVrv::DtContinuousCameraShake::myShakeDeg

protected

DtVector makVrv::DtContinuousCameraShake::myShakeSpeed

protected

DtVector makVrv::DtContinuousCameraShake::myShakePhaseDeg

protected

DtVector makVrv::DtContinuousCameraShake::myShakeNoiseScale

protected

DtQuat makVrv::DtContinuousCameraShake::myNoRotQuat

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtContinuousCameraShake.h