MyViewControl::MyLightScaleCommand Class Reference

MyLightScaleCommand is a custom VR-Vantage class that processes view control messages with the command type MyControlToolkit::Control_LightScale. More...

Inheritance diagram for MyViewControl::MyLightScaleCommand:

Public Member Functions
	MyLightScaleCommand ()
	CTOR.
virtual	~MyLightScaleCommand ()
	Virtual DTOR.
virtual void	execute (DtDe &de)
	Execute makes the call(s) to the VR-Vantage API to actually make the changes requested in the message.
virtual bool	diffuseLightScaleSet () const
	Methods for managing the diffuse light scale parameter.
virtual int	diffuseLightScale () const
	Get the diffuse light scale value; used by execute() if diffuseLightScaleSet() is true.
virtual void	setDiffuseLightScale (int scale)
	Set the diffuse light scale value.
virtual bool	ambientLightScaleSet () const
	Methods for managing the ambient light scale parameter.
virtual int	ambientLightScale () const
	Get the ambient light scale value; used by execute() if ambientLightScaleSet() is true.
virtual void	setAmbientLightScale (int scale)
	Set the ambient light scale value.
Public Member Functions inherited from makVrv::DtVrvCommand
	DtVrvCommand ()
virtual	~DtVrvCommand ()
virtual vrvControlToolkit::DtVrvControlTypeEnum	commandType ()

Protected Attributes
int	myDiffuseLightScale
	The diffuse light scale value as set by MyLightScaleCommandCreator::create (or 0 if unset)
int	myAmbientLightScale
	The ambient light scale value as set by MyLightScaleCommandCreator::create (or 0 if unset)
bool	myDiffuseLightScaleSet
	Flag to indicate if myDiffuseLightScale was set in MyLightScaleCommandCreator::create.
bool	myAmbientLightScaleSet
	Flag to indicate if myAmbientLightScale was set in MyLightScaleCommandCreator::create.
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Detailed Description

MyLightScaleCommand is a custom VR-Vantage class that processes view control messages with the command type MyControlToolkit::Control_LightScale.

Note that instances of this class are created and its methods called in the VR-Link connection thread, except for execute(), which is called in the Main (render) thread.

Constructor & Destructor Documentation

MyViewControl::MyLightScaleCommand::MyLightScaleCommand

(

)

CTOR.

virtual MyViewControl::MyLightScaleCommand::~MyLightScaleCommand ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual bool MyViewControl::MyLightScaleCommand::diffuseLightScaleSet ( ) const

virtual

Methods for managing the diffuse light scale parameter.

Should the diffuse light scale value in the message be used? Used by execute() to determine if it should change the diffuse light scale

virtual int MyViewControl::MyLightScaleCommand::diffuseLightScale ( ) const

virtual

Get the diffuse light scale value; used by execute() if diffuseLightScaleSet() is true.

virtual void MyViewControl::MyLightScaleCommand::setDiffuseLightScale ( int  scale )

virtual

Set the diffuse light scale value.

Used by MyLightScaleCommandCreator::create when processing the network message. If the message indicates that the diffuse light scale value should be used, then this is called. It has the side

virtual bool MyViewControl::MyLightScaleCommand::ambientLightScaleSet ( ) const

virtual

Methods for managing the ambient light scale parameter.

Should the ambient light scale value in the message be used? Used by execute() to determine if it should change the ambient light scale

virtual int MyViewControl::MyLightScaleCommand::ambientLightScale ( ) const

virtual

Get the ambient light scale value; used by execute() if ambientLightScaleSet() is true.

virtual void MyViewControl::MyLightScaleCommand::setAmbientLightScale ( int  scale )

virtual

Set the ambient light scale value.

Used by MyLightScaleCommandCreator::create when processing the network message. If the message indicates that the ambient light scale value should be used, then this is called. It has the side

virtual void MyViewControl::MyLightScaleCommand::execute ( DtDe &  de )

virtual

Execute makes the call(s) to the VR-Vantage API to actually make the changes requested in the message.

Since it is passed a de (Display Engine) reference, it has access to most of the VR-Vantage API

Implements makVrv::DtVrvCommand.

Member Data Documentation

int MyViewControl::MyLightScaleCommand::myDiffuseLightScale

protected

The diffuse light scale value as set by MyLightScaleCommandCreator::create (or 0 if unset)

int MyViewControl::MyLightScaleCommand::myAmbientLightScale

protected

The ambient light scale value as set by MyLightScaleCommandCreator::create (or 0 if unset)

bool MyViewControl::MyLightScaleCommand::myDiffuseLightScaleSet

protected

Flag to indicate if myDiffuseLightScale was set in MyLightScaleCommandCreator::create.

bool MyViewControl::MyLightScaleCommand::myAmbientLightScaleSet

protected

Flag to indicate if myAmbientLightScale was set in MyLightScaleCommandCreator::create.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/exampleViewControl/MyLightScaleCommand.h